PageList
class PageList extends DatabaseItemList (View source)
An object that allows a filtered list of pages to be returned.
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 | from DatabaseItemList | |
| protected | $userQuery | from DatabaseItemList | |
| protected | $debug | from DatabaseItemList | |
| protected | $filters | from DatabaseItemList | |
| protected | $sortByString | from DatabaseItemList | |
| protected | $groupByString | from DatabaseItemList | |
| protected | $havingString | from DatabaseItemList | |
| protected | $autoSortColumns | ||
| protected | $userPostQuery | from DatabaseItemList | |
| protected | $attributeClass | ||
| protected | $includeSystemPages | ||
| protected | $attributeFilters | ||
| protected | $includeAliases | ||
| protected | $displayOnlyPermittedPages | ||
| protected | $displayOnlyApprovedPages | ||
| protected | $displayOnlyActivePages | ||
| protected | $filterByCParentID | ||
| protected | $filterByPageType | ||
| protected | $ignorePermissions | ||
| protected | $indexedSearch | ||
| protected | $viewPagePermissionKeyHandle |
Methods
Returns the total number of items found by this list.
Returns an array of page objects based on current settings.
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
Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags).
No description
No description
Sets up a list to only return items the proper user can access.
No description
Sorts this list by display order.
Sorts this list by display order descending.
No description
Sorts this list by public date ascending order.
Sorts this list by name.
Sorts this list by name descending order.
Sorts this list by public date descending order.
Sets the parent ID that we will grab pages from.
Filters by type of collection (using the ID field).
Filters by user ID of collection (using the uID field).
No description
No description
Filters by type of collection (using the handle field).
No description
Filters by date added.
No description
No description
Filters by public date.
No description
If true, pages will be checked for permissions prior to being returned.
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 page objects based on current settings.
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
__call($nm, $a)
No description
setViewPagePermissionKeyHandle($pkHandle)
No description
includeInactivePages()
No description
ignorePermissions()
No description
ignoreAliases()
No description
includeSystemPages()
No description
displayUnapprovedPages()
No description
isIndexedSearch()
No description
filterByKeywords($keywords, $simple = false)
Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags).
filterByName($name, $exact = false)
No description
filterByPath($path, $includeAllChildren = true)
No description
setupPermissions()
Sets up a list to only return items the proper user can access.
sortByRelevance()
No description
sortByDisplayOrder()
Sorts this list by display order.
sortByDisplayOrderDescending()
Sorts this list by display order descending.
sortByCollectionIDAscending()
No description
sortByPublicDate()
Sorts this list by public date ascending order.
sortByName()
Sorts this list by name.
sortByNameDescending()
Sorts this list by name descending order.
sortByPublicDateDescending()
Sorts this list by public date descending order.
filterByParentID(mixed $cParentID)
Sets the parent ID that we will grab pages from.
filterByPageTypeID(mixed $ptID)
Filters by type of collection (using the ID field).
filterByCollectionTypeID($ctID)
deprecated
deprecated
No description
filterByUserID(mixed $uID)
Filters by user ID of collection (using the uID field).
filterByIsApproved($cvIsApproved)
No description
filterByIsAlias($ia)
No description
filterByPageTypeHandle(mixed $ptHandle)
Filters by type of collection (using the handle field).
filterByCollectionTypeHandle($ctHandle)
No description
filterByDateAdded(string $date, $comparison = '=')
Filters by date added.
filterByNumberOfChildren($num, $comparison = '>')
No description
filterByDateLastModified($date, $comparison = '=')
No description
filterByPublicDate(string $date, $comparison = '=')
Filters by public date.
filterBySelectAttribute($akHandle, $value)
No description
displayOnlyPermittedPages(bool $checkForPermissions)
If true, pages will be checked for permissions prior to being returned.
protected
setBaseQuery($additionalFields = '')
No description
protected
setupSystemPagesToExclude()
No description
protected
loadPageID($cID, $versionOrig = 'RECENT')
No description