BxBaseSearchExtended Class Reference

Inheritance diagram for BxBaseSearchExtended:

Public Member Functions
	__construct ($aObject, $oTemplate=null)
	getForm ($aParams=array())
	getResults ($aParams=array())
	getResultsAPI ($aData, $iPerPage, $iStart, $aParamsSearch='')
	getSorting ($aParams=[])
	getSortingAPI ($aData)
Public Member Functions inherited from BxDolSearchExtended
	isEnabled ()
	clean ()
	cleanFields ()
	cleanSortableFields ()
	reset ()
	resetFields ()
	resetSortableFields ()

Protected Member Functions
&	prepareForm ($aParams=array())
Protected Member Functions inherited from BxDolSearchExtended
	__construct ($aObject)

Protected Attributes
	$_sFormClassName
	$_sFormClassPath
	$_oForm
	$_oTemplate
	$_bJsMode
	$_iAgeMin
	$_iAgeMax
Protected Attributes inherited from BxDolSearchExtended
	$_bIsApi
	$_oDb
	$_sObject
	$_aObject
	$_bFilterMode

Additional Inherited Members
Static Public Member Functions inherited from BxDolSearchExtended
static	getObjectInstance ($sObject, $oTemplate=false)
static	actionGetAuthors ()
static	actionGetHashtags ()
static	actionGetMention ()
static	getMention ($sSymbol)
static	encodeConditions ($aConditions)
static	decodeConditions ($sConditions)
Static Public Member Functions inherited from iBxDolFactoryObject
static	getObjectInstance ($sObject)
Static Public Attributes inherited from BxDolSearchExtended
static	$SEARCHABLE_TYPES
static	$TYPE_TO_TYPE_SEARCH
static	$TYPE_TO_OPERATOR

Detailed Description

Extended Search objects representation.

See also

BxDolSearchExtended

Member Function Documentation

getResults()

BxBaseSearchExtended::getResults

(

$aParams = array()

)

Get search results from search form or from custom condition

Parameters

$aParams['cond']	custom condition to pass instead of form submission, conditions are key&value pair, where 'key' is form input name and 'value' is the term to search for
$aParams['start']	position of first record to display
$aParams['per_page']	number of items per page
$aParams['template']	custom unit templates to use

Returns

HTML string with search results

Hooks:

'search', 'get_data' - hook in get data for serach

• $unit_name - equals search
• $action - equals get_data
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • object - [array] by ref, object info for current search, can be overridden in hook processing
  • search_params - [string] by ref, search params, can be overridden in hook processing
  • search_results - [string] by ref, html for block, can be overridden in hook processing

    HOOKS

    'search', 'get_data' - hook in get data for serach

---

The documentation for this class was generated from the following file:

• template/scripts/BxBaseSearchExtended.php