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_Wishlist
 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: /**
 29:  * Wishlist model
 30:  *
 31:  * @method Mage_Wishlist_Model_Resource_Wishlist _getResource()
 32:  * @method Mage_Wishlist_Model_Resource_Wishlist getResource()
 33:  * @method int getShared()
 34:  * @method Mage_Wishlist_Model_Wishlist setShared(int $value)
 35:  * @method string getSharingCode()
 36:  * @method Mage_Wishlist_Model_Wishlist setSharingCode(string $value)
 37:  * @method string getUpdatedAt()
 38:  * @method Mage_Wishlist_Model_Wishlist setUpdatedAt(string $value)
 39:  *
 40:  * @category    Mage
 41:  * @package     Mage_Wishlist
 42:  * @author      Magento Core Team <core@magentocommerce.com>
 43:  */
 44: class Mage_Wishlist_Model_Wishlist extends Mage_Core_Model_Abstract
 45: {
 46:     /**
 47:      * Prefix of model events names
 48:      *
 49:      * @var string
 50:      */
 51:     protected $_eventPrefix = 'wishlist';
 52:     /**
 53:      * Wishlist item collection
 54:      *
 55:      * @var Mage_Wishlist_Model_Mysql4_Item_Collection
 56:      */
 57:     protected $_itemCollection = null;
 58: 
 59:     /**
 60:      * Store filter for wishlist
 61:      *
 62:      * @var Mage_Core_Model_Store
 63:      */
 64:     protected $_store = null;
 65: 
 66:     /**
 67:      * Shared store ids (website stores)
 68:      *
 69:      * @var array
 70:      */
 71:     protected $_storeIds = null;
 72: 
 73:     /**
 74:      * Initialize resource model
 75:      */
 76:     protected function _construct()
 77:     {
 78:         $this->_init('wishlist/wishlist');
 79:     }
 80: 
 81:     /**
 82:      * Load wishlist by customer
 83:      *
 84:      * @param mixed $customer
 85:      * @param bool $create Create wishlist if don't exists
 86:      * @return Mage_Wishlist_Model_Wishlist
 87:      */
 88:     public function loadByCustomer($customer, $create = false)
 89:     {
 90:         if ($customer instanceof Mage_Customer_Model_Customer) {
 91:             $customer = $customer->getId();
 92:         }
 93: 
 94:         $customer = (int) $customer;
 95:         $customerIdFieldName = $this->_getResource()->getCustomerIdFieldName();
 96:         $this->_getResource()->load($this, $customer, $customerIdFieldName);
 97:         if (!$this->getId() && $create) {
 98:             $this->setCustomerId($customer);
 99:             $this->setSharingCode($this->_getSharingRandomCode());
100:             $this->save();
101:         }
102: 
103:         return $this;
104:     }
105: 
106:     /**
107:      * Retrieve wishlist name
108:      *
109:      * @return string
110:      */
111:     public function getName()
112:     {
113:         $name = $this->_getData('name');
114:         if (!strlen($name)) {
115:             return Mage::helper('wishlist')->getDefaultWishlistName();
116:         }
117:         return $name;
118:     }
119: 
120:     /**
121:      * Set random sharing code
122:      *
123:      * @return Mage_Wishlist_Model_Wishlist
124:      */
125:     public function generateSharingCode()
126:     {
127:         $this->setSharingCode($this->_getSharingRandomCode());
128:         return $this;
129:     }
130: 
131:     /**
132:      * Load by sharing code
133:      *
134:      * @param string $code
135:      * @return Mage_Wishlist_Model_Wishlist
136:      */
137:     public function loadByCode($code)
138:     {
139:         $this->_getResource()->load($this, $code, 'sharing_code');
140:         if(!$this->getShared()) {
141:             $this->setId(null);
142:         }
143: 
144:         return $this;
145:     }
146: 
147:     /**
148:      * Retrieve sharing code (random string)
149:      *
150:      * @return string
151:      */
152:     protected function _getSharingRandomCode()
153:     {
154:         return Mage::helper('core')->uniqHash();
155:     }
156: 
157:     /**
158:      * Set date of last update for wishlist
159:      *
160:      * @return Mage_Wishlist_Model_Wishlist
161:      */
162:     protected function _beforeSave()
163:     {
164:         parent::_beforeSave();
165:         $this->setUpdatedAt(Mage::getSingleton('core/date')->gmtDate());
166:         return $this;
167:     }
168: 
169:     /**
170:      * Save related items
171:      *
172:      * @return Mage_Sales_Model_Quote
173:      */
174:     protected function _afterSave()
175:     {
176:         parent::_afterSave();
177: 
178:         if (null !== $this->_itemCollection) {
179:             $this->getItemCollection()->save();
180:         }
181:         return $this;
182:     }
183: 
184:     /**
185:      * Add catalog product object data to wishlist
186:      *
187:      * @param   Mage_Catalog_Model_Product $product
188:      * @param   int $qty
189:      * @param   bool $forciblySetQty
190:      *
191:      * @return  Mage_Wishlist_Model_Item
192:      */
193:     protected function _addCatalogProduct(Mage_Catalog_Model_Product $product, $qty = 1, $forciblySetQty = false)
194:     {
195:         $item = null;
196:         foreach ($this->getItemCollection() as $_item) {
197:             if ($_item->representProduct($product)) {
198:                 $item = $_item;
199:                 break;
200:             }
201:         }
202: 
203:         if ($item === null) {
204:             $storeId = $product->hasWishlistStoreId() ? $product->getWishlistStoreId() : $this->getStore()->getId();
205:             $item = Mage::getModel('wishlist/item');
206:             $item->setProductId($product->getId())
207:                 ->setWishlistId($this->getId())
208:                 ->setAddedAt(now())
209:                 ->setStoreId($storeId)
210:                 ->setOptions($product->getCustomOptions())
211:                 ->setProduct($product)
212:                 ->setQty($qty)
213:                 ->save();
214:             if ($item->getId()) {
215:                 $this->getItemCollection()->addItem($item);
216:             }
217:         } else {
218:             $qty = $forciblySetQty ? $qty : $item->getQty() + $qty;
219:             $item->setQty($qty)
220:                 ->save();
221:         }
222: 
223:         $this->addItem($item);
224: 
225:         return $item;
226:     }
227: 
228:     /**
229:      * Retrieve wishlist item collection
230:      *
231:      * @return Mage_Wishlist_Model_Mysql4_Item_Collection
232:      */
233:     public function getItemCollection()
234:     {
235:         if (is_null($this->_itemCollection)) {
236:             /** @var $currentWebsiteOnly boolean */
237:             $currentWebsiteOnly = !Mage::app()->getStore()->isAdmin();
238:             $this->_itemCollection =  Mage::getResourceModel('wishlist/item_collection')
239:                 ->addWishlistFilter($this)
240:                 ->addStoreFilter($this->getSharedStoreIds($currentWebsiteOnly))
241:                 ->setVisibilityFilter();
242:         }
243: 
244:         return $this->_itemCollection;
245:     }
246: 
247:     /**
248:      * Retrieve wishlist item collection
249:      *
250:      * @param int $itemId
251:      * @return Mage_Wishlist_Model_Item
252:      */
253:     public function getItem($itemId)
254:     {
255:         if (!$itemId) {
256:             return false;
257:         }
258:         return $this->getItemCollection()->getItemById($itemId);
259:     }
260: 
261:     /**
262:      * Retrieve Product collection
263:      *
264:      * @deprecated after 1.4.2.0
265:      * @see Mage_Wishlist_Model_Wishlist::getItemCollection()
266:      *
267:      * @return Mage_Wishlist_Model_Mysql4_Product_Collection
268:      */
269:     public function getProductCollection()
270:     {
271:         $collection = $this->getData('product_collection');
272:         if (is_null($collection)) {
273:             $collection = Mage::getResourceModel('wishlist/product_collection');
274:             $this->setData('product_collection', $collection);
275:         }
276:         return $collection;
277:     }
278: 
279:     /**
280:      * Adding item to wishlist
281:      *
282:      * @param   Mage_Wishlist_Model_Item $item
283:      * @return  Mage_Wishlist_Model_Wishlist
284:      */
285:     public function addItem(Mage_Wishlist_Model_Item $item)
286:     {
287:         $item->setWishlist($this);
288:         if (!$item->getId()) {
289:             $this->getItemCollection()->addItem($item);
290:             Mage::dispatchEvent('wishlist_add_item', array('item' => $item));
291:         }
292:         return $this;
293:     }
294: 
295:     /**
296:      * Adds new product to wishlist.
297:      * Returns new item or string on error.
298:      *
299:      * @param int|Mage_Catalog_Model_Product $product
300:      * @param mixed $buyRequest
301:      * @param bool $forciblySetQty
302:      * @return Mage_Wishlist_Model_Item|string
303:      */
304:     public function addNewItem($product, $buyRequest = null, $forciblySetQty = false)
305:     {
306:         /*
307:          * Always load product, to ensure:
308:          * a) we have new instance and do not interfere with other products in wishlist
309:          * b) product has full set of attributes
310:          */
311:         if ($product instanceof Mage_Catalog_Model_Product) {
312:             $productId = $product->getId();
313:             // Maybe force some store by wishlist internal properties
314:             $storeId = $product->hasWishlistStoreId() ? $product->getWishlistStoreId() : $product->getStoreId();
315:         } else {
316:             $productId = (int) $product;
317:             if ($buyRequest->getStoreId()) {
318:                 $storeId = $buyRequest->getStoreId();
319:             } else {
320:                 $storeId = Mage::app()->getStore()->getId();
321:             }
322:         }
323: 
324:         /* @var $product Mage_Catalog_Model_Product */
325:         $product = Mage::getModel('catalog/product')
326:             ->setStoreId($storeId)
327:             ->load($productId);
328: 
329:         if ($buyRequest instanceof Varien_Object) {
330:             $_buyRequest = $buyRequest;
331:         } elseif (is_string($buyRequest)) {
332:             $_buyRequest = new Varien_Object(unserialize($buyRequest));
333:         } elseif (is_array($buyRequest)) {
334:             $_buyRequest = new Varien_Object($buyRequest);
335:         } else {
336:             $_buyRequest = new Varien_Object();
337:         }
338: 
339:         $cartCandidates = $product->getTypeInstance(true)
340:             ->processConfiguration($_buyRequest, $product);
341: 
342:         /**
343:          * Error message
344:          */
345:         if (is_string($cartCandidates)) {
346:             return $cartCandidates;
347:         }
348: 
349:         /**
350:          * If prepare process return one object
351:          */
352:         if (!is_array($cartCandidates)) {
353:             $cartCandidates = array($cartCandidates);
354:         }
355: 
356:         $errors = array();
357:         $items = array();
358: 
359:         foreach ($cartCandidates as $candidate) {
360:             if ($candidate->getParentProductId()) {
361:                 continue;
362:             }
363:             $candidate->setWishlistStoreId($storeId);
364: 
365:             $qty = $candidate->getQty() ? $candidate->getQty() : 1; // No null values as qty. Convert zero to 1.
366:             $item = $this->_addCatalogProduct($candidate, $qty, $forciblySetQty);
367:             $items[] = $item;
368: 
369:             // Collect errors instead of throwing first one
370:             if ($item->getHasError()) {
371:                 $errors[] = $item->getMessage();
372:             }
373:         }
374: 
375:         Mage::dispatchEvent('wishlist_product_add_after', array('items' => $items));
376: 
377:         return $item;
378:     }
379: 
380:     /**
381:      * Set customer id
382:      *
383:      * @param int $customerId
384:      * @return Mage_Wishlist_Model_Wishlist
385:      */
386:     public function setCustomerId($customerId)
387:     {
388:         return $this->setData($this->_getResource()->getCustomerIdFieldName(), $customerId);
389:     }
390: 
391:     /**
392:      * Retrieve customer id
393:      *
394:      * @return int
395:      */
396:     public function getCustomerId()
397:     {
398:         return $this->getData($this->_getResource()->getCustomerIdFieldName());
399:     }
400: 
401:     /**
402:      * Retrieve data for save
403:      *
404:      * @return array
405:      */
406:     public function getDataForSave()
407:     {
408:         $data = array();
409:         $data[$this->_getResource()->getCustomerIdFieldName()] = $this->getCustomerId();
410:         $data['shared']      = (int) $this->getShared();
411:         $data['sharing_code']= $this->getSharingCode();
412:         return $data;
413:     }
414: 
415:     /**
416:      * Retrieve shared store ids for current website or all stores if $current is false
417:      *
418:      * @param bool $current Use current website or not
419:      * @return array
420:      */
421:     public function getSharedStoreIds($current = true)
422:     {
423:         if (is_null($this->_storeIds) || !is_array($this->_storeIds)) {
424:             if ($current) {
425:                 $this->_storeIds = $this->getStore()->getWebsite()->getStoreIds();
426:             } else {
427:                 $_storeIds = array();
428:                 $stores = Mage::app()->getStores();
429:                 foreach ($stores as $store) {
430:                     $_storeIds[] = $store->getId();
431:                 }
432:                 $this->_storeIds = $_storeIds;
433:             }
434:         }
435:         return $this->_storeIds;
436:     }
437: 
438:     /**
439:      * Set shared store ids
440:      *
441:      * @param array $storeIds
442:      * @return Mage_Wishlist_Model_Wishlist
443:      */
444:     public function setSharedStoreIds($storeIds)
445:     {
446:         $this->_storeIds = (array) $storeIds;
447:         return $this;
448:     }
449: 
450:     /**
451:      * Retrieve wishlist store object
452:      *
453:      * @return Mage_Core_Model_Store
454:      */
455:     public function getStore()
456:     {
457:         if (is_null($this->_store)) {
458:             $this->setStore(Mage::app()->getStore());
459:         }
460:         return $this->_store;
461:     }
462: 
463:     /**
464:      * Set wishlist store
465:      *
466:      * @param Mage_Core_Model_Store $store
467:      * @return Mage_Wishlist_Model_Wishlist
468:      */
469:     public function setStore($store)
470:     {
471:         $this->_store = $store;
472:         return $this;
473:     }
474: 
475:     /**
476:      * Retrieve wishlist items count
477:      *
478:      * @return int
479:      */
480:     public function getItemsCount()
481:     {
482:         return $this->getItemCollection()->getSize();
483:     }
484: 
485:     /**
486:      * Retrieve wishlist has salable item(s)
487:      *
488:      * @return bool
489:      */
490:     public function isSalable()
491:     {
492:         foreach ($this->getItemCollection() as $item) {
493:             if ($item->getProduct()->getIsSalable()) {
494:                 return true;
495:             }
496:         }
497:         return false;
498:     }
499: 
500:     /**
501:      * Check customer is owner this wishlist
502:      *
503:      * @param int $customerId
504:      * @return bool
505:      */
506:     public function isOwner($customerId)
507:     {
508:         return $customerId == $this->getCustomerId();
509:     }
510: 
511: 
512:     /**
513:      * Update wishlist Item and set data from request
514:      *
515:      * $params sets how current item configuration must be taken into account and additional options.
516:      * It's passed to Mage_Catalog_Helper_Product->addParamsToBuyRequest() to compose resulting buyRequest.
517:      *
518:      * Basically it can hold
519:      * - 'current_config', Varien_Object or array - current buyRequest that configures product in this item,
520:      *   used to restore currently attached files
521:      * - 'files_prefix': string[a-z0-9_] - prefix that was added at frontend to names of file options (file inputs), so they won't
522:      *   intersect with other submitted options
523:      *
524:      * For more options see Mage_Catalog_Helper_Product->addParamsToBuyRequest()
525:      *
526:      * @param int|Mage_Wishlist_Model_Item $itemId
527:      * @param Varien_Object $buyRequest
528:      * @param null|array|Varien_Object $params
529:      * @return Mage_Wishlist_Model_Wishlist
530:      *
531:      * @see Mage_Catalog_Helper_Product::addParamsToBuyRequest()
532:      */
533:     public function updateItem($itemId, $buyRequest, $params = null)
534:     {
535:         $item = null;
536:         if ($itemId instanceof Mage_Wishlist_Model_Item) {
537:             $item = $itemId;
538:         } else {
539:             $item = $this->getItem((int)$itemId);
540:         }
541:         if (!$item) {
542:             Mage::throwException(Mage::helper('wishlist')->__('Cannot specify wishlist item.'));
543:         }
544: 
545:         $product = $item->getProduct();
546:         $productId = $product->getId();
547:         if ($productId) {
548:             if (!$params) {
549:                 $params = new Varien_Object();
550:             } else if (is_array($params)) {
551:                 $params = new Varien_Object($params);
552:             }
553:             $params->setCurrentConfig($item->getBuyRequest());
554:             $buyRequest = Mage::helper('catalog/product')->addParamsToBuyRequest($buyRequest, $params);
555: 
556:             $product->setWishlistStoreId($item->getStoreId());
557:             $items = $this->getItemCollection();
558:             $isForceSetQuantity = true;
559:             foreach ($items as $_item) {
560:                 /* @var $_item Mage_Wishlist_Model_Item */
561:                 if ($_item->getProductId() == $product->getId()
562:                     && $_item->representProduct($product)
563:                     && $_item->getId() != $item->getId()) {
564:                     // We do not add new wishlist item, but updating the existing one
565:                     $isForceSetQuantity = false;
566:                 }
567:             }
568:             $resultItem = $this->addNewItem($product, $buyRequest, $isForceSetQuantity);
569:             /**
570:              * Error message
571:              */
572:             if (is_string($resultItem)) {
573:                 Mage::throwException(Mage::helper('checkout')->__($resultItem));
574:             }
575: 
576:             if ($resultItem->getId() != $itemId) {
577:                 if ($resultItem->getDescription() != $item->getDescription()) {
578:                     $resultItem->setDescription($item->getDescription())->save();
579:                 }
580:                 $item->isDeleted(true);
581:                 $this->setDataChanges(true);
582:             } else {
583:                 $resultItem->setQty($buyRequest->getQty() * 1);
584:                 $resultItem->setOrigData('qty', 0);
585:             }
586:         } else {
587:             Mage::throwException(Mage::helper('checkout')->__('The product does not exist.'));
588:         }
589:         return $this;
590:     }
591: 
592:     /**
593:      * Save wishlist.
594:      *
595:      * @return Mage_Wishlist_Model_Wishlist
596:      */
597:     public function save()
598:     {
599:         $this->_hasDataChanges = true;
600:         return parent::save();
601:     }
602: }
603: