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

Located in /models/page_list.php (line 11)

ItemList
   |
   --DatabaseItemList
      |
      --PageList

mixed $attributeClass = 'CollectionAttributeKey' (line 22)

• access: protected

mixed $attributeFilters = array() (line 14)

• access: protected

mixed $autoSortColumns = array('cvName', 'cvDatePublic', 'cDateAdded', 'cDateModified') (line 23)

• access: protected

---

Redefinition of:

DatabaseItemList::$autoSortColumns

mixed $displayOnlyApprovedPages = true (line 17)

• access: protected

mixed $displayOnlyPermittedPages = false (line 16)

• access: protected

mixed $filterByCParentID = 0 (line 19)

• access: protected

mixed $filterByCT = false (line 20)

• access: protected

mixed $ignorePermissions = false (line 21)

• access: protected

mixed $includeAliases = true (line 15)

• access: protected

mixed $includeSystemPages = false (line 13)

• access: protected

mixed $indexedSearch = false (line 24)

• access: protected

mixed $systemPagesToExclude = array('login.php', 'page_not_found.php', 'page_forbidden.php','register.php', 'download_file.php', 'profile/%', 'dashboard/%') (line 18)

• access: protected

Inherited Variables

Inherited from DatabaseItemList

DatabaseItemList::$debug
DatabaseItemList::$filters
DatabaseItemList::$groupByString
DatabaseItemList::$havingString
DatabaseItemList::$query
DatabaseItemList::$sortByString
DatabaseItemList::$userPostQuery
DatabaseItemList::$userQuery

Inherited from ItemList

ItemList::$currentPage
ItemList::$enableStickySearchRequest
ItemList::$items
ItemList::$itemsPerPage
ItemList::$queryStringPagingVariable
ItemList::$queryStringSortDirectionVariable
ItemList::$queryStringSortVariable
ItemList::$sortBy
ItemList::$sortByDirection
ItemList::$start
ItemList::$stickySearchRequestNameSpace
ItemList::$total

displayOnlyPermittedPages (line 307)

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

• access: public

void displayOnlyPermittedPages (bool $checkForPermissions)

• bool $checkForPermissions

displayUnapprovedPages (line 52)

• access: public

void displayUnapprovedPages ()

filterByCollectionTypeHandle (line 258)

Filters by type of collection (using the handle field)

• access: public

void filterByCollectionTypeHandle ( $ctHandle, mixed $ctID)

• mixed $ctID
• $ctHandle

filterByCollectionTypeID (line 223)

Filters by type of collection (using the ID field)

• access: public

void filterByCollectionTypeID (mixed $ctID)

• mixed $ctID

filterByDateAdded (line 280)

Filters by date added

• access: public

void filterByDateAdded (string $date, [ $comparison = '='])

• string $date
• $comparison

filterByIsAlias (line 244)

• access: public

void filterByIsAlias ( $ia)

• $ia

filterByIsApproved (line 240)

• access: public

void filterByIsApproved ( $cvIsApproved)

• $cvIsApproved

filterByKeywords (line 60)

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

• access: public

void filterByKeywords ( $keywords, [ $simple = false])

• $keywords
• $simple

filterByName (line 82)

• access: public

void filterByName ( $name, [ $exact = false])

• $name
• $exact

filterByNumberOfChildren (line 284)

• access: public

void filterByNumberOfChildren ( $num, [ $comparison = '>'])

• $num
• $comparison

filterByParentID (line 201)

Sets the parent ID that we will grab pages from.

• access: public

void filterByParentID (mixed $cParentID)

• mixed $cParentID

filterByPath (line 90)

• access: public

void filterByPath ( $path, [ $includeAllChildren = true])

• $path
• $includeAllChildren

filterByPublicDate (line 299)

Filters by public date

• access: public

void filterByPublicDate (string $date, [ $comparison = '='])

• string $date
• $comparison

filterByUserID (line 232)

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

• access: public

void filterByUserID ( $uID, mixed $ctID)

• mixed $ctID
• $uID

get (line 397)

Returns an array of page objects based on current settings

• access: public

void get ([ $itemsToGet = 0], [ $offset = 0])

• $itemsToGet
• $offset

---

Redefinition of:

DatabaseItemList::get()

Returns an array of whatever objects extends this class (e.g. PageList returns a list of pages).

getTotal (line 387)

• access: public

void getTotal ()

---

Redefinition of:

DatabaseItemList::getTotal()

ignoreAliases (line 44)

• access: public

void ignoreAliases ()

ignorePermissions (line 40)

• access: public

void ignorePermissions ()

includeSystemPages (line 48)

• access: public

void includeSystemPages ()

isIndexedSearch (line 56)

• access: public

void isIndexedSearch ()

loadPageID (line 383)

• access: protected

void loadPageID ( $cID)

• $cID

setBaseQuery (line 315)

• access: protected

void setBaseQuery ([ $additionalFields = ''])

• $additionalFields

setupPermissions (line 102)

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

• access: public

void setupPermissions ()

setupSystemPagesToExclude (line 355)

• access: protected

void setupSystemPagesToExclude ()

sortByCollectionIDAscending (line 165)

• access: public

void sortByCollectionIDAscending ()

sortByDisplayOrder (line 154)

Sorts this list by display order

• access: public

void sortByDisplayOrder ()

sortByDisplayOrderDescending (line 161)

Sorts this list by display order descending

• access: public

void sortByDisplayOrderDescending ()

sortByName (line 179)

Sorts this list by name

• access: public

void sortByName ()

sortByNameDescending (line 186)

Sorts this list by name descending order

• access: public

void sortByNameDescending ()

sortByPublicDate (line 172)

Sorts this list by public date ascending order

• access: public

void sortByPublicDate ()

sortByPublicDateDescending (line 193)

Sorts this list by public date descending order

• access: public

void sortByPublicDateDescending ()

sortByRelevance (line 144)

• access: public

void sortByRelevance ()

__call (line 28)

• access: public

void __call ( $nm,  $a)

• $nm
• $a

Inherited Methods

Inherited From DatabaseItemList

DatabaseItemList::addToQuery()
DatabaseItemList::debug()
DatabaseItemList::executeBase()
DatabaseItemList::filter()
DatabaseItemList::filterByAttribute()
DatabaseItemList::get()
DatabaseItemList::getQuery()
DatabaseItemList::getSearchResultsClass()
DatabaseItemList::getSortByURL()
DatabaseItemList::getTotal()
DatabaseItemList::groupBy()
DatabaseItemList::having()
DatabaseItemList::setQuery()
DatabaseItemList::setupAttributeFilters()
DatabaseItemList::setupAttributeSort()
DatabaseItemList::setupAutoSort()
DatabaseItemList::setupSortByString()
DatabaseItemList::sortBy()

Inherited From ItemList

ItemList::addToSearchRequest()
ItemList::displayPaging()
ItemList::displaySummary()
ItemList::enableStickySearchRequest()
ItemList::get()
ItemList::getActiveSortColumn()
ItemList::getActiveSortDirection()
ItemList::getItemsPerPage()
ItemList::getPage()
ItemList::getPagination()
ItemList::getQueryStringPagingVariable()
ItemList::getQueryStringSortDirectionVariable()
ItemList::getQueryStringSortVariable()
ItemList::getSearchRequest()
ItemList::getSearchResultsClass()
ItemList::getSortByURL()
ItemList::getSummary()
ItemList::getTotal()
ItemList::isActiveSortColumn()
ItemList::requiresPaging()
ItemList::resetSearchRequest()
ItemList::setCurrentPage()
ItemList::setItems()
ItemList::setItemsPerPage()
ItemList::setNameSpace()
ItemList::sortBy()
ItemList::sortByMultiple()