Contentserv PHP API

CSOpenSearchResultPaginationHandler
in package

Default pagination handler for Open Search

Tags
since

CS20.12

Table of Contents

getTotalResultsCount()  : int
Fetches the total results count
isPrePaginationAvailable()  : bool
Tells whether the pagination was already taken care of during execution of filters
paginate()  : mixed
Executes pagination
searchFilterDidExecuteWithParams()  : mixed
Delegate for after search execution
searchFilterWillExecuteWithParams()  : mixed
Delegate for before search execution

Methods

isPrePaginationAvailable()

Tells whether the pagination was already taken care of during execution of filters

public isPrePaginationAvailable() : bool
Tags
Return values
bool —

paginate()

Executes pagination

public paginate(array<string|int, mixed> $aResponses, int $iPageNumber, int $iPageSize) : mixed
Parameters
$aResponses : array<string|int, mixed>

List of search area responses to be paginated

$iPageNumber : int

The page number for pagination

$iPageSize : int

The Page size for pagination

Tags
Return values
mixed —

searchFilterDidExecuteWithParams()

Delegate for after search execution

public searchFilterDidExecuteWithParams(CSItemSearchFilter $oItemSearchFilter, mixed $oSearchResult, mixed $oItem, mixed $aRootIDs, mixed $bDepth, mixed $bCheckInheritance, mixed $aSortFields, mixed $iLimit, mixed $iCacheTime, mixed $bExtendedResult) : mixed
Parameters
$oItemSearchFilter : CSItemSearchFilter

Item search filter object

$oSearchResult : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$oItem : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$aRootIDs : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bDepth : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bCheckInheritance : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$aSortFields : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$iLimit : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$iCacheTime : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bExtendedResult : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

Tags
Return values
mixed —

searchFilterWillExecuteWithParams()

Delegate for before search execution

public searchFilterWillExecuteWithParams(CSItemSearchFilter $oItemSearchFilter, mixed $oItem, mixed $aRootIDs, mixed $bDepth, mixed $bCheckInheritance, mixed $aSortFields, mixed $iLimit, mixed $iCacheTime, mixed $bExtendedResult) : mixed
Parameters
$oItemSearchFilter : CSItemSearchFilter

Item Search Filter to be executed

$oItem : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$aRootIDs : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bDepth : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bCheckInheritance : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$aSortFields : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$iLimit : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$iCacheTime : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

$bExtendedResult : mixed

Please refer documentation of CSItemSearchFilter::searchContent()

Tags
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results