Class PageList

An object that allows a filtered list of pages to be returned.

Concrete\Core\Search\ItemList\ItemList
Extended by Concrete\Core\Search\ItemList\Database\ItemList
Extended by Concrete\Core\Search\ItemList\Database\AttributedItemList
Extended by Concrete\Core\Page\PageList implements Concrete\Core\Search\PermissionableListItemInterface
Namespace: Concrete\Core\Page
Located at src/Page/PageList.php

Methods summary

protected
public
public
public
public
public
public
public
# setPageVersionToRetrieve( $pageVersionToRetrieve )
public
public Doctrine\DBAL\Query\QueryBuilder
# finalizeQuery( Doctrine\DBAL\Query\QueryBuilder $query )
public integer
# getTotalResults( )

Returns the total results in this item list.

protected Concrete\Core\Search\Pagination\Pagination
public Concrete\Core\File\File
# getResult( $queryRow )
public
public
# filterByPageTypeHandle( mixed $ptHandle )

Filters by type of collection (using the handle field).

public
# filterByPageTemplate( Concrete\Core\Page\Template $template )

Filters by page template.

public
# filterByDateAdded( string $date, $comparison = '=' )

Filters by date added.

public
# filterByNumberOfChildren( $number, string $comparison = '>' )

Filter by number of children.

public
# filterByDateLastModified( $date, string $comparison = '=' )

Filter by last modified date.

public
# filterByPublicDate( string $date, $comparison = '=' )

Filters by public date.

public
# filterByPagesWithCustomStyles( )

Displays only those pages that have style customizations.

public
# filterByUserID( mixed $uID )

Filters by user ID).

public
# filterByPageTypeID( array $ptID )

Filters by page type ID.

public
# filterByParentID( array $cParentID )

Filters by parent ID.

public
# filterByName( $name, boolean $exact = false )

Filters a list by page name.

public
# filterByPath( $path, boolean $includeAllChildren = true )

Filter a list by page path.

public
# filterByKeywords( $keywords )

Filters keyword fields by keywords (including name, description, content, and attributes.

public
public
# filterByTopic( $topic )

Filters by topic. Doesn't look at specific attributes –instead, actually joins to the topics table.

public
# sortByDisplayOrder( )

Sorts this list by display order.

public
# sortByDisplayOrderDescending( )

Sorts this list by display order descending.

public
# sortByCollectionIDAscending( )

Sorts by ID in ascending order.

public
# sortByPublicDate( )

Sorts this list by public date ascending order.

public
# sortByName( )

Sorts by name in ascending order.

public
# sortByNameDescending( )

Sorts by name in descending order.

public
# sortByPublicDateDescending( )

Sorts this list by public date descending order.

public
# sortByRelevance( )

Sorts by fulltext relevance (requires that the query be fulltext-based.

public
# filterByCollectionTypeHandle( $ctHandle )
public
# filterByCollectionTypeID( $ctID )
public
# ignoreAliases( )

This does nothing.

public
# displayUnapprovedPages( )

Constants summary

integer PAGE_VERSION_ACTIVE
# 1
integer PAGE_VERSION_RECENT
# 2

Properties summary

protected Closure $permissionsChecker

| integer | null

#
protected array $autoSortColumns

Columns in this array can be sorted via the request.

# array('cv.cvName', 'cv.cvDatePublic', 'c.cDateAdded', 'c.cDateModified')
protected integer $pageVersionToRetrieve

Which version to attempt to retrieve.

protected boolean $isFulltextSearch

Whether this is a search using fulltext.

# false
protected boolean $includeSystemPages

Whether to include system pages (login, etc...) in this query.

# false
protected boolean $includeAliases

Whether to include aliases in the result set.

# false
protected boolean $includeInactivePages

Whether to include inactive (deleted) pages in the query.

# false