API docs     >     Pages and Sites     >     PageMgr

PageMgr->getList

Description

getList ( $pageId = 0, $filter = array(), $maxLevel = 0, $permissionsForRoleId = 0, $filterArray = array() )
Gets a list of Pages

Parameters

$pageId
int
(optional) Id of the parent Page from which the list will be created
$filter
array
(optional, may be combined) If SUBNODES, only subnodes of the specified Page will be returned
if TRASHCAN, only items in the Trash will be returned
if PUBLISHED, only live/published versions will be returned
$maxLevel
int
(optional) Specifies the maximum level of nodes to get
$permissionsForRoleId
int
(optional) If '1' then return all Usergroups and Permissions for this node
$filterArray
array
Array of filters for the SQL query

Returns

array|false
Array of Pages or FALSE in case of an error
  1. Array(                                  array Array of n Pages
  2.     [0] => Array(
  3.         [LFT] => 1                      int Id of the left node in the nested set tree structure
  4.         [RGT] => 6                      int Id of the right node in the nested set tree structure
  5.         [VERSIONPUBLISHED] => 0         int Published version (either a specific version or 999999 if set to 'ALWAYS_LATEST_APPROVED_VERSION')
  6.         [ID] => 1                       int Id
  7.         [LEVEL] => 1                    int Level in tree
  8.         [PARENT] => 0                   int Parent Id
  9.         [PNAME] => 'homepage'           string Permanent name
  10.         [VERSION] => 0                  int Version
  11.         [ACTIVE] => 1                   int 1 if active, 0 if inactive
  12.         [HIDDEN] => 0                   int 1 if hidden, 0 if visible
  13.         [LOCKED] => 0                   int 1 if locked by an User, 0 if not
  14.         [NAVIGATIONID] => 0             int Navigation Id
  15.         [HASCHANGED] => 0               int 1 if changed since last approval, 0 if not
  16.         [TEMPLATEID] => 1               int Template Id
  17.         [CREATEDTS] => 0                int Timestamp of the creation
  18.         [CHANGEDTS] => 0                int Timestamp of the last change
  19.         [CREATEDBY] => 1                int Id of the User who created the Object
  20.         [CHANGEDBY] => 0                int Id of the last User who touched the Object
  21.         [NAVIGATIONNAME] => 'Navi 1'    string Navigation name
  22.         [NAVIGATIONCODE] => 'navi_1'    string Navigation code
  23.         [OID] => 1                      int Id
  24.         [NAME] => 'Homepage'            string Name
  25.         [TITLE] => 'Homepage Title'     string Title (dynamic Property)
  26.         [DESCRIPTION] => 'Home Desc.'   string Description (dynamic Property)
  27.         [RREAD] => 1                    int 1 if User owns Permissions to read this Object, 0 if not
  28.         [RWRITE] => 1                   int 1 if User owns Permissions to write this Object, 0 if not
  29.         [RDELETE] => 1                  int 1 if User owns Permissions to delete this Object, 0 if not
  30.         [RSUB] => 1                     int 1 if User owns Permissions to create subnodes under this Object, 0 if not
  31.         [RSTAGE] => 1                   int 1 if User owns Permissions to publish/approve this Object, 0 if not
  32.         [RMODERATE] => 1                int 1 if User owns Permissions to moderate Comments of this Object, 0 if not
  33.         [RCOMMENT] => 1                 int 1 if User owns Permissions to add Comments to this Object, 0 if not
  34.         [LASTAPPROVED] => 0             int Latest approved version
  35.         [SELECTED] => 1                 int 1 if node is the current node, 0 if not
  36.         [SUBOPEN] => 1                  int 1 if node has opened subnodes, 0 if not
  37.         [CHILDREN] => 2                 int Count of children of this node or NULL
  38.         [FIRST] => 0                    int 1 if node is the first node on the current level, 0 if not
  39.         [LAST] => 1                     int 1 if node is the last node on the current level, 0 if not
  40.         [HASSUBNODES] => 1              int 1 if node has subnodes, 0 if not
  41.     )
  42.     ...
  43. )