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

enableStickySearchRequest($namespace = false)

No description

from ItemList
getQueryStringSortVariable()

No description

from ItemList
getStickySearchNameSpace($namespace = '')

No description

from ItemList
resetSearchRequest($namespace = '')

No description

from ItemList
addToSearchRequest($key, $value)

No description

from ItemList
getSearchRequest()

No description

from ItemList
setItemsPerPage($num)

No description

from ItemList
getItemsPerPage()

No description

from ItemList
setItems($items)

No description

from ItemList
from ItemList
setNameSpace($ns)

No description

from ItemList
getTotal()

Returns the total number of items found by this list.

getPage($page = false)

Returns an array of object by "page".

from ItemList
get($itemsToGet, $offset)

Returns an array of page objects based on current settings.

setCurrentPage($page = false)

No description

from ItemList
displaySummary($right_content = '')

Displays summary text about a list.

from ItemList
getSearchResultsClass($field)

No description

getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())

No description

isActiveSortColumn($column)

No description

from ItemList
getActiveSortColumn()

No description

from ItemList
getActiveSortDirection()

No description

from ItemList
requiresPaging()

No description

from ItemList
getPagination($url = false, $additionalVars = array())

No description

from ItemList
displayPagingV2($script = false, $return = false, $additionalVars = array())

Gets paging that works in our new format

from ItemList
displayPaging($script = false, $return = false, $additionalVars = array())

Gets standard HTML to display paging

from ItemList
getSummary()

Returns an object with properties useful for paging.

from ItemList
sortBy($key, $dir = 'asc')

Sets column to sort by. Only supports a single column; for multiple columns us sortByMultiple().

getSortBy()

No description

from ItemList
getSortByDirection()

No description

from ItemList
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.

from ItemList
debug($dbg = true)

No description

setQuery($query)

No description

getQuery()

No description

addToQuery($query)

No description

setupAutoSort()

No description

executeBase()

No description

setupSortByString()

No description

setupAttributeSort()

No description

filter($column, $value, $comparison = '=')

Adds a filter to this item list.

groupBy($key)

No description

having($column, $value, $comparison = '=')

No description

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

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($date, $comparison = '=')

Filters by date added.

filterByNumberOfChildren($num, $comparison = '>')

No description

filterByDateLastModified($date, $comparison = '=')

No description

filterByPublicDate($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.

setBaseQuery($additionalFields = '')

No description

setupSystemPagesToExclude()

No description

loadPageID($cID, $versionOrig = 'RECENT')

No description

Details

enableStickySearchRequest($namespace = false)

Parameters

$namespace

getQueryStringSortVariable()

getQueryStringSortDirectionVariable()

protected getStickySearchNameSpace($namespace = '')

Parameters

$namespace

resetSearchRequest($namespace = '')

Parameters

$namespace

addToSearchRequest($key, $value)

Parameters

$key
$value

getSearchRequest()

setItemsPerPage($num)

Parameters

$num

getItemsPerPage()

setItems($items)

Parameters

$items

protected loadQueryStringPagingVariable()

setNameSpace($ns)

Parameters

$ns

getTotal()

Returns the total number of items found by this list.

getPage($page = false)

Returns an array of object by "page".

Parameters

$page

get($itemsToGet, $offset)

Returns an array of page objects based on current settings.

Parameters

$itemsToGet
$offset

protected setCurrentPage($page = false)

Parameters

$page

displaySummary($right_content = '')

Displays summary text about a list.

Parameters

$right_content

getSearchResultsClass($field)

Parameters

$field

getSortByURL($column, $dir = 'asc', $baseURL = false, $additionalVars = array())

Parameters

$column
$dir
$baseURL
$additionalVars

isActiveSortColumn($column)

Parameters

$column

getActiveSortColumn()

getActiveSortDirection()

requiresPaging()

getPagination($url = false, $additionalVars = array())

Parameters

$url
$additionalVars

displayPagingV2($script = false, $return = false, $additionalVars = array())

Gets paging that works in our new format

Parameters

$script
$return
$additionalVars

displayPaging($script = false, $return = false, $additionalVars = array())

Gets standard HTML to display paging

Parameters

$script
$return
$additionalVars

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().

Parameters

$key
$dir

getSortBy()

getSortByDirection()

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)

Parameters

$dbg

protected setQuery($query)

Parameters

$query

protected getQuery()

addToQuery($query)

Parameters

$query

protected setupAutoSort()

protected executeBase()

protected setupSortByString()

protected setupAttributeSort()

filter($column, $value, $comparison = '=')

Adds a filter to this item list.

Parameters

$column
$value
$comparison

groupBy($key)

Parameters

$key

having($column, $value, $comparison = '=')

Parameters

$column
$value
$comparison

protected setupAttributeFilters($join)

Parameters

$join

filterByAttribute($column, $value, $comparison = '=')

Parameters

$column
$value
$comparison

__call($nm, $a)

Parameters

$nm
$a

setViewPagePermissionKeyHandle($pkHandle)

Parameters

$pkHandle

includeInactivePages()

ignorePermissions()

ignoreAliases()

includeSystemPages()

displayUnapprovedPages()

isIndexedSearch()

filterByKeywords($keywords, $simple = false)

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

Parameters

$keywords
$simple

filterByName($name, $exact = false)

Parameters

$name
$exact

filterByPath($path, $includeAllChildren = true)

Parameters

$path
$includeAllChildren

setupPermissions()

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

sortByRelevance()

sortByDisplayOrder()

Sorts this list by display order.

sortByDisplayOrderDescending()

Sorts this list by display order descending.

sortByCollectionIDAscending()

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.

Parameters

mixed $cParentID

filterByPageTypeID(mixed $ptID)

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

Parameters

mixed $ptID

filterByCollectionTypeID($ctID) deprecated

deprecated

Parameters

$ctID

filterByUserID(mixed $uID)

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

Parameters

mixed $uID

filterByIsApproved($cvIsApproved)

Parameters

$cvIsApproved

filterByIsAlias($ia)

Parameters

$ia

filterByPageTypeHandle(mixed $ptHandle)

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

Parameters

mixed $ptHandle

filterByCollectionTypeHandle($ctHandle)

Parameters

$ctHandle

filterByDateAdded($date, $comparison = '=')

Filters by date added.

Parameters

$date
$comparison

filterByNumberOfChildren($num, $comparison = '>')

Parameters

$num
$comparison

filterByDateLastModified($date, $comparison = '=')

Parameters

$date
$comparison

filterByPublicDate($date, $comparison = '=')

Filters by public date.

Parameters

$date
$comparison

filterBySelectAttribute($akHandle, $value)

Parameters

$akHandle
$value

displayOnlyPermittedPages(bool $checkForPermissions)

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

Parameters

bool $checkForPermissions

protected setBaseQuery($additionalFields = '')

Parameters

$additionalFields

protected setupSystemPagesToExclude()

protected loadPageID($cID, $versionOrig = 'RECENT')

Parameters

$cID
$versionOrig