1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Catalog
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * Catalog product link api
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Catalog
 32:  * @author     Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Catalog_Model_Product_Link_Api extends Mage_Catalog_Model_Api_Resource
 35: {
 36:     /**
 37:      * Product link type mapping, used for references and validation
 38:      *
 39:      * @var array
 40:      */
 41:     protected $_typeMap = array(
 42:         'related'       => Mage_Catalog_Model_Product_Link::LINK_TYPE_RELATED,
 43:         'up_sell'       => Mage_Catalog_Model_Product_Link::LINK_TYPE_UPSELL,
 44:         'cross_sell'    => Mage_Catalog_Model_Product_Link::LINK_TYPE_CROSSSELL,
 45:         'grouped'       => Mage_Catalog_Model_Product_Link::LINK_TYPE_GROUPED
 46:     );
 47: 
 48:     public function __construct()
 49:     {
 50:         $this->_storeIdSessionField = 'product_store_id';
 51:     }
 52: 
 53:     /**
 54:      * Retrieve product link associations
 55:      *
 56:      * @param string $type
 57:      * @param int|sku $productId
 58:      * @param  string $identifierType
 59:      * @return array
 60:      */
 61:     public function items($type, $productId, $identifierType = null)
 62:     {
 63:         $typeId = $this->_getTypeId($type);
 64: 
 65:         $product = $this->_initProduct($productId, $identifierType);
 66: 
 67:         $link = $product->getLinkInstance()
 68:             ->setLinkTypeId($typeId);
 69: 
 70:         $collection = $this->_initCollection($link, $product);
 71: 
 72:         $result = array();
 73: 
 74:         foreach ($collection as $linkedProduct) {
 75:             $row = array(
 76:                 'product_id' => $linkedProduct->getId(),
 77:                 'type'       => $linkedProduct->getTypeId(),
 78:                 'set'        => $linkedProduct->getAttributeSetId(),
 79:                 'sku'        => $linkedProduct->getSku()
 80:             );
 81: 
 82:             foreach ($link->getAttributes() as $attribute) {
 83:                 $row[$attribute['code']] = $linkedProduct->getData($attribute['code']);
 84:             }
 85: 
 86:             $result[] = $row;
 87:         }
 88: 
 89:         return $result;
 90:     }
 91: 
 92:     /**
 93:      * Add product link association
 94:      *
 95:      * @param string $type
 96:      * @param int|string $productId
 97:      * @param int|string $linkedProductId
 98:      * @param array $data
 99:      * @param  string $identifierType
100:      * @return boolean
101:      */
102:     public function assign($type, $productId, $linkedProductId, $data = array(), $identifierType = null)
103:     {
104:         $typeId = $this->_getTypeId($type);
105: 
106:         $product = $this->_initProduct($productId, $identifierType);
107: 
108:         $link = $product->getLinkInstance()
109:             ->setLinkTypeId($typeId);
110: 
111:         $collection = $this->_initCollection($link, $product);
112:         $idBySku = $product->getIdBySku($linkedProductId);
113:         if ($idBySku) {
114:             $linkedProductId = $idBySku;
115:         }
116: 
117:         $links = $this->_collectionToEditableArray($collection);
118: 
119:         $links[(int)$linkedProductId] = array();
120: 
121:         foreach ($collection->getLinkModel()->getAttributes() as $attribute) {
122:             if (isset($data[$attribute['code']])) {
123:                 $links[(int)$linkedProductId][$attribute['code']] = $data[$attribute['code']];
124:             }
125:         }
126: 
127:         try {
128:             if ($type == 'grouped') {
129:                 $link->getResource()->saveGroupedLinks($product, $links, $typeId);
130:             } else {
131:                 $link->getResource()->saveProductLinks($product, $links, $typeId);
132:             }
133: 
134:             $_linkInstance = Mage::getSingleton('catalog/product_link');
135:             $_linkInstance->saveProductRelations($product);
136: 
137:             $indexerStock = Mage::getModel('cataloginventory/stock_status');
138:             $indexerStock->updateStatus($productId);
139: 
140:             $indexerPrice = Mage::getResourceModel('catalog/product_indexer_price');
141:             $indexerPrice->reindexProductIds($productId);
142:         } catch (Exception $e) {
143:             $this->_fault('data_invalid', Mage::helper('catalog')->__('Link product does not exist.'));
144:         }
145: 
146:         return true;
147:     }
148: 
149:     /**
150:      * Update product link association info
151:      *
152:      * @param string $type
153:      * @param int|string $productId
154:      * @param int|string $linkedProductId
155:      * @param array $data
156:      * @param  string $identifierType
157:      * @return boolean
158:      */
159:     public function update($type, $productId, $linkedProductId, $data = array(), $identifierType = null)
160:     {
161:         $typeId = $this->_getTypeId($type);
162: 
163:         $product = $this->_initProduct($productId, $identifierType);
164: 
165:         $link = $product->getLinkInstance()
166:             ->setLinkTypeId($typeId);
167: 
168:         $collection = $this->_initCollection($link, $product);
169: 
170:         $links = $this->_collectionToEditableArray($collection);
171: 
172:         $idBySku = $product->getIdBySku($linkedProductId);
173:         if ($idBySku) {
174:             $linkedProductId = $idBySku;
175:         }
176: 
177:         foreach ($collection->getLinkModel()->getAttributes() as $attribute) {
178:             if (isset($data[$attribute['code']])) {
179:                 $links[(int)$linkedProductId][$attribute['code']] = $data[$attribute['code']];
180:             }
181:         }
182: 
183:         try {
184:             if ($type == 'grouped') {
185:                 $link->getResource()->saveGroupedLinks($product, $links, $typeId);
186:             } else {
187:                 $link->getResource()->saveProductLinks($product, $links, $typeId);
188:             }
189: 
190:             $_linkInstance = Mage::getSingleton('catalog/product_link');
191:             $_linkInstance->saveProductRelations($product);
192: 
193:             $indexerStock = Mage::getModel('cataloginventory/stock_status');
194:             $indexerStock->updateStatus($productId);
195: 
196:             $indexerPrice = Mage::getResourceModel('catalog/product_indexer_price');
197:             $indexerPrice->reindexProductIds($productId);
198:         } catch (Exception $e) {
199:             $this->_fault('data_invalid', Mage::helper('catalog')->__('Link product does not exist.'));
200:         }
201: 
202:         return true;
203:     }
204: 
205:     /**
206:      * Remove product link association
207:      *
208:      * @param string $type
209:      * @param int|string $productId
210:      * @param int|string $linkedProductId
211:      * @param  string $identifierType
212:      * @return boolean
213:      */
214:     public function remove($type, $productId, $linkedProductId, $identifierType = null)
215:     {
216:         $typeId = $this->_getTypeId($type);
217: 
218:         $product = $this->_initProduct($productId, $identifierType);
219: 
220:         $link = $product->getLinkInstance()
221:             ->setLinkTypeId($typeId);
222: 
223:         $collection = $this->_initCollection($link, $product);
224: 
225:         $idBySku = $product->getIdBySku($linkedProductId);
226:         if ($idBySku) {
227:             $linkedProductId = $idBySku;
228:         }
229: 
230:         $links = $this->_collectionToEditableArray($collection);
231: 
232:         if (isset($links[$linkedProductId])) {
233:             unset($links[$linkedProductId]);
234:         }
235: 
236:         try {
237:             $link->getResource()->saveProductLinks($product, $links, $typeId);
238:         } catch (Exception $e) {
239:             $this->_fault('not_removed');
240:         }
241: 
242:         return true;
243:     }
244: 
245:     /**
246:      * Retrieve attribute list for specified type
247:      *
248:      * @param string $type
249:      * @return array
250:      */
251:     public function attributes($type)
252:     {
253:         $typeId = $this->_getTypeId($type);
254: 
255:         $attributes = Mage::getModel('catalog/product_link')
256:             ->getAttributes($typeId);
257: 
258:         $result = array();
259: 
260:         foreach ($attributes as $attribute) {
261:             $result[] = array(
262:                 'code'  => $attribute['code'],
263:                 'type'  => $attribute['type']
264:             );
265:         }
266: 
267:         return $result;
268:     }
269: 
270:     /**
271:      * Retrieve link types
272:      *
273:      * @return array
274:      */
275:     public function types()
276:     {
277:         return array_keys($this->_typeMap);
278:     }
279: 
280:     /**
281:      * Retrieve link type id by code
282:      *
283:      * @param string $type
284:      * @return int
285:      */
286:     protected function _getTypeId($type)
287:     {
288:         if (!isset($this->_typeMap[$type])) {
289:             $this->_fault('type_not_exists');
290:         }
291: 
292:         return $this->_typeMap[$type];
293:     }
294: 
295:     /**
296:      * Initialize and return product model
297:      *
298:      * @param int $productId
299:      * @param  string $identifierType
300:      * @return Mage_Catalog_Model_Product
301:      */
302:     protected function _initProduct($productId, $identifierType = null)
303:     {
304:         $product = Mage::helper('catalog/product')->getProduct($productId, null, $identifierType);
305:         if (!$product->getId()) {
306:             $this->_fault('product_not_exists');
307:         }
308: 
309:         return $product;
310:     }
311: 
312:     /**
313:      * Initialize and return linked products collection
314:      *
315:      * @param Mage_Catalog_Model_Product_Link $link
316:      * @param Mage_Catalog_Model_Product $product
317:      * @return Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection
318:      */
319:     protected function _initCollection($link, $product)
320:     {
321:         $collection = $link
322:             ->getProductCollection()
323:             ->setIsStrongMode()
324:             ->setProduct($product);
325: 
326:         return $collection;
327:     }
328: 
329:     /**
330:      * Export collection to editable array
331:      *
332:      * @param Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Link_Product_Collection $collection
333:      * @return array
334:      */
335:     protected function _collectionToEditableArray($collection)
336:     {
337:         $result = array();
338: 
339:         foreach ($collection as $linkedProduct) {
340:             $result[$linkedProduct->getId()] = array();
341: 
342:             foreach ($collection->getLinkModel()->getAttributes() as $attribute) {
343:                 $result[$linkedProduct->getId()][$attribute['code']] = $linkedProduct->getData($attribute['code']);
344:             }
345:         }
346: 
347:         return $result;
348:     }
349: } // Class Mage_Catalog_Model_Product_Link_Api End
350: