Mage_Adminhtml_Block_Catalog_Category_Tree Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Catalog_Category_Tree:

List of all members.

Public Member Functions
	__construct ()
	getCategoryCollection ()
	getAddRootButtonHtml ()
	getAddSubButtonHtml ()
	getExpandButtonHtml ()
	getCollapseButtonHtml ()
	getStoreSwitcherHtml ()
	getLoadTreeUrl ($expanded=null)
	getNodesUrl ()
	getSwitchTreeUrl ()
	getIsWasExpanded ()
	getMoveUrl ()
	getTree ($parenNodeCategory=null)
	getTreeJson ($parenNodeCategory=null)
	getRootIds ()
	getBreadcrumbsJavascript ($path, $javascriptVarName)
	buildNodeName ($node)
	isClearEdit ()
	canAddRootCategory ()
	canAddSubCategory ()
Protected Member Functions
	_prepareLayout ()
	_getDefaultStoreId ()
	_getNodeJson ($node, $level=0)
	_isCategoryMoveable ($node)
	_isParentSelectedCategory ($node)
Protected Attributes
	$_withProductCount

---

Detailed Description

Definition at line 35 of file Tree.php.

---

Constructor & Destructor Documentation

__construct

(

)

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Mage_Adminhtml_Block_Catalog_Category_Abstract.

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Categories.

Definition at line 40 of file Tree.php.

    {
        parent::__construct();
        $this->setTemplate('catalog/category/tree.phtml');
        $this->setUseAjax(true);
        $this->_withProductCount = true;
    }

---

Member Function Documentation

_getDefaultStoreId

(

)

[protected]

Definition at line 87 of file Tree.php.

    {
        return Mage_Catalog_Model_Abstract::DEFAULT_STORE_ID;
    }

_getNodeJson	(	$	node,
		$	level = 0
	)			[protected]

Get JSON of a tree node or an associative array

Parameters:

	Varien_Data_Tree_Node|array	$node
	int	$level

Returns:

string

Reimplemented in Mage_Adminhtml_Block_Catalog_Category_Checkboxes_Tree, and Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Categories.

Definition at line 226 of file Tree.php.

    {
        // create a node from data array
        if (is_array($node)) {
            $node = new Varien_Data_Tree_Node($node, 'entity_id', new Varien_Data_Tree);
        }

        $item = array();
        $item['text'] = $this->buildNodeName($node);

        //$rootForStores = Mage::getModel('core/store')->getCollection()->loadByCategoryIds(array($node->getEntityId()));
        $rootForStores = in_array($node->getEntityId(), $this->getRootIds());

        $item['id']  = $node->getId();
        $item['store']  = (int) $this->getStore()->getId();
        $item['path'] = $node->getData('path');

        $item['cls'] = 'folder ' . ($node->getIsActive() ? 'active-category' : 'no-active-category');
        //$item['allowDrop'] = ($level<3) ? true : false;
        $allowMove = $this->_isCategoryMoveable($node);
        $item['allowDrop'] = $allowMove;
        // disallow drag if it's first level and category is root of a store
        $item['allowDrag'] = $allowMove && (($node->getLevel()==1 && $rootForStores) ? false : true);

        if ((int)$node->getChildrenCount()>0) {
            $item['children'] = array();
        }

        $isParent = $this->_isParentSelectedCategory($node);

        if ($node->hasChildren()) {
            $item['children'] = array();
            if (!($this->getUseAjax() && $node->getLevel() > 1 && !$isParent)) {
                foreach ($node->getChildren() as $child) {
                    $item['children'][] = $this->_getNodeJson($child, $level+1);
                }
            }
        }

        if ($isParent || $node->getLevel() < 2) {
            $item['expanded'] = true;
        }

        return $item;
    }

_isCategoryMoveable

(

$

node

)

[protected]

Definition at line 287 of file Tree.php.

    {
        $options = new Varien_Object(array(
            'is_moveable' => true,
            'category' => $node
        ));

        Mage::dispatchEvent('adminhtml_catalog_category_tree_is_moveable',
            array('options'=>$options)
        );

        return $options->getIsMoveable();
    }

_isParentSelectedCategory

(

$

node

)

[protected]

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Categories.

Definition at line 301 of file Tree.php.

    {
        if ($node && $this->getCategory()) {
            $pathIds = $this->getCategory()->getPathIds();
            if (in_array($node->getId(), $pathIds)) {
                return true;
            }
        }

        return false;
    }

_prepareLayout

(

)

[protected]

Preparing global layout

You can redefine this method in child classes for changin layout

Returns:

Mage_Core_Block_Abstract

Reimplemented from Mage_Core_Block_Abstract.

Reimplemented in Mage_Adminhtml_Block_Catalog_Category_Checkboxes_Tree.

Definition at line 48 of file Tree.php.

    {
        $addUrl = $this->getUrl("*/*/add", array(
            '_current'=>true,
            'id'=>null,
            '_query' => false
        ));

        if ($this->canAddSubCategory()) {
            $this->setChild('add_sub_button',
                $this->getLayout()->createBlock('adminhtml/widget_button')
                    ->setData(array(
                        'label'     => Mage::helper('catalog')->__('Add Subcategory'),
                        'onclick'   => "addNew('".$addUrl."', false)",
                        'class'     => 'add'
                    ))
            );
        }

        if ($this->canAddRootCategory()) {
            $this->setChild('add_root_button',
                $this->getLayout()->createBlock('adminhtml/widget_button')
                    ->setData(array(
                        'label'     => Mage::helper('catalog')->__('Add Root Category'),
                        'onclick'   => "addNew('".$addUrl."', true)",
                        'class'     => 'add',
                        'id'        => 'add_root_category_button'
                    ))
            );
        }

        $this->setChild('store_switcher',
            $this->getLayout()->createBlock('adminhtml/store_switcher')
                ->setSwitchUrl($this->getUrl('*/*/*', array('_current'=>true, '_query'=>false, 'store'=>null)))
                ->setTemplate('store/switcher/enhanced.phtml')
        );
        return parent::_prepareLayout();
    }

buildNodeName

(

$

node

)

Get category name

Parameters:

Varien_Object

$node

Returns:

string

Definition at line 278 of file Tree.php.

    {
        $result = $this->htmlEscape($node->getName());
        if ($this->_withProductCount) {
             $result .= ' (' . $node->getProductCount() . ')';
        }
        return $result;
    }

canAddRootCategory

(

)

Check availability of adding root category

Returns:

boolean

Definition at line 328 of file Tree.php.

    {
        $options = new Varien_Object(array('is_allow'=>true));
        Mage::dispatchEvent(
            'adminhtml_catalog_category_tree_can_add_root_category',
            array(
                'category' => $this->getCategory(),
                'options'   => $options,
                'store'    => $this->getStore()->getId()
            )
        );

        return $options->getIsAllow();
    }

canAddSubCategory

(

)

Check availability of adding sub category

Returns:

boolean

Definition at line 348 of file Tree.php.

    {
        $options = new Varien_Object(array('is_allow'=>true));
        Mage::dispatchEvent(
            'adminhtml_catalog_category_tree_can_add_sub_category',
            array(
                'category' => $this->getCategory(),
                'options'   => $options,
                'store'    => $this->getStore()->getId()
            )
        );

        return $options->getIsAllow();
    }

getAddRootButtonHtml

(

)

Definition at line 111 of file Tree.php.

    {
        return $this->getChildHtml('add_root_button');
    }

getAddSubButtonHtml

(

)

Definition at line 116 of file Tree.php.

    {
        return $this->getChildHtml('add_sub_button');
    }

getBreadcrumbsJavascript	(	$	path,
		$	javascriptVarName
	)

Get JSON of array of categories, that are breadcrumbs for specified category path

Parameters:

	string	$path
	string	$javascriptVarName

Returns:

string

Definition at line 201 of file Tree.php.

    {
        if (empty($path)) {
            return '';
        }
        $categories = Mage::getResourceSingleton('catalog/category_tree')->loadBreadcrumbsArray($path);
        if (empty($categories)) {
            return '';
        }
        foreach ($categories as $key => $category) {
            $categories[$key] = $this->_getNodeJson($category);
        }
        return
            '<script type="text/javascript">'
            . $javascriptVarName . ' = ' . Zend_Json::encode($categories) . ';'
            . '</script>';
    }

getCategoryCollection

(

)

Definition at line 92 of file Tree.php.

    {
        $storeId = $this->getRequest()->getParam('store', $this->_getDefaultStoreId());
        $collection = $this->getData('category_collection');
        if (is_null($collection)) {
            $collection = Mage::getModel('catalog/category')->getCollection();

            /* @var $collection Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Collection */
            $collection->addAttributeToSelect('name')
                ->addAttributeToSelect('is_active')
                ->setProductStoreId($storeId)
                ->setLoadProductCount($this->_withProductCount)
                ->setStoreId($storeId);

            $this->setData('category_collection', $collection);
        }
        return $collection;
    }

getCollapseButtonHtml

(

)

Definition at line 126 of file Tree.php.

    {
        return $this->getChildHtml('collapse_button');
    }

getExpandButtonHtml

(

)

Definition at line 121 of file Tree.php.

    {
        return $this->getChildHtml('expand_button');
    }

getIsWasExpanded

(

)

Definition at line 157 of file Tree.php.

    {
        return Mage::getSingleton('admin/session')->getIsTreeWasExpanded();
    }

getLoadTreeUrl

(

$

expanded = null

)

Reimplemented in Mage_Adminhtml_Block_Catalog_Product_Edit_Tab_Categories.

Definition at line 136 of file Tree.php.

    {
        $params = array('_current'=>true, 'id'=>null,'store'=>null);
        if (
            (is_null($expanded) && Mage::getSingleton('admin/session')->getIsTreeWasExpanded())
            || $expanded == true) {
            $params['expand_all'] = true;
        }
        return $this->getUrl('*/*/categoriesJson', $params);
    }

getMoveUrl

(

)

Definition at line 162 of file Tree.php.

    {
        return $this->getUrl('*/catalog_category/move', array('store'=>$this->getRequest()->getParam('store')));
    }

getNodesUrl

(

)

Definition at line 147 of file Tree.php.

    {
        return $this->getUrl('*/catalog_category/jsonTree');
    }

getRootIds

(

)

Definition at line 181 of file Tree.php.

    {
        $ids = $this->getData('root_ids');
        if (is_null($ids)) {
            $ids = array();
            foreach (Mage::app()->getStores() as $store) {
                $ids[] = $store->getRootCategoryId();
            }
            $this->setData('root_ids', $ids);
        }
        return $ids;
    }

getStoreSwitcherHtml

(

)

Definition at line 131 of file Tree.php.

    {
        return $this->getChildHtml('store_switcher');
    }

getSwitchTreeUrl

(

)

Definition at line 152 of file Tree.php.

    {
        return $this->getUrl("*/catalog_category/tree", array('_current'=>true, 'store'=>null, '_query'=>false, 'id'=>null, 'parent'=>null));
    }

getTree

(

$

parenNodeCategory = null

)

Definition at line 167 of file Tree.php.

    {
        $rootArray = $this->_getNodeJson($this->getRoot($parenNodeCategory));
        $tree = isset($rootArray['children']) ? $rootArray['children'] : array();
        return $tree;
    }

getTreeJson

(

$

parenNodeCategory = null

)

Definition at line 174 of file Tree.php.

    {
        $rootArray = $this->_getNodeJson($this->getRoot($parenNodeCategory));
        $json = Zend_Json::encode(isset($rootArray['children']) ? $rootArray['children'] : array());
        return $json;
    }

isClearEdit

(

)

Check if page loaded by outside link to category edit

Returns:

boolean

Definition at line 318 of file Tree.php.

    {
        return (bool) $this->getRequest()->getParam('clear');
    }

---

Member Data Documentation

$_withProductCount [protected]

Definition at line 38 of file Tree.php.

---

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

• app/code/core/Mage/Adminhtml/Block/Catalog/Category/Tree.php