/app/code/core/Mage/Catalog/Model/Product/Api.php
PHP | 335 lines | 190 code | 41 blank | 104 comment | 30 complexity | 6ec56d074334aecaf04ff87758c44a97 MD5 | raw file
- <?php
- /**
- * Magento
- *
- * NOTICE OF LICENSE
- *
- * This source file is subject to the Open Software License (OSL 3.0)
- * that is bundled with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://opensource.org/licenses/osl-3.0.php
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@magentocommerce.com so we can send you a copy immediately.
- *
- * DISCLAIMER
- *
- * Do not edit or add to this file if you wish to upgrade Magento to newer
- * versions in the future. If you wish to customize Magento for your
- * needs please refer to http://www.magentocommerce.com for more information.
- *
- * @category Mage
- * @package Mage_Catalog
- * @copyright Copyright (c) 2011 Magento Inc. (http://www.magentocommerce.com)
- * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
- */
- /**
- * Catalog product api
- *
- * @category Mage
- * @package Mage_Catalog
- * @author Magento Core Team <core@magentocommerce.com>
- */
- class Mage_Catalog_Model_Product_Api extends Mage_Catalog_Model_Api_Resource
- {
- protected $_filtersMap = array(
- 'product_id' => 'entity_id',
- 'set' => 'attribute_set_id',
- 'type' => 'type_id'
- );
- public function __construct()
- {
- $this->_storeIdSessionField = 'product_store_id';
- $this->_ignoredAttributeTypes[] = 'gallery';
- $this->_ignoredAttributeTypes[] = 'media_image';
- }
- /**
- * Retrieve list of products with basic info (id, sku, type, set, name)
- *
- * @param array $filters
- * @param string|int $store
- * @return array
- */
- public function items($filters = null, $store = null)
- {
- $collection = Mage::getModel('catalog/product')->getCollection()
- ->addStoreFilter($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;
- }
- /**
- * Retrieve product info
- *
- * @param int|string $productId
- * @param string|int $store
- * @param array $attributes
- * @return array
- */
- public function info($productId, $store = null, $attributes = null, $identifierType = null)
- {
- $product = $this->_getProduct($productId, $store, $identifierType);
- 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;
- }
- /**
- * Create new product.
- *
- * @param string $type
- * @param int $set
- * @param string $sku
- * @param array $productData
- * @param string $store
- * @return int
- */
- public function create($type, $set, $sku, $productData, $store = null)
- {
- if (!$type || !$set || !$sku) {
- $this->_fault('data_invalid');
- }
- /** @var $product Mage_Catalog_Model_Product */
- $product = Mage::getModel('catalog/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);
- try {
- /**
- * @todo implement full validation process with errors returning which are ignoring now
- * @todo see Mage_Catalog_Model_Product::validate()
- */
- if (is_array($errors = $product->validate())) {
- $strErrors = array();
- foreach($errors as $code=>$error) {
- $strErrors[] = ($error === true)? Mage::helper('catalog')->__('Attribute "%s" is invalid.', $code) : $error;
- }
- $this->_fault('data_invalid', implode("\n", $strErrors));
- }
- $product->save();
- } catch (Mage_Core_Exception $e) {
- $this->_fault('data_invalid', $e->getMessage());
- }
- return $product->getId();
- }
- /**
- * Update product data
- *
- * @param int|string $productId
- * @param array $productData
- * @param string|int $store
- * @return boolean
- */
- public function update($productId, $productData, $store = null, $identifierType = null)
- {
- $product = $this->_getProduct($productId, $store, $identifierType);
- 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 {
- /**
- * @todo implement full validation process with errors returning which are ignoring now
- * @todo see Mage_Catalog_Model_Product::validate()
- */
- if (is_array($errors = $product->validate())) {
- $strErrors = array();
- foreach($errors as $code=>$error) {
- $strErrors[] = ($error === true)? Mage::helper('catalog')->__('Value for "%s" is invalid.', $code) : Mage::helper('catalog')->__('Value for "%s" is invalid: %s', $code, $error);
- }
- $this->_fault('data_invalid', implode("\n", $strErrors));
- }
- $product->save();
- } catch (Mage_Core_Exception $e) {
- $this->_fault('data_invalid', $e->getMessage());
- }
- return true;
- }
- /**
- * Set additional data before product saved
- *
- * @param Mage_Catalog_Model_Product $product
- * @param array $productData
- * @return object
- */
- protected function _prepareDataForSave ($product, $productData)
- {
- 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 (Mage::app()->isSingleStoreMode()) {
- $product->setWebsiteIds(array(Mage::app()->getStore(true)->getWebsite()->getId()));
- }
- if (isset($productData['stock_data']) && is_array($productData['stock_data'])) {
- $product->setStockData($productData['stock_data']);
- } else {
- $product->setStockData(array('use_config_manage_stock' => 0));
- }
- if (isset($productData['tier_price']) && is_array($productData['tier_price'])) {
- $tierPrices = Mage::getModel('catalog/product_attribute_tierprice_api')->prepareTierPrices($product, $productData['tier_price']);
- $product->setData(Mage_Catalog_Model_Product_Attribute_Tierprice_Api::ATTRIBUTE_CODE, $tierPrices);
- }
- }
- /**
- * Update product special price
- *
- * @param int|string $productId
- * @param float $specialPrice
- * @param string $fromDate
- * @param string $toDate
- * @param string|int $store
- * @return boolean
- */
- public function setSpecialPrice($productId, $specialPrice = null, $fromDate = null, $toDate = null, $store = null)
- {
- return $this->update($productId, array(
- 'special_price' => $specialPrice,
- 'special_from_date' => $fromDate,
- 'special_to_date' => $toDate
- ), $store);
- }
- /**
- * Retrieve product special price
- *
- * @param int|string $productId
- * @param string|int $store
- * @return array
- */
- public function getSpecialPrice($productId, $store = null)
- {
- return $this->info($productId, $store, array('special_price', 'special_from_date', 'special_to_date'));
- }
- /**
- * Delete product
- *
- * @param int|string $productId
- * @return boolean
- */
- public function delete($productId, $identifierType = null)
- {
- $product = $this->_getProduct($productId, null, $identifierType);
- if (!$product->getId()) {
- $this->_fault('not_exists');
- }
- try {
- $product->delete();
- } catch (Mage_Core_Exception $e) {
- $this->_fault('not_deleted', $e->getMessage());
- }
- return true;
- }
- } // Class Mage_Catalog_Model_Product_Api End