API docs     >     General     >     Tags

Tags->getList

Description

getList ( $tagId = 0, $filter = array(), $usergroups = true, $maxLevel = 0, $usergroupId = 0 )
Gets a list of Tags

Parameters

$tagId
int
(optional) Id of the parent Tag from which the list will be created
$filter
array
(optional) If SUBNODES, only subnodes of the specified Tag will be returned
$usergroups
bool
(optional) If TRUE then also returns all Usergroups and Permissions for this node
$maxLevel
int
(optional) Specifies the maximum level of nodes to get
$usergroupId
int
(optional) If specified, only returns the list for the specific Usergroup Id

Returns

array|false
Array of Tags or FALSE in case of an error
  1. Array(                              array Array of n Tags
  2.     [0] => Array(
  3.         [LFT] => 1                  int Id of the left node in the nested set tree structure
  4.         [RGT] => 10                 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.         [NAME] => 'Tags'            string Name
  10.         [RREAD] => 1                int 1 if User owns Permissions to read this Object, 0 if not
  11.         [RWRITE] => 1               int 1 if User owns Permissions to write this Object, 0 if not
  12.         [RDELETE] => 1              int 1 if User owns Permissions to delete this Object, 0 if not
  13.         [RSUB] => 1                 int 1 if User owns Permissions to create subnodes under this Object, 0 if not
  14.         [RSTAGE] => 1               int 1 if User owns Permissions to publish/approve this Object, 0 if not
  15.         [SELECTED] => 1             int 1 if selected, 0 if not
  16.         [SHOW] => 1                 int 1 1 if node is currently visible in the tree, 0 if not
  17.         [SUBOPEN] => 1              int 1 if node has opened subnodes, 0 if not
  18.         [FIRST] => 1                int 1 if node is the first node on the current level, 0 if not
  19.         [LAST] => 0                 int 1 if node is the last node on the current level, 0 if not
  20.         [HASSUBNODES] => 1          int 1 if node has subnodes, 0 if not
  21.     )
  22.     ...
  23. )