class ItemList (View source)

Properties

protected $sortColumnParameter
protected $sortDirectionParameter
protected $paginationPageParameter
protected $sortBy
protected $sortByDirection
protected $sortBySearchColumn
protected $enableAutomaticSorting
protected $autoSortColumns
protected $itemsPerPage
protected $debug
protected Pagination $pagination

Methods

executeSortBy($field, $direction = 'asc')

No description

executeSanitizedSortBy($field, $direction)

No description

executeGetResults()

No description

getResult($mixed)

No description

debugStart()

No description

debugStop()

No description

debug()

No description

isDebugged()

No description

sortBy($field, $direction = 'asc')

No description

sortBySearchColumn(Column $column, $direction = null)

No description

getSearchByColumn()

No description

sanitizedSortBy($field, $direction = 'asc')

No description

getResults()

Returns a full array of results.

getActiveSortColumn()

No description

isActiveSortColumn($field)

No description

disableAutomaticSorting()

No description

getSortClassName($column)

No description

getSortURL($column, $dir = 'asc', $url = false)

No description

getActiveSortDirection()

No description

getQuerySortColumnParameter()

No description

setItemsPerPage($itemsPerPage)

No description

int
getItemsPerPage()

No description

int
getTotalResults()

Returns the total results in this item list.

getPagination() deprecated

Deprecated – call the pagination factory directly.

setupAutomaticSorting(StickyRequest $request = null)

No description

get() deprecated

No description

setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

Details

abstract protected executeSortBy($field, $direction = 'asc')

Parameters

$field
$direction

protected executeSanitizedSortBy($field, $direction)

Parameters

$field
$direction

abstract executeGetResults()

abstract getResult($mixed)

Parameters

$mixed

abstract debugStart()

abstract debugStop()

debug()

isDebugged()

sortBy($field, $direction = 'asc')

Parameters

$field
$direction

sortBySearchColumn(Column $column, $direction = null)

Parameters

Column $column
$direction

getSearchByColumn()

sanitizedSortBy($field, $direction = 'asc')

Parameters

$field
$direction

getResults()

Returns a full array of results.

getActiveSortColumn()

isActiveSortColumn($field)

Parameters

$field

disableAutomaticSorting()

getSortClassName($column)

Parameters

$column

getSortURL($column, $dir = 'asc', $url = false)

Parameters

$column
$dir
$url

getActiveSortDirection()

getQuerySortColumnParameter()

getQueryPaginationPageParameter()

getQuerySortDirectionParameter()

setItemsPerPage($itemsPerPage)

Parameters

$itemsPerPage

int getItemsPerPage()

Return Value

int

abstract int getTotalResults()

Returns the total results in this item list.

Return Value

int

Pagination getPagination() deprecated

deprecated

Deprecated – call the pagination factory directly.

Return Value

Pagination

setupAutomaticSorting(StickyRequest $request = null)

Parameters

StickyRequest $request

get() deprecated

deprecated

setNameSpace(mixed $nameSpace)

Allow to modify the auto-pagination parameters and the auto-sorting parameters

Parameters

mixed $nameSpace Content that will be added to the parameters