eZPublish  4.5
eZContentStructureTreeOperator Class Reference

Public Member Functions

 eZContentStructureTreeOperator ($name= 'content_structure_tree')
 
 modify ($tpl, $operatorName, $operatorParameters, $rootNamespace, $currentNamespace, &$operatorValue, $namedParameters)
 
 namedParameterList ()
 
 operatorList ()
 

Static Public Member Functions

 contentStructureTree ($rootNodeID, $classFilter, $maxDepth, $maxNodes, $sortArray, $fetchHidden, $unfoldNodeID)
 
 subTree ($params, $nodeID, $countChildren=false)
 

Public Attributes

 $Operators
 

Static Private Member Functions

 children (&$contentTree, &$classFilter, &$depthLeft, &$nodesLeft, &$sortBy, $fetchHidden, $unfoldNodeID)
 
 createContentStructureNode (&$treeNode, $childrenCount)
 
 initContentStructureTree ($rootNodeID, $fetchHidden, $classFilter=false)
 
 oneLevelChildren (&$contentTree, &$classFilter, &$sortBy, &$nodesLeft, $fetchHidden)
 

Member Function Documentation

eZContentStructureTreeOperator::children ( $contentTree,
$classFilter,
$depthLeft,
$nodesLeft,
$sortBy,
  $fetchHidden,
  $unfoldNodeID 
)
staticprivate

Creates a tree of content by recursive calls to children and oneLevelChildren. $contentTree is a tree at previous call to children. $classFilter is an array of class ids. Only nodes of these classes will be fetched from db. $depthLeft determines a depth of recursion. $nodesLeft determines a number of nodes which are left to fetch. $sortBy is a method of sorting one-level children. $fetchHidden - should or not fetch unpublished/hidden nodes

Referenced by contentStructureTree().

eZContentStructureTreeOperator::contentStructureTree (   $rootNodeID,
  $classFilter,
  $maxDepth,
  $maxNodes,
  $sortArray,
  $fetchHidden,
  $unfoldNodeID 
)
static

a tree of content structure: tree = array( tree_node, children ), where 'tree_node' is array( 'node' => info about node, 'object' => info about object );

'children' is array( tree_node, children );

Referenced by modify().

eZContentStructureTreeOperator::createContentStructureNode ( $treeNode,
  $childrenCount 
)
staticprivate

Creates a node of content structure tree and sets up attributes of node using $treeNode to retrieve necessary data.

Returns
new content structure tree node.

Referenced by oneLevelChildren().

eZContentStructureTreeOperator::eZContentStructureTreeOperator (   $name = 'content_structure_tree')
eZContentStructureTreeOperator::initContentStructureTree (   $rootNodeID,
  $fetchHidden,
  $classFilter = false 
)
staticprivate

Initializes a tree: creates root node.

Returns
a tree with one node and empty children subtree.

Referenced by contentStructureTree().

eZContentStructureTreeOperator::modify (   $tpl,
  $operatorName,
  $operatorParameters,
  $rootNamespace,
  $currentNamespace,
$operatorValue,
  $namedParameters 
)
eZContentStructureTreeOperator::namedParameterList ( )
eZContentStructureTreeOperator::oneLevelChildren ( $contentTree,
$classFilter,
$sortBy,
$nodesLeft,
  $fetchHidden 
)
staticprivate

Parameters the same as in children. one-level children.

Referenced by children().

eZContentStructureTreeOperator::operatorList ( )

Returns the operators in this class.

eZContentStructureTreeOperator::subTree (   $params,
  $nodeID,
  $countChildren = false 
)
static

Returns one-level children of node $nodeID if $countChildren = false, othewise returns count of one-level children of node nodeID.

Referenced by oneLevelChildren().

Member Data Documentation

eZContentStructureTreeOperator::$Operators

Referenced by operatorList().


The documentation for this class was generated from the following file: