PageList
class PageList extends AttributedItemList implements PagerProviderInterface, PaginationProviderInterface (View source)
An object that allows a filtered list of pages to be returned.
Constants
| PAGE_VERSION_ACTIVE |
|
| PAGE_VERSION_RECENT |
|
| PAGE_VERSION_RECENT_UNAPPROVED |
|
| SITE_TREE_CURRENT |
|
| SITE_TREE_ALL |
|
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 array | $autoSortColumns | Columns in this array can be sorted via the request. |
|
| protected | $itemsPerPage | from ItemList | |
| protected | $debug | from ItemList | |
| protected Pagination | $pagination | from ItemList | |
| protected QueryBuilder | $query | from ItemList | |
| protected StickyRequest | $searchRequest | from ItemList | |
| protected Closure | $permissionsChecker | ||
| protected Tree | $siteTree | ||
| protected int | $pageVersionToRetrieve | Which version to attempt to retrieve. |
|
| protected | $isFulltextSearch | Whether this is a search using fulltext. |
|
| protected bool | $includeSystemPages | Whether to include system pages in this query. NOTE: There really isn't a reason to set this to true unless you're doing something pretty custom or deep in the core |
|
| protected | $includeAliases | Whether to include aliases in the result set. |
|
| protected bool | $includeInactivePages | Whether to include inactive (deleted) pages in the query. |
Methods
No description
Returns the total results in this item list.
No description
No description
No description
Filters by a attribute.
Magic method for setting up additional filtering by attributes.
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 standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter
No description
Filters by type of collection (using the handle field).
Filters by date added.
Filter by number of children.
Filter by last modified date.
Filters by public date.
Displays only those pages that have style customizations.
Filters by user ID).
Filters by page type ID.
Filters by parent ID.
Filters a list by page name.
Filter a list by page path.
Filters keyword fields by keywords (including name, description, content, and attributes.
No description
Filters by topic. Doesn't look at specific attributes –instead, actually joins to the topics table.
Sorts this list by display order.
Sorts this list by display order descending.
Sorts this list by date modified ascending.
Sorts this list by date modified descending.
Sorts by ID in ascending order.
Sorts this list by public date ascending order.
Sorts by name in ascending order.
Sorts by name in descending order.
Sorts this list by public date descending order.
Sorts by fulltext relevance (requires that the query be fulltext-based.
Details
protected
executeSortBy($column, $direction = 'asc')
No description
protected
executeSanitizedSortBy($column, $direction = 'asc')
No description
executeGetResults()
No description
getResult($queryRow)
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
getQueryPaginationPageParameter()
No description
getQuerySortDirectionParameter()
No description
setItemsPerPage($itemsPerPage)
No description
int
getItemsPerPage()
No description
int
getTotalResults()
Returns the total results in this item list.
Pagination
getPagination()
deprecated
deprecated
Deprecated – call the pagination factory directly.
setupAutomaticSorting(StickyRequest $request = null)
No description
get()
deprecated
deprecated
No description
createQuery()
No description
QueryBuilder
finalizeQuery(QueryBuilder $query)
No description
__construct(StickyRequest $req = null)
No description
StickyRequest|null
getSearchRequest()
No description
getQueryObject()
No description
deliverQueryObject()
No description
filter($field, $value, $comparison = '=')
deprecated
deprecated
No description
__clone()
No description
protected
getAttributeKeyClassName()
No description
filterByAttribute($handle, $value, $comparison = '=')
Filters by a attribute.
__call($nm, $a)
Magic method for setting up additional filtering by attributes.
PagerManagerInterface
getPagerManager()
No description
getPermissionsChecker()
No description
VariableFactory
getPagerVariableFactory()
No description
setSiteTreeObject(TreeInterface $tree)
No description
setSiteTreeToAll()
No description
setSiteTreeToCurrent()
No description
includeSystemPages()
No description
setPermissionsChecker(Closure $checker = null)
No description
ignorePermissions()
No description
enablePermissions()
No description
includeAliases()
No description
includeInactivePages()
No description
isFulltextSearch()
No description
setPageVersionToRetrieve($pageVersionToRetrieve)
No description
filterBySite(Site $site)
No description
mixed
getPaginationAdapter()
Returns the standard pagination adapter. This is used for non-permissioned objects and is typically something like DoctrineDbalAdapter
checkPermissions($mixed)
No description
filterByPageTypeHandle(mixed $ptHandle)
Filters by type of collection (using the handle field).
filterByPageTemplate(Template $template)
Filters by page template.
filterByDateAdded(string $date, $comparison = '=')
Filters by date added.
filterByNumberOfChildren($number, string $comparison = '>')
Filter by number of children.
filterByDateLastModified($date, string $comparison = '=')
Filter by last modified date.
filterByPublicDate(string $date, $comparison = '=')
Filters by public date.
filterByPackage(Package $package)
Filters by package.
filterByPagesWithCustomStyles()
Displays only those pages that have style customizations.
filterByUserID(mixed $uID)
Filters by user ID).
filterByPageTypeID($ptID)
Filters by page type ID.
filterByParentID($cParentID)
Filters by parent ID.
filterByName($name, bool $exact = false)
Filters a list by page name.
filterByPath($path, bool $includeAllChildren = true)
Filter a list by page path.
filterByKeywords($keywords)
Filters keyword fields by keywords (including name, description, content, and attributes.
filterByFulltextKeywords($keywords)
No description
filterByTopic($topic)
Filters by topic. Doesn't look at specific attributes –instead, actually joins to the topics table.
filterByBlockType(BlockType $bt)
No description
sortByDisplayOrder()
Sorts this list by display order.
sortByDisplayOrderDescending()
Sorts this list by display order descending.
sortByDateModified()
Sorts this list by date modified ascending.
sortByDateModifiedDescending()
Sorts this list by date modified descending.
sortByCollectionIDAscending()
Sorts by ID in ascending order.
sortByPublicDate()
Sorts this list by public date ascending order.
sortByName()
Sorts by name in ascending order.
sortByNameDescending()
Sorts by name in descending order.
sortByPublicDateDescending()
Sorts this list by public date descending order.
sortByRelevance()
Sorts by fulltext relevance (requires that the query be fulltext-based.
filterByCollectionTypeHandle($ctHandle)
deprecated
deprecated
No description
filterByCollectionTypeID($ctID)
deprecated
deprecated
No description
ignoreAliases()
deprecated
deprecated
This does nothing.
displayUnapprovedPages()
deprecated
deprecated
No description