This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_PageList

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

Concrete5_Library_ItemList
Extended by ItemList
Extended by Concrete5_Library_DatabaseItemList
Extended by DatabaseItemList
Extended by Concrete5_Model_PageList

Direct known subclasses

PageList

Package: Pages
Located at core/models/page_list.php

Methods summary

public
# __call( $nm, $a )
public
public
public
public
public
public
public
public
# filterByKeywords( $keywords, $simple = false )

Filters by "keywords" (which searches everything including filenames, title, tags, users who uploaded the file, tags)

public
# filterByName( $name, $exact = false )
public
# filterByPath( $path, $includeAllChildren = true )
public
# setupPermissions( )

Sets up a list to only return items the proper user can access

public
public
# sortByDisplayOrder( )

Sorts this list by display order

public
# sortByDisplayOrderDescending( )

Sorts this list by display order descending

public
public
# sortByPublicDate( )

Sorts this list by public date ascending order

public
# sortByName( )

Sorts this list by name

public
# sortByNameDescending( )

Sorts this list by name descending order

public
# sortByPublicDateDescending( )

Sorts this list by public date descending order

public
# filterByParentID( mixed $cParentID )

Sets the parent ID that we will grab pages from.

public
# filterByCollectionTypeID( mixed $ctID )

Filters by type of collection (using the ID field)

public
# filterByUserID( mixed $uID )

Filters by user ID of collection (using the uID field)

public
# filterByIsApproved( $cvIsApproved )
public
public
# filterByCollectionTypeHandle( mixed $ctHandle )

Filters by type of collection (using the handle field)

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

Filters by date added

public
# filterByNumberOfChildren( $num, $comparison = '>' )
public
# filterByDateLastModified( $date, $comparison = '=' )
public
# filterByPublicDate( string $date, $comparison = '=' )

Filters by public date

public
# filterBySelectAttribute( $akHandle, $value )
public
# displayOnlyPermittedPages( boolean $checkForPermissions )

If true, pages will be checked for permissions prior to being returned

protected
# setBaseQuery( $additionalFields = '' )
protected
protected
# loadPageID( $cID, $versionOrig = 'RECENT' )
public
# getTotal( )

Returns the total number of items found by this list

public
# get( $itemsToGet = 0, $offset = 0 )

Returns an array of page objects based on current settings

Properties summary

protected boolean $includeSystemPages
# false
protected array $attributeFilters
# array()
protected boolean $includeAliases
# true
protected boolean $displayOnlyPermittedPages
# false
protected boolean $displayOnlyApprovedPages
# true
protected boolean $displayOnlyActivePages
# true
protected integer $filterByCParentID
# 0
protected boolean $filterByCT
# false
protected boolean $ignorePermissions
# false
protected string $attributeClass
# 'CollectionAttributeKey'
protected array $autoSortColumns
# array('cvName', 'cvDatePublic', 'cDateAdded', 'cDateModified')
protected boolean $indexedSearch
# false
protected string $viewPagePermissionKeyHandle
# 'view_page'