Mage_Catalog_Model_Product_Api_V2 Class Reference

Inheritance diagram for Mage_Catalog_Model_Product_Api_V2:

List of all members.

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

---

Detailed Description

Definition at line 34 of file V2.php.

---

Member Function Documentation

_prepareDataForSave	(	$	product,
		$	productData
	)			[protected]

Set additional data before product saved

Parameters:

	Mage_Catalog_Model_Product	$product
	array	$productData

Returns:

object

Reimplemented from Mage_Catalog_Model_Product_Api.

Definition at line 273 of file V2.php.

    {
        if (property_exists($productData, 'categories') && is_array($productData->categories)) {
            $product->setCategoryIds($productData->categories);
        }

        if (property_exists($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 (property_exists($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 from Mage_Catalog_Model_Product_Api.

Definition at line 158 of file V2.php.

    {
        if (!$type || !$set || !$sku) {
            $this->_fault('data_invalid');
        }
        $store = null;
        $product = Mage::getModel('catalog/product');
        /* @var $product Mage_Catalog_Model_Product */
        $product->setStoreId($this->_getStoreId($store))
            ->setAttributeSetId($set)
            ->setTypeId($type)
            ->setSku($sku);

        if (property_exists($productData, 'website_ids') && is_array($productData->website_ids)) {
            $product->setWebsiteIds($productData->website_ids);
        }

        if (property_exists($productData, 'additional_attributes')) {
            foreach ($productData->additional_attributes as $_attribute) {
                $_attrCode = $_attribute->key;
                $productData->$_attrCode = $_attribute->value;
            }
            unset($productData->additional_attributes);
        }
        foreach ($product->getTypeInstance(true)->getEditableAttributes($product) as $attribute) {
            $_attrCode = $attribute->getAttributeCode();
            if ($this->_isAllowedAttribute($attribute)
                && isset($productData->$_attrCode)) {
                $product->setData(
                    $attribute->getAttributeCode(),
                    $productData->$_attrCode
                );
            }
        }

        $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();
    }

getSpecialPrice	(	$	productId,
		$	store = null
	)

Retrieve product special price

Parameters:

	int|string	$productId
	string|int	$store

Returns:

array

Reimplemented from Mage_Catalog_Model_Product_Api.

Definition at line 321 of file V2.php.

    {
        return $this->info($productId, $store, array(
            'attributes' => 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
	stdClass	$attributes

Returns:

array

Reimplemented from Mage_Catalog_Model_Product_Api.

Definition at line 104 of file V2.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()
        );

        $allAttributes = array();
        if (isset($attributes->attributes)) {
            $allAttributes += array_merge($allAttributes, $attributes->attributes);
        }

        $_additionalAttributeCodes = array();
        if (isset($attributes->additional_attributes)) {
            foreach ($attributes->additional_attributes as $k => $_attributeCode) {
                $allAttributes[] = $_attributeCode;
                $_additionalAttributeCodes[] = $_attributeCode;
            }
        }

        $_additionalAttribute = 0;
        foreach ($product->getTypeInstance(true)->getEditableAttributes($product) as $attribute) {
            if ($this->_isAllowedAttribute($attribute, $allAttributes)) {
                if (in_array($attribute->getAttributeCode(), $_additionalAttributeCodes)) {
                    $result['additional_attributes'][$_additionalAttribute]['key'] = $attribute->getAttributeCode();
                    $result['additional_attributes'][$_additionalAttribute]['value'] = $product->getData($attribute->getAttributeCode());
                    $_additionalAttribute++;
                } else {
                    $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 from Mage_Catalog_Model_Product_Api.

Definition at line 44 of file V2.php.

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

        $preparedFilters = array();
        if (isset($filters->filter)) {
            foreach ($filters->filter as $_filter) {
                $preparedFilters[$_filter->key] = $_filter->value;
            }
        }
        if (isset($filters->complex_filter)) {
            foreach ($filters->complex_filter as $_filter) {
                $_value = $_filter->value;
                $preparedFilters[$_filter->key] = array(
                    $_value->key => $_value->value
                );
            }
        }

        if (!empty($preparedFilters)) {
            try {
                foreach ($preparedFilters 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 from Mage_Catalog_Model_Product_Api.

Definition at line 305 of file V2.php.

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

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

Update product data

Parameters:

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

Returns:

boolean

Reimplemented from Mage_Catalog_Model_Product_Api.

Definition at line 216 of file V2.php.

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

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

        if (property_exists($productData, 'website_ids') && is_array($productData->website_ids)) {
            $product->setWebsiteIds($productData->website_ids);
        }

        if (property_exists($productData, 'additional_attributes')) {
            foreach ($productData->additional_attributes as $_attribute) {
                $_attrCode = $_attribute->key;
                $productData->$_attrCode = $_attribute->value;
            }
            unset($productData->additional_attributes);
        }

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

        $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;
    }

---

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

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