TYPO3\CMS\Backend\Tree\TreeNode Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Tree\TreeNode:

Public Member Functions
	__construct (array $data=[])
	setChildNodes (TreeNodeCollection $childNodes)
	removeChildNodes ()
TreeNodeCollection	getChildNodes ()
bool	hasChildNodes ()
	setId ($id)
string int	getId ()
	setParentNode (TreeNode $parentNode=null)
TreeNode	getParentNode ()
bool	equals (TreeNode $other)
int	compareTo ($other)
	getAdditionalData ()
array	toArray ($addChildNodes=true)
	dataFromArray ($data)
	__serialize ()
	__unserialize (array $arrayRepresentation)

Protected Attributes
string int	$id = ''
TreeNode null	$parentNode
TreeNodeCollection null	$childNodes
array	$additionalData = []

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 57 of file TreeNode.php.

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

Member Function Documentation

__serialize()

TYPO3\CMS\Backend\Tree\TreeNode::__serialize

(

)

Returns class state to be serialized.

Definition at line 233 of file TreeNode.php.

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

__unserialize()

TYPO3\CMS\Backend\Tree\TreeNode::__unserialize

(

array

$arrayRepresentation

)

Fills the current node with the given serialized information

Exceptions

Exception

‪if the deserialized object type is not identical to the current one

Definition at line 243 of file TreeNode.php.

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

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

TreeNode

$other

Returns

‪int See description above

Implements TYPO3\CMS\Backend\Tree\ComparableNodeInterface.

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

Definition at line 167 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 213 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

(

TreeNode

$other

)

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

Returns

‪bool

Definition at line 151 of file TreeNode.php.

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

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

getAdditionalData()

TYPO3\CMS\Backend\Tree\TreeNode::getAdditionalData

(

)

This is part of the category tree performance hack

Definition at line 178 of file TreeNode.php.

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

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode().

getChildNodes()

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

(

)

Returns child nodes collection

Returns

‪TreeNodeCollection

Definition at line 88 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 int TYPO3\CMS\Backend\Tree\TreeNode::getId

(

)

Returns the identifier

Returns

‪string|int

Definition at line 121 of file TreeNode.php.

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

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

getParentNode()

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

(

)

Returns the parent node

Returns

‪TreeNode

Definition at line 141 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 98 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 75 of file TreeNode.php.

setChildNodes()

TYPO3\CMS\Backend\Tree\TreeNode::setChildNodes

(

TreeNodeCollection

$childNodes

)

Sets the child nodes collection

Definition at line 67 of file TreeNode.php.

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

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

setId()

TYPO3\CMS\Backend\Tree\TreeNode::setId

(

$id

)

Sets the identifier

Parameters

string | int

$id

Definition at line 111 of file TreeNode.php.

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

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

setParentNode()

TYPO3\CMS\Backend\Tree\TreeNode::setParentNode

(

TreeNode

$parentNode = null

)

Sets the parent node

Parameters

TreeNode | null

$parentNode

Definition at line 131 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 189 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().

Member Data Documentation

$additionalData

array TYPO3\CMS\Backend\Tree\TreeNode::$additionalData = []

protected

This is part of the category tree performance hack.

Definition at line 47 of file TreeNode.php.

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

$childNodes

TreeNodeCollection null 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 int 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

TreeNode null 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().