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: /**
 29:  * Catalog Product Compare Helper
 30:  *
 31:  * @category   Mage
 32:  * @package    Mage_Catalog
 33:  * @author     Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Catalog_Helper_Product_Compare extends Mage_Core_Helper_Url
 36: {
 37:     /**
 38:      * Product Compare Items Collection
 39:      *
 40:      * @var Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Compare_Item_Collection
 41:      */
 42:     protected $_itemCollection;
 43: 
 44:     /**
 45:      * Product Comapare Items Collection has items flag
 46:      *
 47:      * @var bool
 48:      */
 49:     protected $_hasItems;
 50: 
 51:     /**
 52:      * Allow used Flat catalog product for product compare items collection
 53:      *
 54:      * @var bool
 55:      */
 56:     protected $_allowUsedFlat = true;
 57: 
 58:     /**
 59:      * Customer id
 60:      *
 61:      * @var null|int
 62:      */
 63:     protected $_customerId = null;
 64: 
 65:     /**
 66:      * Retrieve Catalog Session instance
 67:      *
 68:      * @return Mage_Catalog_Model_Session
 69:      */
 70:     protected function _getSession()
 71:     {
 72:         return Mage::getSingleton('catalog/session');
 73:     }
 74: 
 75:     /**
 76:      * Retrieve compare list url
 77:      *
 78:      * @return string
 79:      */
 80:     public function getListUrl()
 81:     {
 82:          $itemIds = array();
 83:          foreach ($this->getItemCollection() as $item) {
 84:              $itemIds[] = $item->getId();
 85:          }
 86: 
 87:          $params = array(
 88:             'items'=>implode(',', $itemIds),
 89:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
 90:          );
 91: 
 92:          return $this->_getUrl('catalog/product_compare', $params);
 93:     }
 94: 
 95:     /**
 96:      * Get parameters used for build add product to compare list urls
 97:      *
 98:      * @param   Mage_Catalog_Model_Product $product
 99:      * @return  array
100:      */
101:     protected function _getUrlParams($product)
102:     {
103:         return array(
104:             'product' => $product->getId(),
105:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
106:         );
107:     }
108: 
109:     /**
110:      * Retrieve url for adding product to conpare list
111:      *
112:      * @param   Mage_Catalog_Model_Product $product
113:      * @return  string
114:      */
115:     public function getAddUrl($product)
116:     {
117:         return $this->_getUrl('catalog/product_compare/add', $this->_getUrlParams($product));
118:     }
119: 
120:     /**
121:      * Retrive add to wishlist url
122:      *
123:      * @param Mage_Catalog_Model_Product $product
124:      * @return string
125:      */
126:     public function getAddToWishlistUrl($product)
127:     {
128:         $beforeCompareUrl = Mage::getSingleton('catalog/session')->getBeforeCompareUrl();
129: 
130:         $params = array(
131:             'product'=>$product->getId(),
132:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl)
133:         );
134: 
135:         return $this->_getUrl('wishlist/index/add', $params);
136:     }
137: 
138:     /**
139:      * Retrive add to cart url
140:      *
141:      * @param Mage_Catalog_Model_Product $product
142:      * @return string
143:      */
144:     public function getAddToCartUrl($product)
145:     {
146:         $beforeCompareUrl = Mage::getSingleton('catalog/session')->getBeforeCompareUrl();
147:         $params = array(
148:             'product'=>$product->getId(),
149:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl($beforeCompareUrl)
150:         );
151: 
152:         return $this->_getUrl('checkout/cart/add', $params);
153:     }
154: 
155:     /**
156:      * Retrieve remove item from compare list url
157:      *
158:      * @param   $item
159:      * @return  string
160:      */
161:     public function getRemoveUrl($item)
162:     {
163:         $params = array(
164:             'product'=>$item->getId(),
165:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
166:         );
167:         return $this->_getUrl('catalog/product_compare/remove', $params);
168:     }
169: 
170:     /**
171:      * Retrieve clear compare list url
172:      *
173:      * @return string
174:      */
175:     public function getClearListUrl()
176:     {
177:         $params = array(
178:             Mage_Core_Controller_Front_Action::PARAM_NAME_URL_ENCODED => $this->getEncodedUrl()
179:         );
180:         return $this->_getUrl('catalog/product_compare/clear', $params);
181:     }
182: 
183:     /**
184:      * Retrieve compare list items collection
185:      *
186:      * @return Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Compare_Item_Collection
187:      */
188:     public function getItemCollection()
189:     {
190:         if (!$this->_itemCollection) {
191:             $this->_itemCollection = Mage::getResourceModel('catalog/product_compare_item_collection')
192:                 ->useProductItem(true)
193:                 ->setStoreId(Mage::app()->getStore()->getId());
194: 
195:             if (Mage::getSingleton('customer/session')->isLoggedIn()) {
196:                 $this->_itemCollection->setCustomerId(Mage::getSingleton('customer/session')->getCustomerId());
197:             } elseif ($this->_customerId) {
198:                 $this->_itemCollection->setCustomerId($this->_customerId);
199:             } else {
200:                 $this->_itemCollection->setVisitorId(Mage::getSingleton('log/visitor')->getId());
201:             }
202: 
203:             Mage::getSingleton('catalog/product_visibility')
204:                 ->addVisibleInSiteFilterToCollection($this->_itemCollection);
205: 
206:             /* Price data is added to consider item stock status using price index */
207:             $this->_itemCollection->addPriceData();
208: 
209:             $this->_itemCollection->addAttributeToSelect('name')
210:                 ->addUrlRewrite()
211:                 ->load();
212: 
213:             /* update compare items count */
214:             $this->_getSession()->setCatalogCompareItemsCount(count($this->_itemCollection));
215:         }
216: 
217:         return $this->_itemCollection;
218:     }
219: 
220:     /**
221:      * Calculate cache product compare collection
222:      *
223:      * @param  bool $logout
224:      * @return Mage_Catalog_Helper_Product_Compare
225:      */
226:     public function calculate($logout = false)
227:     {
228:         // first visit
229:         if (!$this->_getSession()->hasCatalogCompareItemsCount() && !$this->_customerId) {
230:             $count = 0;
231:         } else {
232:             /** @var $collection Mage_Catalog_Model_Resource_Eav_Mysql4_Product_Compare_Item_Collection */
233:             $collection = Mage::getResourceModel('catalog/product_compare_item_collection')
234:                 ->useProductItem(true);
235:             if (!$logout && Mage::getSingleton('customer/session')->isLoggedIn()) {
236:                 $collection->setCustomerId(Mage::getSingleton('customer/session')->getCustomerId());
237:             } elseif ($this->_customerId) {
238:                 $collection->setCustomerId($this->_customerId);
239:             } else {
240:                 $collection->setVisitorId(Mage::getSingleton('log/visitor')->getId());
241:             }
242: 
243:             /* Price data is added to consider item stock status using price index */
244:             $collection->addPriceData();
245: 
246:             Mage::getSingleton('catalog/product_visibility')
247:                 ->addVisibleInSiteFilterToCollection($collection);
248: 
249:             $count = $collection->getSize();
250:         }
251: 
252:         $this->_getSession()->setCatalogCompareItemsCount($count);
253: 
254:         return $this;
255:     }
256: 
257:     /**
258:      * Retrieve count of items in compare list
259:      *
260:      * @return int
261:      */
262:     public function getItemCount()
263:     {
264:         if (!$this->_getSession()->hasCatalogCompareItemsCount()) {
265:             $this->calculate();
266:         }
267: 
268:         return $this->_getSession()->getCatalogCompareItemsCount();
269:     }
270: 
271:     /**
272:      * Check has items
273:      *
274:      * @return bool
275:      */
276:     public function hasItems()
277:     {
278:         return $this->getItemCount() > 0;
279:     }
280: 
281:     /**
282:      * Set is allow used flat (for collection)
283:      *
284:      * @param bool $flag
285:      * @return Mage_Catalog_Helper_Product_Compare
286:      */
287:     public function setAllowUsedFlat($flag)
288:     {
289:         $this->_allowUsedFlat = (bool)$flag;
290:         return $this;
291:     }
292: 
293:     /**
294:      * Retrieve is allow used flat (for collection)
295:      *
296:      * @return bool
297:      */
298:     public function getAllowUsedFlat()
299:     {
300:         return $this->_allowUsedFlat;
301:     }
302: 
303:     /**
304:      * Setter for customer id
305:      *
306:      * @param int $id
307:      * @return Mage_Catalog_Helper_Product_Compare
308:      */
309:     public function setCustomerId($id)
310:     {
311:         $this->_customerId = $id;
312:         return $this;
313:     }
314: }
315: