Varien_Data_Tree_Dbp Class Reference

Inheritance diagram for Varien_Data_Tree_Dbp:

List of all members.

Public Member Functions
	__construct ($connection, $table, $fields)
	getDbSelect ()
	setDbSelect ($select)
	load ($parentNode=null, $recursionLevel=0)
	addChildNodes ($children, $path, $parentNode, $level=0)
	loadNode ($nodeId)
	getChildren ($node, $recursive=true, $result=array())
	move ($node, $newParent, $prevNode=null)
	loadEnsuredNodes ($category, $rootNode)
Public Attributes
const	ID_FIELD = 'id'
const	PATH_FIELD = 'path'
const	ORDER_FIELD = 'order'
const	LEVEL_FIELD = 'level'
Protected Member Functions
	_addChildNodes ($children, $path, $parentNode, $withChildren=false, $level=0)
Protected Attributes
	$_conn
	$_table
	$_loaded = false
	$_select
	$_idField
	$_pathField
	$_orderField
	$_levelField

---

Detailed Description

Definition at line 38 of file Dbp.php.

---

Constructor & Destructor Documentation

__construct	(	$	connection,
		$	table,
		$	fields
	)

Db tree constructor

$fields = array( Varien_Data_Tree_Dbp.ID_FIELD => string, Varien_Data_Tree_Dbp.PATH_FIELD => string, Varien_Data_Tree_Dbp.ORDER_FIELD => string Varien_Data_Tree_Dbp.LEVEL_FIELD => string )

Parameters:

	Zend_Db_Adapter_Abstract	$connection
	string	$table
	array	$fields

Definition at line 93 of file Dbp.php.

    {
        parent::__construct();

        if (!$connection) {
            throw new Exception('Wrong "$connection" parametr');
        }

        $this->_conn    = $connection;
        $this->_table   = $table;

        if (!isset($fields[self::ID_FIELD]) ||
            !isset($fields[self::PATH_FIELD]) ||
            !isset($fields[self::LEVEL_FIELD]) ||
            !isset($fields[self::ORDER_FIELD])) {

            throw new Exception('"$fields" tree configuratin array');
        }

        $this->_idField     = $fields[self::ID_FIELD];
        $this->_pathField   = $fields[self::PATH_FIELD];
        $this->_orderField  = $fields[self::ORDER_FIELD];
        $this->_levelField  = $fields[self::LEVEL_FIELD];

        $this->_select  = $this->_conn->select();
        $this->_select->from($this->_table);
    }

---

Member Function Documentation

_addChildNodes	(	$	children,
		$	path,
		$	parentNode,
		$	withChildren = false,
		$	level = 0
	)			[protected]

Definition at line 346 of file Dbp.php.

    {
        if (isset($children[$path])) {
            foreach ($children[$path] as $child) {
                $nodeId = isset($child[$this->_idField])?$child[$this->_idField]:false;
                if ($parentNode && $nodeId && $node = $parentNode->getChildren()->searchById($nodeId)) {
                    $node->addData($child);
                } else {
                    $node = new Varien_Data_Tree_Node($child, $this->_idField, $this, $parentNode);
                    $node->setLevel($node->getData($this->_levelField));
                    $node->setPathId($node->getData($this->_pathField));
                    $this->addNode($node, $parentNode);
                }

                if ($withChildren) {
                    $this->_loaded = false;
                    $node->loadChildren(1);
                    $this->_loaded = false;
                }

                if ($path) {
                    $childrenPath = explode('/', $path);
                } else {
                    $childrenPath = array();
                }
                $childrenPath[] = $node->getId();
                $childrenPath = implode('/', $childrenPath);

                $this->_addChildNodes($children, $childrenPath, $node, $withChildren, $level+1);
            }
        }
    }

addChildNodes	(	$	children,
		$	path,
		$	parentNode,
		$	level = 0
	)

Definition at line 189 of file Dbp.php.

    {
        if (isset($children[$path])) {
            foreach ($children[$path] as $child) {
                $nodeId = isset($child[$this->_idField])?$child[$this->_idField]:false;
                if ($parentNode && $nodeId && $node = $parentNode->getChildren()->searchById($nodeId)) {
                    $node->addData($child);
                } else {
                    $node = new Varien_Data_Tree_Node($child, $this->_idField, $this, $parentNode);
                }

                //$node->setLevel(count(explode('/', $node->getData($this->_pathField)))-1);
                $node->setLevel($node->getData($this->_levelField));
                $node->setPathId($node->getData($this->_pathField));
                $this->addNode($node, $parentNode);


                if ($path) {
                    $childrenPath = explode('/', $path);
                } else {
                    $childrenPath = array();
                }
                $childrenPath[] = $node->getId();
                $childrenPath = implode('/', $childrenPath);

                $this->addChildNodes($children, $childrenPath, $node, $level+1);
            }
        }
    }

getChildren	(	$	node,
		$	recursive = true,
		$	result = array()
	)

Definition at line 240 of file Dbp.php.

                                                                             {
        if (is_numeric($node)) {
            $node = $this->getNodeById($node);
        }
        if (!$node)
            return $result;

        foreach ($node->getChildren() as $child) {
            if ($recursive) {
                if ($child->getChildren()) {
                    $result = $this->getChildren($child, $recursive, $result);
                }
            }
            $result[] = $child->getId();
        }
        return $result;
    }

getDbSelect

(

)

Definition at line 121 of file Dbp.php.

    {
        return $this->_select;
    }

load	(	$	parentNode = null,
		$	recursionLevel = 0
	)

Load tree

Parameters:

int|Varien_Data_Tree_Node

$parentNode

Returns:

Varien_Data_Tree_Dbp

Definition at line 137 of file Dbp.php.

    {
        if (!$this->_loaded) {
            $startLevel = 1;
            $parentPath = '';

            if ($parentNode instanceof Varien_Data_Tree_Node) {
                $parentPath = $parentNode->getData($this->_pathField);
                $startLevel = $parentNode->getData($this->_levelField);
            } elseif (is_numeric($parentNode)) {
                $parentNode = null;
                $select = $this->_conn->select();
                $select->from($this->_table, array($this->_pathField, $this->_levelField))->where("{$this->_idField} = ?", $parentNode);
                $parent = $this->_conn->fetchRow($select);
                $startLevel = $parent[$this->_levelField];
                $parentPath = $parent[$this->_pathField];
            } elseif (is_string($parentNode)) {
                $parentNode = null;
                $parentPath = $parentNode;
                $startLevel = count(explode($parentPath))-1;
            }

            $select = clone $this->_select;
            $select->order($this->_table.'.'.$this->_orderField . ' ASC');

            if ($parentPath) {
                $condition = $this->_conn->quoteInto("$this->_table.$this->_pathField like ?", "$parentPath/%");
                $select->where($condition);
            }
            if ($recursionLevel != 0) {
                $select->where("$this->_levelField <= ?", $startLevel + $recursionLevel);
            }

            $arrNodes = $this->_conn->fetchAll($select);

            $childrenItems = array();

            foreach ($arrNodes as $nodeInfo) {
                $pathToParent = explode('/', $nodeInfo[$this->_pathField]);
                array_pop($pathToParent);
                $pathToParent = implode('/', $pathToParent);
                $childrenItems[$pathToParent][] = $nodeInfo;
            }

            $this->addChildNodes($childrenItems, $parentPath, $parentNode);

            $this->_loaded = true;
        }

        return $this;
    }

loadEnsuredNodes	(	$	category,
		$	rootNode
	)

Definition at line 312 of file Dbp.php.

    {
        $pathIds = $category->getPathIds();
        $rootNodeId = $rootNode->getId();
        $rootNodePath = $rootNode->getData($this->_pathField);

        $select = clone $this->_select;
        $select->order($this->_table.'.'.$this->_orderField . ' ASC');

        if ($pathIds) {
            $condition = $this->_conn->quoteInto("$this->_table.$this->_idField in (?)", $pathIds);
            $select->where($condition);
        }

        $arrNodes = $this->_conn->fetchAll($select);

        if ($arrNodes) {
            $childrenItems = array();
            foreach ($arrNodes as $nodeInfo) {
                $nodeId = $nodeInfo[$this->_idField];
                if ($nodeId<=$rootNodeId) {
                    continue;
                }

                $pathToParent = explode('/', $nodeInfo[$this->_pathField]);
                array_pop($pathToParent);
                $pathToParent = implode('/', $pathToParent);
                $childrenItems[$pathToParent][] = $nodeInfo;
            }

            $this->_addChildNodes($childrenItems, $rootNodePath, $rootNode, true);
        }
    }

loadNode

(

$

nodeId

)

Enter description here...

Parameters:

unknown_type

$nodeId

Returns:

Varien_Data_Tree_Node

Reimplemented from Varien_Data_Tree.

Definition at line 225 of file Dbp.php.

    {
        $select = clone $this->_select;
        if (is_numeric($nodeId))
            $condition = $this->_conn->quoteInto("$this->_table.$this->_idField=?", $nodeId);
        else
            $condition = $this->_conn->quoteInto("$this->_table.$this->_pathField=?", $nodeId);

        $select->where($condition);

        $node = new Varien_Data_Tree_Node($this->_conn->fetchRow($select), $this->_idField, $this);
        $this->addNode($node);
        return $node;
    }

move	(	$	node,
		$	newParent,
		$	prevNode = null
	)

Move tree node

Parameters:

	Varien_Data_Tree_Node	$node
	Varien_Data_Tree_Node	$newParent
	Varien_Data_Tree_Node	$prevNode

Reimplemented in Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree.

Definition at line 265 of file Dbp.php.

    {
        $position = 1;

        $oldPath = $node->getData($this->_pathField);
        $newPath = $newParent->getData($this->_pathField);

        $newPath = $newPath . '/' . $node->getId();
        $oldPathLength = strlen($oldPath);

        $newLevel = $newParent->getLevel()+1;
        $levelDisposition = $newLevel-$node->getLevel();

        $data = array(
            $this->_levelField => new Zend_Db_Expr("{$this->_levelField} + '{$levelDisposition}'"),
            $this->_pathField  => new Zend_Db_Expr("CONCAT('$newPath', RIGHT($this->_pathField, LENGTH($this->_pathField) - {$oldPathLength}))")
        );
        $condition = $this->_conn->quoteInto("$this->_pathField REGEXP ?", "^$oldPath(/|$)");

        $this->_conn->beginTransaction();

        $reorderData = array($this->_orderField => new Zend_Db_Expr("$this->_orderField + 1"));
        try {
            if ($prevNode && $prevNode->getId()) {
                $reorderCondition = "{$this->_orderField} > {$prevNode->getData($this->_orderField)}";
                $position = $prevNode->getData($this->_orderField) + 1;
            } else {
                $reorderCondition = $this->_conn->quoteInto("{$this->_pathField} REGEXP ?", "^{$newParent->getData($this->_pathField)}/[0-9]+$");
                $select = $this->_conn->select()
                    ->from($this->_table, new Zend_Db_Expr("MIN({$this->_orderField})"))
                    ->where($reorderCondition);

                $position = (int) $this->_conn->fetchOne($select);
            }
            $this->_conn->update($this->_table, $reorderData, $reorderCondition);
            $this->_conn->update($this->_table, $data, $condition);
            $this->_conn->update($this->_table, array($this->_orderField => $position, $this->_levelField=>$newLevel),
                $this->_conn->quoteInto("{$this->_idField} = ?", $node->getId())
            );

            $this->_conn->commit();
        } catch (Exception $e){
            $this->_conn->rollBack();
            throw new Exception("Can't move tree node due to error: " . $e->getMessage());
        }
    }

setDbSelect

(

$

select

)

Definition at line 126 of file Dbp.php.

    {
        $this->_select = $select;
    }

---

Member Data Documentation

$_conn [protected]

Definition at line 51 of file Dbp.php.

$_idField [protected]

Definition at line 74 of file Dbp.php.

$_levelField [protected]

Definition at line 77 of file Dbp.php.

$_loaded = false [protected]

Definition at line 60 of file Dbp.php.

$_orderField [protected]

Definition at line 76 of file Dbp.php.

$_pathField [protected]

Definition at line 75 of file Dbp.php.

$_select [protected]

Definition at line 67 of file Dbp.php.

$_table [protected]

Definition at line 58 of file Dbp.php.

const ID_FIELD = 'id'

Definition at line 41 of file Dbp.php.

const LEVEL_FIELD = 'level'

Definition at line 44 of file Dbp.php.

const ORDER_FIELD = 'order'

Definition at line 43 of file Dbp.php.

const PATH_FIELD = 'path'

Definition at line 42 of file Dbp.php.

---

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

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