Class Mage_Catalog_Model_Category_Api

Description
Description | Descendents | Vars | Methods (details)

Catalog category api

Located in /Catalog/Model/Category/Api.php (line 34) 

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Catalog_Model_Api_Resource
      |
      --Mage_Catalog_Model_Category_Api
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
Mage_Catalog_Model_Category_Api_V2 Catalog category api
Method Summary
Description | Descendents | Vars | Methods (details)
Mage_Catalog_Model_Category_Api __construct ()
array assignedProducts (int $categoryId, [string|int $store = null])
boolean assignProduct (int $categoryId, int $productId, [int $position = null], [ $identifierType = null])
int create (int $parentId, array $categoryData, [ $store = null])
boolean delete (int $categoryId)
array info (int $categoryId, [string|int $store = null], [array $attributes = null])
array level ([string|int $website = null], [string|int $store = null], [ $categoryId = null])
boolean move (int $categoryId, int $parentId, [int $afterId = null])
boolean removeProduct (int $categoryId, int $productId, [ $identifierType = null])
array tree ([ $parentId = null], [string|int $store = null], int $parent)
boolean update (int $categoryId, array $categoryData, [string|int $store = null])
boolean updateProduct (int $categoryId, int $productId, [int $position = null], [ $identifierType = null])
int _getProductId (int|string $productId, [ $identifierType = null])
Mage_Catalog_Model_Category _initCategory (int $categoryId, [string|int $store = null])
array _nodeToArray ( $node)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from Mage_Catalog_Model_Api_Resource

Mage_Catalog_Model_Api_Resource::$_ignoredAttributeCodes
 Mage_Catalog_Model_Api_Resource::$_ignoredAttributeTypes
 Mage_Catalog_Model_Api_Resource::$_storeIdSessionField

Inherited from Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::$_resourceConfig
Methods
Description | Descendents | Vars Methods (details)
Constructor __construct (line 36)
  • access: public
Mage_Catalog_Model_Category_Api __construct ()
assignedProducts (line 427)

Retrieve list of assigned products to category

  • access: public
array assignedProducts (int $categoryId, [string|int $store = null])
  • int $categoryId
  • string|int $store
assignProduct (line 458)

Assign product to category

  • access: public
boolean assignProduct (int $categoryId, int $productId, [int $position = null], [ $identifierType = null])
  • int $categoryId
  • int $productId
  • int $position
  • $identifierType
create (line 245)

Create new category

  • access: public
int create (int $parentId, array $categoryData, [ $store = null])
  • int $parentId
  • array $categoryData
  • $store
Redefined in descendants as:
delete (line 372)

Delete category

  • access: public
boolean delete (int $categoryId)
  • int $categoryId
info (line 214)

Retrieve category data

  • access: public
array info (int $categoryId, [string|int $store = null], [array $attributes = null])
  • int $categoryId
  • string|int $store
  • array $attributes
Redefined in descendants as:
level (line 48)

Retrive level of categories for category/store view/website

  • access: public
array level ([string|int $website = null], [string|int $store = null], [ $categoryId = null])
  • string|int $website
  • string|int $store
  • $categoryId
move (line 342)

Move category in tree

  • access: public
boolean move (int $categoryId, int $parentId, [int $afterId = null])
  • int $categoryId
  • int $parentId
  • int $afterId
removeProduct (line 511)

Remove product assignment from category

  • access: public
boolean removeProduct (int $categoryId, int $productId, [ $identifierType = null])
  • int $categoryId
  • int $productId
  • $identifierType
tree (line 133)

Retrieve category tree

  • access: public
array tree ([ $parentId = null], [string|int $store = null], int $parent)
  • int $parent
  • string|int $store
  • $parentId
update (line 298)

Update category data

  • access: public
boolean update (int $categoryId, array $categoryData, [string|int $store = null])
  • int $categoryId
  • array $categoryData
  • string|int $store
Redefined in descendants as:
updateProduct (line 484)

Update product assignment

  • access: public
boolean updateProduct (int $categoryId, int $productId, [int $position = null], [ $identifierType = null])
  • int $categoryId
  • int $productId
  • int $position
  • $identifierType
_getProductId (line 391)

Get prduct Id from sku or from product id

  • access: protected
int _getProductId (int|string $productId, [ $identifierType = null])
  • int|string $productId
  • $identifierType
_initCategory (line 193)

Initilize and return category model

  • access: protected
Mage_Catalog_Model_Category _initCategory (int $categoryId, [string|int $store = null])
  • int $categoryId
  • string|int $store
_nodeToArray (line 167)

Convert node to array

  • access: protected
array _nodeToArray ( $node)
  • Varien_Data_Tree_Node $node

Inherited Methods

Inherited From Mage_Catalog_Model_Api_Resource

Mage_Catalog_Model_Api_Resource::currentStore()
Mage_Catalog_Model_Api_Resource::_getProduct()
Mage_Catalog_Model_Api_Resource::_getStoreId()
Mage_Catalog_Model_Api_Resource::_isAllowedAttribute()

Inherited From Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::getResourceConfig()
Mage_Api_Model_Resource_Abstract::setResourceConfig()
Mage_Api_Model_Resource_Abstract::_fault()
Mage_Api_Model_Resource_Abstract::_getConfig()
Mage_Api_Model_Resource_Abstract::_getServer()
Mage_Api_Model_Resource_Abstract::_getSession()

Documentation generated on Fri, 11 Feb 2011 16:56:34 +0200 by phpDocumentor 1.4.3