Tree Class Reference

Inheritance diagram for Tree:

Public Member Functions
	__construct ()
	getTree ()
	load ($parentNode=null)
	loadNode ($nodeId)
	appendChild ($data, $parentNode, $prevNode=null)
	addNode ($node, $parent=null)
	moveNodeTo ($node, $parentNode, $prevNode=null)
	copyNodeTo ($node, $parentNode, $prevNode=null)
	removeNode ($node)
	createNode ($parentNode, $prevNode=null)
	getChild ($node)
	getChildren ($node)
	getNodes ()
	getNodeById ($nodeId)
	getPath ($node)

Protected Attributes
	$_nodes

Detailed Description

Data tree

@api

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Since

100.0.2

Definition at line 18 of file Tree.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Enter description here...

Definition at line 31 of file Tree.php.

    {
        $this->_nodes = new NodeCollection($this);
    }

Member Function Documentation

addNode()

addNode	(		$node,
			$parent = null
	)

Add node

Parameters

Node	$node
Node	$parent

Returns

Node

Definition at line 94 of file Tree.php.

    {
        $this->_nodes->add($node);
        $node->setParent($parent);
        if ($parent !== null && $parent instanceof Node) {
            $parent->addChild($node);
        }
        return $node;
    }

appendChild()

appendChild	(		$data,
			$parentNode,
			$prevNode = null
	)

Append child

Parameters

array | Node	$data
Node	$parentNode
Node	$prevNode

Returns

Node @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 77 of file Tree.php.

    {
        if (is_array($data)) {
            $node = $this->addNode(new Node($data, $parentNode->getIdField(), $this), $parentNode);
        } elseif ($data instanceof Node) {
            $node = $this->addNode($data, $parentNode);
        }
        return $node;
    }

copyNodeTo()

copyNodeTo	(		$node,
			$parentNode,
			$prevNode = null
	)

Copy node

Parameters

Node	$node
Node	$parentNode
Node	$prevNode

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 126 of file Tree.php.

    {
    }

createNode()

createNode	(		$parentNode,
			$prevNode = null
	)

Create node

Parameters

Node	$parentNode
Node	$prevNode

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 154 of file Tree.php.

    {
    }

getChild()

getChild

(

$node

)

Get child

Parameters

Node

$node

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 165 of file Tree.php.

    {
    }

getChildren()

getChildren

(

$node

)

Get children

Parameters

Node

$node

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 176 of file Tree.php.

    {
    }

getNodeById()

getNodeById

(

$nodeId

)

Enter description here...

Parameters

Node

$nodeId

Returns

Node

Definition at line 196 of file Tree.php.

    {
        return $this->_nodes->searchById($nodeId);
    }

getNodes()

getNodes

(

)

Enter description here...

Returns

NodeCollection

Definition at line 185 of file Tree.php.

    {
        return $this->_nodes;
    }

getPath()

getPath

(

$node

)

Get path

Parameters

Node

$node

Returns

array

Definition at line 207 of file Tree.php.

    {
        if ($node instanceof Node) {
        } elseif (is_numeric($node)) {
            if ($_node = $this->getNodeById($node)) {
                return $_node->getPath();
            }
        }
        return [];
    }

getTree()

getTree

(

)

Enter description here...

Returns

\Magento\Framework\Data\Tree

Definition at line 41 of file Tree.php.

    {
        return $this;
    }

load()

load

(

$parentNode = null

)

Enter description here...

Parameters

Node

$parentNode

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 53 of file Tree.php.

    {
    }

loadNode()

loadNode

(

$nodeId

)

Enter description here...

Parameters

int | string

$nodeId

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 64 of file Tree.php.

    {
    }

moveNodeTo()

moveNodeTo	(		$node,
			$parentNode,
			$prevNode = null
	)

Move node

Parameters

Node	$node
Node	$parentNode
Node	$prevNode

Returns

void @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 113 of file Tree.php.

    {
    }

removeNode()

removeNode

(

$node

)

Remove node

Parameters

Node

$node

Returns

$this

Definition at line 136 of file Tree.php.

    {
        $this->_nodes->delete($node);
        if ($node->getParent()) {
            $node->getParent()->removeChild($node);
        }
        unset($node);
        return $this;
    }

Field Documentation

$_nodes

$_nodes

protected

Definition at line 25 of file Tree.php.

---

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

• vendor/magento/framework/Data/Tree.php