Varien_Data_Tree_Node Class Reference

Inheritance diagram for Varien_Data_Tree_Node:

List of all members.

Public Member Functions
	__construct ($data, $idFeild, $tree, $parent=null)
	getId ()
	setIdField ($idField)
	getIdField ()
	setTree (Varien_Data_Tree $tree)
	getTree ()
	setParent ($parent)
	getParent ()
	hasChildren ()
	setLevel ($level)
	setPathId ($path)
	isChildOf ($node)
	loadChildren ($recursionLevel=0)
	getChildren ()
	getAllChildNodes (&$nodes=array())
	getLastChild ()
	addChild ($node)
	appendChild ($prevNode=null)
	moveTo ($parentNode, $prevNode=null)
	copyTo ($parentNode, $prevNode=null)
	removeChild ($childNode)
	getPath (&$prevNodes=array())
	getIsActive ()
	getName ()
Protected Attributes
	$_parent
	$_tree
	$_childNodes
	$_idField

---

Detailed Description

Definition at line 34 of file Node.php.

---

Constructor & Destructor Documentation

__construct	(	$	data,
		$	idFeild,
		$	tree,
		$	parent = null
	)

Data tree node constructor

Parameters:

	array	$data
	string	$idFeild
	Varien_Data_Tree	$tree
	Varien_Data_Tree_Node	$parent

Definition at line 72 of file Node.php.

    {
        $this->setTree($tree);
        $this->setParent($parent);
        $this->setIdField($idFeild);
        $this->setData($data);
        $this->_childNodes = new Varien_Data_Tree_Node_Collection($this);
    }

---

Member Function Documentation

addChild

(

$

node

)

Add child node

Parameters:

Varien_Data_Tree_Node

$node

Returns:

Varien_Data_Tree_Node

Definition at line 226 of file Node.php.

    {
        $this->_childNodes->add($node);
        return $this;
    }

appendChild

(

$

prevNode = null

)

Definition at line 232 of file Node.php.

    {
        $this->_tree->appendChild($this, $prevNode);
        return $this;
    }

copyTo	(	$	parentNode,
		$	prevNode = null
	)

Definition at line 244 of file Node.php.

    {
        $this->_tree->copyNodeTo($this, $parentNode, $prevNode);
        return $this;
    }

getAllChildNodes

(

&$

nodes = array()

)

Definition at line 206 of file Node.php.

    {
        foreach ($this->_childNodes as $node) {
            $nodes[$node->getId()] = $node;
            $node->getAllChildNodes($nodes);
        }
        return $nodes;
    }

getChildren

(

)

Retrieve node children collection

Returns:

Varien_Data_Tree_Node_Collection

Definition at line 201 of file Node.php.

    {
        return $this->_childNodes;
    }

getId

(

)

Retrieve node id

Returns:

mixed

Reimplemented from Varien_Object.

Definition at line 86 of file Node.php.

    {
        return $this->getData($this->getIdField());
    }

getIdField

(

)

Retrieve node id field name

Returns:

string

Definition at line 108 of file Node.php.

    {
        return $this->_idField;
    }

getIsActive

(

)

Definition at line 265 of file Node.php.

    {
        return $this->_getData('is_active');
    }

getLastChild

(

)

Definition at line 215 of file Node.php.

    {
        return $this->_childNodes->lastNode();
    }

getName

(

)

Definition at line 270 of file Node.php.

    {
        return $this->_getData('name');
    }

getParent

(

)

Retrieve node parent

Returns:

Varien_Data_Tree

Definition at line 152 of file Node.php.

    {
        return $this->_parent;
    }

getPath

(

&$

prevNodes = array()

)

Definition at line 256 of file Node.php.

    {
        if ($this->_parent) {
            array_push($prevNodes, $this);
            $this->_parent->getPath($prevNodes);
        }
        return $prevNodes;
    }

getTree

(

)

Retrieve node tree object

Returns:

Varien_Data_Tree

Definition at line 130 of file Node.php.

    {
        return $this->_tree;
    }

hasChildren

(

)

Check node children

Returns:

bool

Definition at line 162 of file Node.php.

    {
        return $this->_childNodes->count() > 0;
    }

isChildOf

(

$

node

)

Definition at line 179 of file Node.php.

    {

    }

loadChildren

(

$

recursionLevel = 0

)

Load node children

Parameters:

int

$recursionLevel

Returns:

Varien_Data_Tree_Node

Definition at line 190 of file Node.php.

    {
        $this->_tree->load($this, $recursionLevel);
        return $this;
    }

moveTo	(	$	parentNode,
		$	prevNode = null
	)

Definition at line 238 of file Node.php.

    {
        $this->_tree->moveNodeTo($this, $parentNode, $prevNode);
        return $this;
    }

removeChild

(

$

childNode

)

Definition at line 250 of file Node.php.

    {
        $this->_childNodes->delete($childNode);
        return $this;
    }

setIdField

(

$

idField

)

Set node id field name

Parameters:

string

$idField

Returns:

this

Definition at line 97 of file Node.php.

    {
        $this->_idField = $idField;
        return $this;
    }

setLevel

(

$

level

)

Definition at line 167 of file Node.php.

    {
        $this->setData('level', $level);
        return $this;
    }

setParent

(

$

parent

)

Set node parent

Parameters:

Varien_Data_Tree_Node

$parent

Returns:

Varien_Data_Tree_Node

Definition at line 141 of file Node.php.

    {
        $this->_parent = $parent;
        return $this;
    }

setPathId

(

$

path

)

Definition at line 173 of file Node.php.

    {
        $this->setData('path_id', $path);
        return $this;
    }

setTree

(

Varien_Data_Tree $

tree

)

Set node tree object

Parameters:

Varien_Data_Tree

$tree

Returns:

this

Definition at line 119 of file Node.php.

    {
        $this->_tree = $tree;
        return $this;
    }

---

Member Data Documentation

$_childNodes [protected]

Definition at line 55 of file Node.php.

$_idField [protected]

Definition at line 62 of file Node.php.

$_parent [protected]

Definition at line 41 of file Node.php.

$_tree [protected]

Definition at line 48 of file Node.php.

---

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

• lib/Varien/Data/Tree/Node.php