Mage_Catalog_Model_Category_Api Class Reference

Inheritance diagram for Mage_Catalog_Model_Category_Api:

List of all members.

Public Member Functions
	__construct ()
	level ($website=null, $store=null, $categoryId=null)
	tree ($parentId=null, $store=null)
	info ($categoryId, $store=null, $attributes=null)
	create ($parentId, $categoryData, $store=null)
	update ($categoryId, $categoryData, $store=null)
	move ($categoryId, $parentId, $afterId=null)
	delete ($categoryId)
	assignedProducts ($categoryId, $store=null)
	assignProduct ($categoryId, $productId, $position=null)
	updateProduct ($categoryId, $productId, $position=null)
	removeProduct ($categoryId, $productId)
Protected Member Functions
	_nodeToArray (Varien_Data_Tree_Node $node)
	_initCategory ($categoryId, $store=null)
	_getProductId ($productId)

---

Detailed Description

Definition at line 34 of file Api.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 36 of file Api.php.

    {
        $this->_storeIdSessionField = 'category_store_id';
    }

---

Member Function Documentation

_getProductId

(

$

productId

)

[protected]

Get prduct Id from sku or from product id

Parameters:

int|string

$productId

Returns:

int

Definition at line 370 of file Api.php.

    {
        $product = Mage::getModel('catalog/product');

        $idBySku = $product->getIdBySku($productId);
        if ($idBySku) {
            $productId = $idBySku;
        }

        $product->load($productId);

        if (!$product->getId()) {
            $this->_fault('not_exists','Product not exists.');
        }

        return $productId;
    }

_initCategory	(	$	categoryId,
		$	store = null
	)			[protected]

Initilize and return category model

Parameters:

	int	$categoryId
	string|int	$store

Returns:

Mage_Catalog_Model_Category

Definition at line 185 of file Api.php.

    {
        $category = Mage::getModel('catalog/category')
            ->setStoreId($this->_getStoreId($store))
            ->load($categoryId);

        if (!$category->getId()) {
            $this->_fault('not_exists');
        }

        return $category;
    }

_nodeToArray

(

Varien_Data_Tree_Node $

node

)

[protected]

Convert node to array

Parameters:

Varien_Data_Tree_Node

$node

Returns:

array

Definition at line 159 of file Api.php.

    {
        // Only basic category data
        $result = array();
        $result['category_id'] = $node->getId();
        $result['parent_id']   = $node->getParentId();
        $result['name']        = $node->getName();
        $result['is_active']   = $node->getIsActive();
        $result['position']    = $node->getPosition();
        $result['level']       = $node->getLevel();
        $result['children']    = array();

        foreach ($node->getChildren() as $child) {
            $result['children'][] = $this->_nodeToArray($child);
        }

        return $result;
    }

assignedProducts	(	$	categoryId,
		$	store = null
	)

Retrieve list of assigned products to category

Parameters:

	int	$categoryId
	string|int	$store

Returns:

array

Definition at line 396 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);

        $collection = $category->setStoreId($this->_getStoreId($store))
            ->getProductCollection()
            ->setOrder('position', 'asc');

        $result = array();

        foreach ($collection as $product) {
            $result[] = array(
                'product_id' => $product->getId(),
                'type'       => $product->getTypeId(),
                'set'        => $product->getAttributeSetId(),
                'sku'        => $product->getSku(),
                'position'   => $product->getPosition()
            );
        }

        return $result;
    }

assignProduct	(	$	categoryId,
		$	productId,
		$	position = null
	)

Assign product to category

Parameters:

	int	$categoryId
	int	$productId
	int	$position

Returns:

boolean

Definition at line 427 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);
        $positions = $category->getProductsPosition();
        $productId = $this->_getProductId($productId);
        $positions[$productId] = $position;
        $category->setPostedProducts($positions);

        try {
            $category->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return true;
    }

create	(	$	parentId,
		$	categoryData,
		$	store = null
	)

Create new category

Parameters:

	int	$parentId
	array	$categoryData

Returns:

int

Reimplemented in Mage_Catalog_Model_Category_Api_V2.

Definition at line 237 of file Api.php.

    {
         $parent_category = $this->_initCategory($parentId);

        $category = Mage::getModel('catalog/category')
            ->setStoreId($this->_getStoreId($store));



        $category->addData(array('path'=>implode('/',$parent_category->getPathIds())));

        $category ->setAttributeSetId($category->getDefaultAttributeSetId());
        /* @var $category Mage_Catalog_Model_Category */

        foreach ($category->getAttributes() as $attribute) {
            if ($this->_isAllowedAttribute($attribute)
                && isset($categoryData[$attribute->getAttributeCode()])) {
                $category->setData(
                    $attribute->getAttributeCode(),
                    $categoryData[$attribute->getAttributeCode()]
                );
            }
        }
        $category->setParentId($parent_category->getId());
        try {
            $category->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return $category->getId();
    }

delete

(

$

categoryId

)

Delete category

Parameters:

int

$categoryId

Returns:

boolean

Definition at line 351 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);

        try {
            $category->delete();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('not_deleted', $e->getMessage());
        }

        return true;
    }

info	(	$	categoryId,
		$	store = null,
		$	attributes = null
	)

Retrieve category data

Parameters:

	int	$categoryId
	string|int	$store
	array	$attributes

Returns:

array

Reimplemented in Mage_Catalog_Model_Category_Api_V2.

Definition at line 206 of file Api.php.

    {
        $category = $this->_initCategory($categoryId, $store);

        // Basic category data
        $result = array();
        $result['category_id'] = $category->getId();

        $result['is_active']   = $category->getIsActive();
        $result['position']    = $category->getPosition();
        $result['level']       = $category->getLevel();

        foreach ($category->getAttributes() as $attribute) {
            if ($this->_isAllowedAttribute($attribute, $attributes)) {
                $result[$attribute->getAttributeCode()] = $category->getData($attribute->getAttributeCode());
            }
        }
        $result['parent_id']   = $category->getParentId();
        $result['children']           = $category->getChildren();
        $result['all_children']       = $category->getAllChildren();

        return $result;
    }

level	(	$	website = null,
		$	store = null,
		$	categoryId = null
	)

Retrive level of categories for category/store view/website

Parameters:

	string|int	$website
	string|int	$store

Returns:

array

Definition at line 48 of file Api.php.

    {
        $ids = array();
        $storeId = Mage_Catalog_Model_Category::DEFAULT_STORE_ID;

        // load root categories of website
        if (null !== $website) {
            try {
                $website = Mage::app()->getWebsite($website);
                foreach ($website->getStores() as $store) {
                    /* @var $store Mage_Core_Model_Store */
                    $ids[] = $store->getRootCategoryId();
                }
            } catch (Mage_Core_Exception $e) {
                $this->_fault('website_not_exists', $e->getMessage());
            }
        }
        elseif (null !== $store) {
            // load children of root category of store
            if (null === $categoryId) {
                try {
                    $store = Mage::app()->getStore($store);
                    $storeId = $store->getId();
                    $ids = $store->getRootCategoryId();
                } catch (Mage_Core_Model_Store_Exception $e) {
                    $this->_fault('store_not_exists');
                }
            }
            // load children of specified category id
            else {
                $storeId = $this->_getStoreId($store);
                $ids = (int)$categoryId;
            }
        }
        // load all root categories
        else {
            $ids = Mage_Catalog_Model_Category::TREE_ROOT_ID;
        }

        $collection = Mage::getModel('catalog/category')->getCollection()
            ->setStoreId($storeId)
            ->addAttributeToSelect('name')
            ->addAttributeToSelect('is_active');

        if (is_array($ids)) {
            $collection->addFieldToFilter('entity_id', array('in' => $ids));
        } else {
            $collection->addFieldToFilter('parent_id', $ids);
        }

        // Only basic category data
        $result = array();
        foreach ($collection as $category) {
            /* @var $category Mage_Catalog_Model_Category */
            $result[] = array(
                'category_id' => $category->getId(),
                'parent_id'   => $category->getParentId(),
                'name'        => $category->getName(),
                'is_active'   => $category->getIsActive(),
                'position'    => $category->getPosition(),
                'level'       => $category->getLevel()
            );
        }

        return $result;
    }

move	(	$	categoryId,
		$	parentId,
		$	afterId = null
	)

Move category in tree

Parameters:

	int	$categoryId
	int	$parentId
	int	$afterId

Returns:

boolean

Definition at line 309 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);
        $parent_category = $this->_initCategory($parentId);

        $tree = Mage::getResourceModel('catalog/category_tree')
                ->load();

        $node           = $tree->getNodeById($category->getId());
        $newParentNode  = $tree->getNodeById($parent_category->getId());

        if (!$node || !$node->getId()) {
            $this->_fault('not_exists');
        }

        // if $afterId is null - move category to the down
        if ($afterId === null && $parent_category->hasChildren()) {
            $parentChildren = $parent_category->getChildren();
            $afterId = array_pop(explode(',', $parentChildren));
        }

        $prevNode = $tree->getNodeById($afterId);

        if (!$prevNode || !$prevNode->getId()) {
            $prevNode = null;
        }

        try {
            $tree->move($node, $newParentNode, $prevNode);
        } catch (Mage_Core_Exception $e) {
            $this->_fault('not_moved', $e->getMessage());
        }

        return true;
    }

removeProduct	(	$	categoryId,
		$	productId
	)

Remove product assignment from category

Parameters:

	int	$categoryId
	int	$productId

Returns:

boolean

Definition at line 480 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);
        $positions = $category->getProductsPosition();
        $productId = $this->_getProductId($productId);
        if (!isset($positions[$productId])) {
            $this->_fault('product_not_assigned');
        }

        unset($positions[$productId]);
        $category->setPostedProducts($positions);

        try {
            $category->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return true;
    }

tree	(	$	parentId = null,
		$	store = null
	)

Retrieve category tree

Parameters:

	int	$parent
	string|int	$store

Returns:

array

Definition at line 122 of file Api.php.

    {
        $tree = Mage::getResourceSingleton('catalog/category_tree')
                ->load();

        if (is_null($parentId) && !is_null($store)) {
            $parentId = Mage::app()->getStore($this->_getStoreId($store))->getRootCategoryId();
        } elseif (is_null($parentId)) {
            $parentId = 1;
        }

        $tree = Mage::getResourceSingleton('catalog/category_tree')
            ->load();
        /* @var $tree Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree */

        $root = $tree->getNodeById($parentId);

        if($root && $root->getId() == 1) {
            $root->setName(Mage::helper('catalog')->__('Root'));
        }

        $collection = Mage::getModel('catalog/category')->getCollection()
            ->setStoreId($this->_getStoreId($store))
            ->addAttributeToSelect('name')
            ->addAttributeToSelect('is_active');

        $tree->addCollectionData($collection, true);

        return $this->_nodeToArray($root);
    }

update	(	$	categoryId,
		$	categoryData,
		$	store = null
	)

Update category data

Parameters:

	int	$categoryId
	array	$categoryData
	string|int	$store

Returns:

boolean

Reimplemented in Mage_Catalog_Model_Category_Api_V2.

Definition at line 278 of file Api.php.

    {
        $category = $this->_initCategory($categoryId, $store);

        foreach ($category->getAttributes() as $attribute) {
            if ($this->_isAllowedAttribute($attribute)
                && isset($categoryData[$attribute->getAttributeCode()])) {
                $category->setData(
                    $attribute->getAttributeCode(),
                    $categoryData[$attribute->getAttributeCode()]
                );
            }
        }

        try {
            $category->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return true;
    }

updateProduct	(	$	categoryId,
		$	productId,
		$	position = null
	)

Update product assignment

Parameters:

	int	$categoryId
	int	$productId
	int	$position

Returns:

boolean

Definition at line 453 of file Api.php.

    {
        $category = $this->_initCategory($categoryId);
        $positions = $category->getProductsPosition();
        $productId = $this->_getProductId($productId);
        if (!isset($positions[$productId])) {
            $this->_fault('product_not_assigned');
        }
        $positions[$productId] = $position;
        $category->setPostedProducts($positions);

        try {
            $category->save();
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return true;
    }

---

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

• app/code/core/Mage/Catalog/Model/Category/Api.php