Public Member Functions | Public Attributes | Protected Attributes

BeTreeComponent Class Reference

Management of the tree of the contents. More...

List of all members.

Public Member Functions

 initialize (Controller $controller)
 Initialize BeTree component.
 cleanFilter ()
 clean filter
 getSectionsTree ()
 Tree of publications and sections for user connected.
 getPublicationTree ($id)
 Tree of a publication and sections for user connected.
 getAreaForSection ($section_id)
 get publication (area) data for the section $section_id
 expandOneBranch ($id=null)
 Get tree with one branch expanded (the branch where object $id is).
 getChildren ($id=null, $status=null, $filter=false, $order=null, $dir=true, $page=1, $dim=null, $excludeIds=array())
 Get children for node $id.
 getDescendants ($id=null, $status=null, $filter=false, $order=null, $dir=true, $page=1, $dim=null, $excludeIds=array())
 Return descendants of a tree node.
 getParents ($id=null, $area_id=null, $status=array())
 TODO: remove this method Array of parent objects of $id...
 updateTree ($id, $destination)
 TODO: remove this method.
 setupForSave ($objectId, &$destination=array())
 setup array of tree destinations (parent ids) if some parents is forbidden to user (backend_private permission) then add it to $destination because user can't edit that destination

Public Attributes

 $controller = null
 $filter = array()

Protected Attributes

 $Tree = null
 $BEObject = null
 $Section = null

Detailed Description

Management of the tree of the contents.

Permits with bits representation (bedita.ini.php): BEDITA_PERMS_READ 0x1 BEDITA_PERMS_MODIFY 0x2

Version:
$Revision$ $LastChangedBy$ $LastChangedDate$

$Id$

Definition at line 36 of file be_tree.php.


Member Function Documentation

BeTreeComponent::expandOneBranch ( id = null  ) 

Get tree with one branch expanded (the branch where object $id is).

Parameters:
integer $id
Returns:
array

Definition at line 123 of file be_tree.php.

References getSectionsTree().

BeTreeComponent::getAreaForSection ( section_id  ) 

get publication (area) data for the section $section_id

Parameters:
int $section_id
Returns:
array

Definition at line 110 of file be_tree.php.

BeTreeComponent::getChildren ( id = null,
status = null,
filter = false,
order = null,
dir = true,
page = 1,
dim = null,
excludeIds = array() 
)

Get children for node $id.

Parameters:
integer $id node ID
mixed $status
mixed $filter
mixed $order
boolean $dir
int $page
int $dim
array $excludeIds
Returns:
array

Definition at line 146 of file be_tree.php.

BeTreeComponent::getDescendants ( id = null,
status = null,
filter = false,
order = null,
dir = true,
page = 1,
dim = null,
excludeIds = array() 
)

Return descendants of a tree node.

Parameters:
integer $id node ID
mixed $status
mixed $filter
mixed $order
boolean $dir
int $page
int $dim
array $excludeIds
Returns:
array

Definition at line 171 of file be_tree.php.

BeTreeComponent::getParents ( id = null,
area_id = null,
status = array() 
)

TODO: remove this method Array of parent objects of $id...

Parameters:
integer $id
Returns:
array parents ids

Definition at line 190 of file be_tree.php.

BeTreeComponent::getPublicationTree ( id  ) 

Tree of a publication and sections for user connected.

Returns:
array

Definition at line 90 of file be_tree.php.

BeTreeComponent::getSectionsTree (  ) 

Tree of publications and sections for user connected.

Returns:
array

Definition at line 71 of file be_tree.php.

Referenced by expandOneBranch().

BeTreeComponent::initialize ( Controller $  controller  ) 

Initialize BeTree component.

Parameters:
Controller $controller

Definition at line 55 of file be_tree.php.

BeTreeComponent::setupForSave ( objectId,
&$  destination = array() 
)

setup array of tree destinations (parent ids) if some parents is forbidden to user (backend_private permission) then add it to $destination because user can't edit that destination

Parameters:
int $objectId
array $destination array of parent ids

Definition at line 213 of file be_tree.php.

BeTreeComponent::updateTree ( id,
destination 
)

TODO: remove this method.

Used only in some addons shell scripts update tree position of object $id with new $destination array

Parameters:
integer $id
array $destination

Definition at line 201 of file be_tree.php.


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:46 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus