ItemList
class ItemList (View source)
Properties
| protected | $total | ||
| protected | $itemsPerPage | ||
| protected | $currentPage | ||
| protected | $start | ||
| protected | $sortBy | ||
| protected | $sortByDirection | ||
| protected | $queryStringPagingVariable | ||
| protected | $queryStringSortVariable | ||
| protected | $queryStringSortDirectionVariable | ||
| protected | $enableStickySearchRequest | ||
| protected | $stickySearchRequestNameSpace | ||
| protected | $items |
Methods
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Returns the total number of items found by this list.
Returns an array of object by "page".
No description
No description
Displays summary text about a list.
No description
No description
No description
No description
No description
No description
No description
Gets paging that works in our new format
Gets standard HTML to display paging
Returns an object with properties useful for paging.
Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple().
No description
No description
Sets up a multiple columns to search by. Each argument is taken "as-is" (including asc or desc) and concatenated with commas Note that this is overrides any previous sortByMultiple() call, and all sortBy() calls. Alternatively, you can pass a single array with multiple columns to sort by as its values.
Details
enableStickySearchRequest($namespace = false)
No description
getQueryStringSortVariable()
No description
getQueryStringSortDirectionVariable()
No description
protected
getStickySearchNameSpace($namespace = '')
No description
resetSearchRequest($namespace = '')
No description
addToSearchRequest($key, $value)
No description
getSearchRequest()
No description
setItemsPerPage($num)
No description
getItemsPerPage()
No description
setItems($items)
No description
protected
loadQueryStringPagingVariable()
No description
setNameSpace($ns)
No description
getTotal()
Returns the total number of items found by this list.
getPage($page = false)
Returns an array of object by "page".
get($itemsToGet = 0, $offset = 0)
No description
protected
setCurrentPage($page = false)
No description
displaySummary($right_content = '')
Displays summary text about a list.
getSearchResultsClass($field)
No description
getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())
No description
isActiveSortColumn($column)
No description
getActiveSortColumn()
No description
getActiveSortDirection()
No description
requiresPaging()
No description
getPagination($url = false, $additionalVars = array())
No description
displayPagingV2($script = false, $return = false, $additionalVars = array())
deprecated
deprecated
Gets paging that works in our new format
displayPaging($script = false, $return = false, $additionalVars = array())
Gets standard HTML to display paging
getSummary()
Returns an object with properties useful for paging.
sortBy(string $column, string $direction = 'asc')
Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple().
getSortBy()
No description
getSortByDirection()
No description
sortByMultiple()
Sets up a multiple columns to search by. Each argument is taken "as-is" (including asc or desc) and concatenated with commas Note that this is overrides any previous sortByMultiple() call, and all sortBy() calls. Alternatively, you can pass a single array with multiple columns to sort by as its values.
e.g. $list->sortByMultiple('columna desc', 'columnb asc'); or $list->sortByMultiple(array('columna desc', 'columnb asc'));.