Mage_Catalog_Model_Product_Api Class Reference

Inheritance diagram for Mage_Catalog_Model_Product_Api:

List of all members.

Public Member Functions
	__construct ()
	items ($filters=null, $store=null)
	info ($productId, $store=null, $attributes=null)
	create ($type, $set, $sku, $productData)
	update ($productId, $productData=array(), $store=null)
	setSpecialPrice ($productId, $specialPrice=null, $fromDate=null, $toDate=null, $store=null)
	getSpecialPrice ($productId, $store=null)
	delete ($productId)
Protected Member Functions
	_prepareDataForSave ($product, $productData)
Protected Attributes
	$_filtersMap

---

Detailed Description

Definition at line 34 of file Api.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 42 of file Api.php.

    {
        $this->_storeIdSessionField = 'product_store_id';
        $this->_ignoredAttributeTypes[] = 'gallery';
        $this->_ignoredAttributeTypes[] = 'media_image';
    }

---

Member Function Documentation

_prepareDataForSave	(	$	product,
		$	productData
	)			[protected]

Set additional data before product saved

Parameters:

	Mage_Catalog_Model_Product	$product
	array	$productData

Returns:

object

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 234 of file Api.php.

    {
        if (isset($productData['categories']) && is_array($productData['categories'])) {
            $product->setCategoryIds($productData['categories']);
        }

        if (isset($productData['websites']) && is_array($productData['websites'])) {
            foreach ($productData['websites'] as &$website) {
                if (is_string($website)) {
                    try {
                        $website = Mage::app()->getWebsite($website)->getId();
                    } catch (Exception $e) { }
                }
            }
            $product->setWebsiteIds($productData['websites']);
        }

        if (isset($productData['stock_data']) && is_array($productData['stock_data'])) {
            $product->setStockData($productData['stock_data']);
        }
    }

create	(	$	type,
		$	set,
		$	sku,
		$	productData
	)

Create new product.

Parameters:

	string	$type
	int	$set
	array	$productData

Returns:

int

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 136 of file Api.php.

    {
        if (!$type || !$set || !$sku) {
            $this->_fault('data_invalid');
        }

        $product = Mage::getModel('catalog/product');
        /* @var $product Mage_Catalog_Model_Product */
        $product->setStoreId($this->_getStoreId($store))
            ->setAttributeSetId($set)
            ->setTypeId($type)
            ->setSku($sku);

        if (isset($productData['website_ids']) && is_array($productData['website_ids'])) {
            $product->setWebsiteIds($productData['website_ids']);
        }

        foreach ($product->getTypeInstance(true)->getEditableAttributes($product) as $attribute) {
            if ($this->_isAllowedAttribute($attribute)
                && isset($productData[$attribute->getAttributeCode()])) {
                $product->setData(
                    $attribute->getAttributeCode(),
                    $productData[$attribute->getAttributeCode()]
                );
            }
        }

        $this->_prepareDataForSave($product, $productData);

        if (is_array($errors = $product->validate())) {
            $this->_fault('data_invalid', implode("\n", $errors));
        }

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

        return $product->getId();
    }

delete

(

$

productId

)

Delete product

Parameters:

int|string

$productId

Returns:

boolean

Definition at line 293 of file Api.php.

    {
        $product = $this->_getProduct($productId);

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

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

        return true;
    }

getSpecialPrice	(	$	productId,
		$	store = null
	)

Retrieve product special price

Parameters:

	int|string	$productId
	string|int	$store

Returns:

array

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 282 of file Api.php.

    {
        return $this->info($productId, $store, array('special_price', 'special_from_date', 'special_to_date'));
    }

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

Retrieve product info

Parameters:

	int|string	$productId
	string|int	$store
	array	$attributes

Returns:

array

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 101 of file Api.php.

    {
        $product = $this->_getProduct($productId, $store);

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

        $result = array( // Basic product data
            'product_id' => $product->getId(),
            'sku'        => $product->getSku(),
            'set'        => $product->getAttributeSetId(),
            'type'       => $product->getTypeId(),
            'categories' => $product->getCategoryIds(),
            'websites'   => $product->getWebsiteIds()
        );

        foreach ($product->getTypeInstance(true)->getEditableAttributes($product) as $attribute) {
            if ($this->_isAllowedAttribute($attribute, $attributes)) {
                $result[$attribute->getAttributeCode()] = $product->getData(
                                                                $attribute->getAttributeCode());
            }
        }

        return $result;
    }

items	(	$	filters = null,
		$	store = null
	)

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

Parameters:

	array	$filters
	string|int	$store

Returns:

array

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 56 of file Api.php.

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

        if (is_array($filters)) {
            try {
                foreach ($filters as $field => $value) {
                    if (isset($this->_filtersMap[$field])) {
                        $field = $this->_filtersMap[$field];
                    }

                    $collection->addFieldToFilter($field, $value);
                }
            } catch (Mage_Core_Exception $e) {
                $this->_fault('filters_invalid', $e->getMessage());
            }
        }

        $result = array();

        foreach ($collection as $product) {
//            $result[] = $product->getData();
            $result[] = array( // Basic product data
                'product_id' => $product->getId(),
                'sku'        => $product->getSku(),
                'name'       => $product->getName(),
                'set'        => $product->getAttributeSetId(),
                'type'       => $product->getTypeId(),
                'category_ids'       => $product->getCategoryIds()
            );
        }

        return $result;
    }

setSpecialPrice	(	$	productId,
		$	specialPrice = null,
		$	fromDate = null,
		$	toDate = null,
		$	store = null
	)

Update product special price

Parameters:

	int|string	$productId
	float	$specialPrice
	string	$fromDate
	string	$toDate
	string|int	$store

Returns:

boolean

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 266 of file Api.php.

    {
        return $this->update($productId, array(
            'special_price'     => $specialPrice,
            'special_from_date' => $fromDate,
            'special_to_date'   => $toDate
        ), $store);
    }

update	(	$	productId,
		$	productData = array(),
		$	store = null
	)

Update product data

Parameters:

	int|string	$productId
	array	$productData
	string|int	$store

Returns:

boolean

Reimplemented in Mage_Catalog_Model_Product_Api_V2.

Definition at line 186 of file Api.php.

    {
        $product = $this->_getProduct($productId, $store);

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

        if (isset($productData['website_ids']) && is_array($productData['website_ids'])) {
            $product->setWebsiteIds($productData['website_ids']);
        }

        foreach ($product->getTypeInstance(true)->getEditableAttributes($product) as $attribute) {
            if ($this->_isAllowedAttribute($attribute)
                && isset($productData[$attribute->getAttributeCode()])) {
                $product->setData(
                    $attribute->getAttributeCode(),
                    $productData[$attribute->getAttributeCode()]
                );
            }
        }

        $this->_prepareDataForSave($product, $productData);

        try {
            if (is_array($errors = $product->validate())) {
                $this->_fault('data_invalid', implode("\n", $errors));
            }
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

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

        return true;
    }

---

Member Data Documentation

$_filtersMap [protected]

Initial value:

 array(
        'product_id' => 'entity_id',
        'set'        => 'attribute_set_id',
        'type'       => 'type_id'
    )

Definition at line 36 of file Api.php.

---

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

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