abstract class EntityItemList extends ItemList (View source)

Properties

protected $sortColumnParameter from  ItemList
protected $sortDirectionParameter from  ItemList
protected $paginationPageParameter from  ItemList
protected $sortBy from  ItemList
protected $sortByDirection from  ItemList
protected $sortBySearchColumn from  ItemList
protected $enableAutomaticSorting from  ItemList
protected $autoSortColumns from  ItemList
protected $itemsPerPage from  ItemList
protected $debug from  ItemList
protected Pagination $pagination from  ItemList
protected QueryBuilder $query

Methods

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

No description

executeSanitizedSortBy($field, $direction)

No description

from  ItemList
executeGetResults()

No description

getResult($mixed)

No description

from  ItemList
debugStart()

No description

debugStop()

No description

debug()

No description

from  ItemList
isDebugged()

No description

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

No description

from  ItemList
sortBySearchColumn(Column $column, $direction = null)

No description

from  ItemList
getSearchByColumn()

No description

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

No description

from  ItemList
getResults()

Returns a full array of results.

from  ItemList
getActiveSortColumn()

No description

from  ItemList
isActiveSortColumn($field)

No description

from  ItemList
disableAutomaticSorting()

No description

from  ItemList
getSortClassName($column)

No description

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

No description

from  ItemList
getActiveSortDirection()

No description

from  ItemList
getQuerySortColumnParameter()

No description

from  ItemList
loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

from  ItemList
from  ItemList
setItemsPerPage($itemsPerPage)

No description

from  ItemList
int
getItemsPerPage()

No description

from  ItemList
int
getTotalResults()

Returns the total results in this item list.

from  ItemList
getPagination() deprecated

Deprecated – call the pagination factory directly.

from  ItemList
setupAutomaticSorting(StickyRequest $request = null)

No description

from  ItemList
get() deprecated

No description

from  ItemList
setNameSpace(mixed $nameSpace)

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

from  ItemList
EntityManager
getEntityManager()

No description

createQuery()

No description

__construct()

No description

getQueryObject()

No description

finalizeQuery(QueryBuilder $query)

No description

deliverQueryObject()

No description

Details

protected executeSortBy($column, $direction = 'asc')

No description

Parameters

$column
$direction

protected executeSanitizedSortBy($field, $direction)

No description

Parameters

$field
$direction

executeGetResults()

No description

abstract getResult($mixed)

No description

Parameters

$mixed

debugStart()

No description

debugStop()

No description

debug()

No description

isDebugged()

No description

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

No description

Parameters

$field
$direction

sortBySearchColumn(Column $column, $direction = null)

No description

Parameters

Column $column
$direction

getSearchByColumn()

No description

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

No description

Parameters

$field
$direction

getResults()

Returns a full array of results.

getActiveSortColumn()

No description

isActiveSortColumn($field)

No description

Parameters

$field

disableAutomaticSorting()

No description

getSortClassName($column)

No description

Parameters

$column

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

No description

Parameters

$column
$dir
$url

getActiveSortDirection()

No description

getQuerySortColumnParameter()

No description

getQueryPaginationPageParameter()

No description

protected loadQueryStringPagingVariable()

Get paging parameter from Concrete configuration

getQuerySortDirectionParameter()

No description

setItemsPerPage($itemsPerPage)

No description

Parameters

$itemsPerPage

int getItemsPerPage()

No description

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)

No description

Parameters

StickyRequest $request

get() deprecated

deprecated

No description

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

abstract EntityManager getEntityManager()

No description

Return Value

EntityManager

abstract createQuery()

No description

__construct()

No description

getQueryObject()

No description

finalizeQuery(QueryBuilder $query)

No description

Parameters

QueryBuilder $query

deliverQueryObject()

No description