Class Mage_Catalog_Model_Product_Api

Description
Description | Descendents | Vars (details) | Methods (details)

Catalog product api

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

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Catalog_Model_Api_Resource
      |
      --Mage_Catalog_Model_Product_Api
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Mage_Catalog_Model_Product_Api_V2 Catalog product api V2
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
mixed $_filtersMap
Method Summary
Description | Descendents | Vars (details) | Methods (details)
Mage_Catalog_Model_Product_Api __construct ()
int create (string $type, int $set,  $sku, array $productData)
boolean delete (int|string $productId, [ $identifierType = null])
array getSpecialPrice (int|string $productId, [string|int $store = null])
array info (int|string $productId, [string|int $store = null], [array $attributes = null], [ $identifierType = null])
array items ([array $filters = null], [string|int $store = null])
boolean setSpecialPrice (int|string $productId, [float $specialPrice = null], [string $fromDate = null], [string $toDate = null], [string|int $store = null])
boolean update (int|string $productId, array $productData, [string|int $store = null], [ $identifierType = null])
object _prepareDataForSave (Mage_Catalog_Model_Product $product, array $productData)
Variables
Description | Descendents | Vars (details) | Methods (details)
mixed $_filtersMap = array(
'product_id' => 'entity_id',
'set' => 'attribute_set_id',
'type' => 'type_id'
) (line 36)
  • access: protected

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 (details) Methods (details)
Constructor __construct (line 42)
  • access: public
Mage_Catalog_Model_Product_Api __construct ()
create (line 136)

Create new product.

  • access: public
int create (string $type, int $set,  $sku, array $productData)
  • string $type
  • int $set
  • array $productData
  • $sku
Redefined in descendants as:
delete (line 317)

Delete product

  • access: public
boolean delete (int|string $productId, [ $identifierType = null])
  • int|string $productId
  • $identifierType
getSpecialPrice (line 306)

Retrieve product special price

  • access: public
array getSpecialPrice (int|string $productId, [string|int $store = null])
  • int|string $productId
  • string|int $store
Redefined in descendants as:
info (line 101)

Retrieve product info

  • access: public
array info (int|string $productId, [string|int $store = null], [array $attributes = null], [ $identifierType = null])
  • int|string $productId
  • string|int $store
  • array $attributes
  • $identifierType
Redefined in descendants as:
items (line 56)

Retrieve list of products with basic info (id, sku, type, set, name)

  • access: public
array items ([array $filters = null], [string|int $store = null])
  • array $filters
  • string|int $store
Redefined in descendants as:
setSpecialPrice (line 290)

Update product special price

  • access: public
boolean setSpecialPrice (int|string $productId, [float $specialPrice = null], [string $fromDate = null], [string $toDate = null], [string|int $store = null])
  • int|string $productId
  • float $specialPrice
  • string $fromDate
  • string $toDate
  • string|int $store
Redefined in descendants as:
update (line 194)

Update product data

  • access: public
boolean update (int|string $productId, array $productData, [string|int $store = null], [ $identifierType = null])
  • int|string $productId
  • array $productData
  • string|int $store
  • $identifierType
Redefined in descendants as:
_prepareDataForSave (line 247)

Set additional data before product saved

  • access: protected
object _prepareDataForSave (Mage_Catalog_Model_Product $product, array $productData)
Redefined in descendants as:

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:33 +0200 by phpDocumentor 1.4.3