‪TYPO3CMS  10.4
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Tree\TreeNode Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Tree\TreeNode:
TYPO3\CMS\Backend\Tree\ComparableNodeInterface TYPO3\CMS\Backend\Tree\TreeRepresentationNode TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode

Public Member Functions

 __construct (array $data=[])
 
 setChildNodes (TreeNodeCollection $childNodes)
 
 removeChildNodes ()
 
TYPO3 CMS Backend Tree TreeNodeCollection getChildNodes ()
 
bool hasChildNodes ()
 
 setId ($id)
 
string getId ()
 
 setParentNode (\TYPO3\CMS\Backend\Tree\TreeNode $parentNode=null)
 
TYPO3 CMS Backend Tree TreeNode getParentNode ()
 
bool equals (\TYPO3\CMS\Backend\Tree\TreeNode $other)
 
int compareTo ($other)
 
array toArray ($addChildNodes=true)
 
 dataFromArray ($data)
 
string serialize ()
 
 unserialize ($serializedString)
 

Protected Attributes

string $id = ''
 
TYPO3 CMS Backend Tree TreeNode $parentNode
 
TYPO3 CMS Backend Tree TreeNodeCollection $childNodes
 

Detailed Description

Tree Node

Definition at line 24 of file TreeNode.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Tree\TreeNode::__construct ( array  $data = [])

Constructor

You can move an initial data array to initialize the instance and further objects. This is useful for the deserialization.

Parameters
array$data

Definition at line 52 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray().

Member Function Documentation

◆ compareTo()

int TYPO3\CMS\Backend\Tree\TreeNode::compareTo (   $other)

Compares a node to another one.

Returns: 1 if its greater than the other one -1 if its smaller than the other one 0 if its equal

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode$other
Returns
‪int See description above

Implements TYPO3\CMS\Backend\Tree\ComparableNodeInterface.

Reimplemented in TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode.

Definition at line 165 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\equals().

Referenced by TYPO3\CMS\Backend\Tree\TreeNodeCollection\nodeCompare().

◆ dataFromArray()

TYPO3\CMS\Backend\Tree\TreeNode::dataFromArray (   $data)

Sets data of the node by a given data array

Parameters
array$data

Reimplemented in TYPO3\CMS\Backend\Tree\TreeRepresentationNode.

Definition at line 203 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$childNodes, TYPO3\CMS\Backend\Tree\TreeNode\$parentNode, TYPO3\CMS\Backend\Tree\TreeNode\setChildNodes(), TYPO3\CMS\Backend\Tree\TreeNode\setId(), and TYPO3\CMS\Backend\Tree\TreeNode\setParentNode().

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\__construct(), and TYPO3\CMS\Backend\Tree\TreeNode\unserialize().

◆ equals()

bool TYPO3\CMS\Backend\Tree\TreeNode::equals ( \TYPO3\CMS\Backend\Tree\TreeNode  $other)

Compares a node if it's identical to another node by the id property.

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode$other
Returns
‪bool

Definition at line 149 of file TreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode\compareTo(), and TYPO3\CMS\Backend\Tree\TreeNode\compareTo().

◆ getChildNodes()

TYPO3 CMS Backend Tree TreeNodeCollection TYPO3\CMS\Backend\Tree\TreeNode::getChildNodes ( )

Returns child nodes collection

Returns
‪\TYPO3\CMS\Backend\Tree\TreeNodeCollection

Definition at line 85 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$childNodes.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode(), TYPO3\CMS\Backend\Tree\Renderer\UnorderedListTreeRenderer\renderNode(), and TYPO3\CMS\Core\Tree\TableConfiguration\ArrayTreeRenderer\renderNode().

◆ getId()

string TYPO3\CMS\Backend\Tree\TreeNode::getId ( )

Returns the identifier

Returns
‪string

Definition at line 118 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$id.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenOf(), TYPO3\CMS\Core\Tree\TableConfiguration\ArrayTreeRenderer\getNodeArray(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\isExpanded().

◆ getParentNode()

TYPO3 CMS Backend Tree TreeNode TYPO3\CMS\Backend\Tree\TreeNode::getParentNode ( )

Returns the parent node

Returns
‪\TYPO3\CMS\Backend\Tree\TreeNode

Definition at line 138 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$parentNode.

◆ hasChildNodes()

bool TYPO3\CMS\Backend\Tree\TreeNode::hasChildNodes ( )

Returns TRUE if the node has child nodes attached

Returns
‪bool

Definition at line 95 of file TreeNode.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode(), TYPO3\CMS\Core\Tree\TableConfiguration\ArrayTreeRenderer\getNodeArray(), TYPO3\CMS\Core\Tree\TableConfiguration\ArrayTreeRenderer\renderNode(), and TYPO3\CMS\Backend\Tree\TreeNode\toArray().

◆ removeChildNodes()

TYPO3\CMS\Backend\Tree\TreeNode::removeChildNodes ( )

Removes child nodes collection

Definition at line 72 of file TreeNode.php.

◆ serialize()

string TYPO3\CMS\Backend\Tree\TreeNode::serialize ( )

Returns the serialized instance

Returns
‪string

Definition at line 223 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\toArray().

◆ setChildNodes()

TYPO3\CMS\Backend\Tree\TreeNode::setChildNodes ( TreeNodeCollection  $childNodes)

Sets the child nodes collection

Parameters
\TYPO3\CMS\Backend\Tree\TreeNodeCollection$childNodes

Definition at line 64 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$childNodes.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenOf().

◆ setId()

TYPO3\CMS\Backend\Tree\TreeNode::setId (   $id)

Sets the identifier

Parameters
string$id

Definition at line 108 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$id.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenOf().

◆ setParentNode()

TYPO3\CMS\Backend\Tree\TreeNode::setParentNode ( \TYPO3\CMS\Backend\Tree\TreeNode  $parentNode = null)

Sets the parent node

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode | null$parentNode

Definition at line 128 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$parentNode.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray().

◆ toArray()

array TYPO3\CMS\Backend\Tree\TreeNode::toArray (   $addChildNodes = true)

Returns the node in an array representation that can be used for serialization

Parameters
bool$addChildNodes
Returns
‪array

Reimplemented in TYPO3\CMS\Backend\Tree\TreeRepresentationNode.

Definition at line 179 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\$id, and TYPO3\CMS\Backend\Tree\TreeNode\hasChildNodes().

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\serialize().

◆ unserialize()

TYPO3\CMS\Backend\Tree\TreeNode::unserialize (   $serializedString)

Fills the current node with the given serialized informations

Exceptions

Definition at line 234 of file TreeNode.php.

References TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray().

Member Data Documentation

◆ $childNodes

TYPO3 CMS Backend Tree TreeNodeCollection TYPO3\CMS\Backend\Tree\TreeNode::$childNodes
protected

Child Nodes

Definition at line 42 of file TreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray(), TYPO3\CMS\Backend\Tree\TreeNode\getChildNodes(), and TYPO3\CMS\Backend\Tree\TreeNode\setChildNodes().

◆ $id

string TYPO3\CMS\Backend\Tree\TreeNode::$id = ''
protected

Node Identifier

Definition at line 30 of file TreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\getId(), TYPO3\CMS\Backend\Tree\TreeNode\setId(), and TYPO3\CMS\Backend\Tree\TreeNode\toArray().

◆ $parentNode

TYPO3 CMS Backend Tree TreeNode TYPO3\CMS\Backend\Tree\TreeNode::$parentNode
protected

Parent Node

Definition at line 36 of file TreeNode.php.

Referenced by TYPO3\CMS\Backend\Tree\TreeNode\dataFromArray(), TYPO3\CMS\Backend\Tree\TreeNode\getParentNode(), and TYPO3\CMS\Backend\Tree\TreeNode\setParentNode().