DatabaseItemList
class DatabaseItemList extends ItemList (View source)
Properties
| protected | $total | from ItemList | |
| protected | $itemsPerPage | from ItemList | |
| protected | $currentPage | from ItemList | |
| protected | $start | from ItemList | |
| protected | $sortBy | from ItemList | |
| protected | $sortByDirection | from ItemList | |
| protected | $queryStringPagingVariable | from ItemList | |
| protected | $queryStringSortVariable | from ItemList | |
| protected | $queryStringSortDirectionVariable | from ItemList | |
| protected | $enableStickySearchRequest | from ItemList | |
| protected | $stickySearchRequestNameSpace | from ItemList | |
| protected | $items | from ItemList | |
| protected | $query | ||
| protected | $userQuery | ||
| protected | $debug | ||
| protected | $filters | ||
| protected | $sortByString | ||
| protected | $groupByString | ||
| protected | $havingString | ||
| protected | $autoSortColumns | ||
| protected | $userPostQuery | ||
| protected | $attributeClass |
Methods
Returns the total number of items found by this list.
Returns an array of whatever objects extends this class (e.g. PageList returns a list of pages).
No description
No description
Gets paging that works in our new format
Gets standard HTML to display paging
Sets column to sort by. Only supports a single column; for multiple columns us 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.
No description
No description
No description
No description
No description
No description
No description
No description
Adds a filter to this item list.
No description
No description
No description
No description
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)
Returns an array of whatever objects extends this class (e.g. PageList returns a list of pages).
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($key, $dir = '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'));.
debug($dbg = true)
No description
protected
setQuery($query)
No description
protected
getQuery()
No description
addToQuery($query)
No description
protected
setupAutoSort()
No description
protected
executeBase()
No description
protected
setupSortByString()
No description
protected
setupAttributeSort()
No description
filter($column, $value, $comparison = '=')
Adds a filter to this item list.
groupBy($key)
No description
having($column, $value, $comparison = '=')
No description
protected
setupAttributeFilters($join)
No description
filterByAttribute($column, $value, $comparison = '=')
No description