BxFilesSearchResult Class Reference

Inheritance diagram for BxFilesSearchResult:

Public Member Functions
	__construct ($sMode='', $aParams=array())
	addCustomParts ()
	getSearchData ()
	processing ()
	showPagination ($bAdmin=false, $bChangePage=true, $bPageReload=true)
	getAlterOrder ()
Public Member Functions inherited from BxBaseModTextSearchResult
	getRssUnitImage (&$a, $sField)
	_getPseud ()
Public Member Functions inherited from BxBaseModGeneralSearchResult
	getMain ()
	getContentInfoObject ()
	getRssUnitLink (&$a)
	getRssPageUrl ()
	rss ()
	processingAPI ()
	displayResultBlock ()
	displaySearchBox ($sContent, $sPaginate='')
	applyContainerId ()
	decodeDataAPI ($a)
Public Member Functions inherited from BxTemplSearchResult
	__construct ($oFunctions=false)
	applyContainerClass ()
	__construct ($oFunctions=false)
Public Member Functions inherited from BxBaseSearchResult
	displayResultBlockEmpty ()
	displaySearchUnit ($aData)
	setUnitTemplate ($s)
	getDesignBoxMenu ()
	showAdminActionsPanel ($sWrapperId, $aButtons, $sCheckboxName='entry', $bSelectAll=true, $bSelectAllChecked=false, $sCustomHtml='')
	showAdminFilterPanel ($sFilterValue, $sInputId='filter_input_id', $sCheckboxId='filter_checkbox_id', $sFilterName='filter', $sOnApply='')
	clearFilters ($aPassParams=array(), $aPassJoins=array())
	fillFilters ($aParams)
	fillFiltersByObjects ($aParams)
	setDesignBoxTemplateId ($i)
	setCenterContentUnitSelector ($s)
	addContainerClass ($mixed)
	removeContainerClass ($mixed)
	addContainerAttribute ($aAttributes)
	removeContainerAttribute ($mixedName)
	setUnitParams ($aParamsAdd=array(), $aParamsRemove=array())
Public Member Functions inherited from BxDolSearchResult
	__construct ()
	getId ()
	setId ($sId)
	getModuleName ()
	getContentInfoName ()
	setAjaxPaginate ($b=true)
	setPaginatePerPage ($iPerPage)
	setSingleSearch ($bSingleSearch)
	setLiveSearch ($bLiveSearch)
	setMetaType ($s)
	isMetaEnabled ($s)
	setCategoryObject ($s)
	setCustomSearchCondition ($a)
	setCustomCurrentCondition ($a)
	setCategoriesCondition ($sKeyword)
	setDisplayEmptyMsg ($b, $sLangKey='')
	setProcessPrivateContent ($b)
	processingRaw ()
	outputRSS ()
	setFieldUnit ($sFieldName, $sTableName, $sOperator='', $bRenameMode=true)
	getSearchQuery ($sObject, $aParams=[])
	getJoins ($bRenameMode=true)
	getSearchDataByParams ($aParams='')
	setConditionParams ()
	getNum ()
	getTotal ()
	getRestriction ()
	getLimit ($isAddPlusOne=false)
	setSorting ()
	getSorting ($sSortType='last')
	setPaginate ()
	unsetPaginate ()
	getSearchFieldsCond ($aFields, $sKeyword, $sPseud='')
	getMultiValues ($aValues)
	addMarkers ($a)

Protected Member Functions
	addConditionsForBookmarks (&$CNF)
	addConditionsForMimeType (&$CNF)
	getBrowseToolbarControls (&$aParams, $sJsObject)
	getBrowseToolbarBreadcrumbs ($sJsObject)
	getBrowseToolbar (&$aParams)
Protected Member Functions inherited from BxBaseModTextSearchResult
	checkRestrictionsForContext ($sMode, $aParams, $oProfileAuthor)
	processReplaceableMarkers ($oProfileAuthor)
	getCurrentOnclick ($aAdditionalParams=array(), $bReplacePagesParams=true)
	_updateCurrentForAuthor ($sMode, $aParams, &$oProfileAuthor)
	_updateCurrentForContext ($sMode, $aParams, &$oProfileContext)
	_updateCurrentForFavorite ($sMode, $aParams, &$oProfileAuthor)
Protected Member Functions inherited from BxBaseModGeneralSearchResult
	addCustomConditions ($CNF, $oProfile, $sMode, $aParams)
	addConditionsForAuthorStatus ($CNF)
	addConditionsForCf ($CNF)
	addConditionsForFilter ($CNF, $sMode, $aParams)
	addConditionsForPrivateContent ($CNF, $oProfile, $aCustomGroup=array())
	getItemPerPageInShowCase ()
Protected Member Functions inherited from BxBaseSearchResult
	addPageRssLink ()
	getCurrentUrl ($aAdditionalParams=array(), $bReplacePagesParams=true)
	addAdditionalUrlParams ($sUrl, $aAdditionalParams, $bReplacePagesParams, $bAddPaginateParams=true)
Protected Member Functions inherited from BxDolSearchResult
	_replaceMarkers ($mixed)

Protected Attributes
	$sOrderParamName = 'order'
	$sBookmarksParamName = 'bookmarks'
	$sSortingParamName = 'sorting'
	$sCurrentFolderParamName = 'folder'
	$sCurrentView
	$aSortingOptions
	$bFileManagerMode = false
	$iFileManagerUploadTo = 0
	$sMode = ''
Protected Attributes inherited from BxBaseModTextSearchResult
	$sUnitViewParamName = 'unit_view'
Protected Attributes inherited from BxBaseModGeneralSearchResult
	$oModule
	$sFilterName
	$bShowcaseView = false
	$aUnitViews = array()
	$sUnitViewDefault = 'gallery'
Protected Attributes inherited from BxTemplSearchResult
	$_sModule
	$_oModule
Protected Attributes inherited from BxBaseSearchResult
	$oFunctions
	$sBrowseUrl
	$sUnitTemplate = 'unit.html'
	$sUnitTemplateLiveSearch = 'unit_live_search.html'
	$aGetParams = array()
	$iDesignBoxTemplate = 11
	$aConstants
	$sCenterContentUnitSelector = false
	$aContainerAttrs = array()
	$aContainerClasses = array('bx-search-result-block', 'bx-clearfix')
	$aUnitParams = array()
Protected Attributes inherited from BxDolSearchResult
	$aPseud
	$id
	$bDisplayEmptyMsg = false
	$sDisplayEmptyMsgKey = ''
	$bProcessPrivateContent = true
	$aPrivateConditionsIndexes = array('restriction' => array(), 'join' => array())
	$bForceAjaxPaginate = false
	$iPaginatePerPage = BX_DOL_SEARCH_RESULTS_PER_PAGE_DEFAULT
	$_bIsApi
	$_bSingleSearch = true
	$_bLiveSearch = false
	$_sMetaType = ''
	$_sMode = ''
	$_aParams = []
	$_sCategoryObject = ''
	$_aCustomSearchCondition = array()
	$_bValidate = false
	$_aMarkers = array ()

Additional Inherited Members
Public Attributes inherited from BxBaseSearchResult
	$isError
Public Attributes inherited from BxDolSearchResult
	$aCurrent

Constructor & Destructor Documentation

__construct()

BxFilesSearchResult::__construct	(		$sMode = '',
			$aParams = array() )

Reimplemented from BxBaseModTextSearchResult.

Member Function Documentation

addCustomParts()

BxFilesSearchResult::addCustomParts

(

)

Add different code before html output (usually redeclared) no return result

Reimplemented from BxDolSearchResult.

getAlterOrder()

BxFilesSearchResult::getAlterOrder

(

)

Return own varaint for sorting (redeclare if necessary) return array of sql elements

Reimplemented from BxBaseModTextSearchResult.

getSearchData()

BxFilesSearchResult::getSearchData

(

)

Get array of data with search results return array with data

Hooks:

'simple_search', 'before_get_data' - hook on before after get data

• $unit_name - equals simple_search
• $action - equals before_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, array of parameters, can be overridden in hook processing
  • mode - [string] search mode

    HOOKS

    'simple_search', 'before_get_data' - hook on before after get data

Hooks:

'simple_search', 'get_data' - hook on after get data

• $unit_name - equals simple_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, array of parameters, can be overridden in hook processing
  • mode - [string] search mode
  • search_object - [string] search object name

    HOOKS

    'simple_search', 'get_data' - hook on after get data

Reimplemented from BxDolSearchResult.

processing()

BxFilesSearchResult::processing

(

)

Get html box of search results (usually used in grlobal search)

Returns

html code

Reimplemented from BxDolSearchResult.

showPagination()

BxFilesSearchResult::showPagination	(		$bAdmin = false,
			$bChangePage = true,
			$bPageReload = true )

Get html code of pagination

Reimplemented from BxBaseModGeneralSearchResult.

---

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

• modules/boonex/files/classes/BxFilesSearchResult.php