BxBaseSearchResult Class Reference

Inheritance diagram for BxBaseSearchResult:

Public Member Functions
	setDesignBoxTemplateId ($i)
	setCenterContentUnitSelector ($s)
	applyContainerId ()
	addContainerClass ($mixed)
	removeContainerClass ($mixed)
	applyContainerClass ()
	addContainerAttribute ($aAttributes)
	removeContainerAttribute ($mixedName)
Public Member Functions inherited from BxDolSearchResult
	__construct ()
	setDisplayEmptyMsg ($b, $sLangKey='')
	setProcessPrivateContent ($b)
	processingRaw ()
	processing ()
	displayResultBlock ()
	displayResultBlockEmpty ()
	addCustomParts ()
	rss ()
	outputRSS ()
	getRssUnitLink (&$a)
	getRssUnitImage (&$a, $sField)
	setFieldUnit ($sFieldName, $sTableName, $sOperator='', $bRenameMode=true)
	displaySearchUnit ($aData)
	displaySearchBox ($sCode, $sPaginate='')
	showPagination ($bAdmin=false, $bChangePage=true, $bPageReload=true)
	getSearchData ()
	getSearchQuery ($sObject, $aParams=[])
	getJoins ($bRenameMode=true)
	getSearchDataByParams ($aParams='')
	setConditionParams ()
	getNum ()
	getTotal ()
	getRestriction ()
	getLimit ($isAddPlusOne=false)
	setSorting ()
	getSorting ($sSortType='last')
	getAlterOrder ()
	setPaginate ()
	getSearchFieldsCond ($aFields, $sKeyword, $sPseud='')
	getMultiValues ($aValues)
	_getPseud ()
	addMarkers ($a)

Protected Member Functions
	getCurrentUrl ($aAdditionalParams=array(), $bReplacePagesParams=true)
	getCurrentOnclick ($aAdditionalParams=array(), $bReplacePagesParams=true)
Protected Member Functions inherited from BxDolSearchResult
	_replaceMarkers ($mixed)

Member Function Documentation

addContainerAttribute()

BxBaseSearchResult::addContainerAttribute

(

$aAttributes

)

Add attribute(s) to search result container

Parameters

$aAttributes

an array of Key -> Value pair(s).

addContainerClass()

BxBaseSearchResult::addContainerClass

(

$mixed

)

Add class to search result container

Parameters

$mixed

CSS class name string or array of classes

applyContainerClass()

BxBaseSearchResult::applyContainerClass

(

)

Apply class(es) for search result container

Returns

string with a list of classes.

applyContainerId()

BxBaseSearchResult::applyContainerId

(

)

Add ID to search result container

Parameters

$string

HTML ID

getCurrentOnclick()

BxBaseSearchResult::getCurrentOnclick (   $aAdditionalParams = array(),   $bReplacePagesParams = true  )

protected

Get current browse URL with current page and additional params

Parameters

$aAdditionalParams	set custom additional params as key value pair
$bReplacePagesParams	replace paginate params with current values or leave markers for use in paginate class

Returns

ready to use URL string with BX_DOL_URL_ROOT added in the beginning

getCurrentUrl()

BxBaseSearchResult::getCurrentUrl (   $aAdditionalParams = array(),   $bReplacePagesParams = true  )

protected

Get current browse URL with current page and additional params

Parameters

$aAdditionalParams	set custom additional params as key value pair
$bReplacePagesParams	replace paginate params with current values or leave markers for use in paginate class

Returns

ready to use URL string with BX_DOL_URL_ROOT added in the beginning

removeContainerAttribute()

BxBaseSearchResult::removeContainerAttribute

(

$mixedName

)

Remove attribute(s) from search result container

Parameters

$mixedName

attribute name or an array of names

removeContainerClass()

BxBaseSearchResult::removeContainerClass

(

$mixed

)

Remove class from search result container

Parameters

$mixed

CSS class name string or array of classes

setCenterContentUnitSelector()

BxBaseSearchResult::setCenterContentUnitSelector

(

$s

)

Set unit class selector for content centering

setDesignBoxTemplateId()

BxBaseSearchResult::setDesignBoxTemplateId

(

$i

)

Set design box template id to use to wrap search results in

---

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

• template/scripts/BxBaseSearchResult.php