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_XmlConnect
 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:  * Product list xml renderer
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_XmlConnect
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_XmlConnect_Block_Catalog_Product_List extends Mage_XmlConnect_Block_Catalog_Product
 35: {
 36:     /**
 37:      * Store product collection
 38:      *
 39:      * @var Mage_Eav_Model_Entity_Collection_Abstract
 40:      */
 41:     protected $_productCollection = null;
 42: 
 43:     /**
 44:      * Store collected layered navigation filters whike applying them
 45:      *
 46:      * @var array
 47:      */
 48:     protected $_collectedFilters = array();
 49: 
 50:     /**
 51:      * Produce products list xml object
 52:      *
 53:      * @return Mage_XmlConnect_Model_Simplexml_Element
 54:      */
 55:     public function getProductsXmlObject()
 56:     {
 57:         $productsXmlObj = Mage::getModel('xmlconnect/simplexml_element', '<products></products>');
 58:         $collection     = $this->_getProductCollection();
 59: 
 60:         if (!$collection) {
 61:             return false;
 62:         }
 63:         foreach ($collection->getItems() as $product) {
 64:             $productXmlObj = $this->productToXmlObject($product);
 65:             if ($productXmlObj) {
 66:                 $productsXmlObj->appendChild($productXmlObj);
 67:             }
 68:         }
 69: 
 70:         return $productsXmlObj;
 71:     }
 72: 
 73:     /**
 74:      * Getter for collected layered navigation filters
 75:      *
 76:      * @return array
 77:      */
 78:     public function getCollectedFilters()
 79:     {
 80:         return $this->_collectedFilters;
 81:     }
 82: 
 83:     /**
 84:      * Retrieve product collection with all prepared data and limitations
 85:      *
 86:      * @return Mage_Eav_Model_Entity_Collection_Abstract
 87:      */
 88:     protected function _getProductCollection()
 89:     {
 90:         if (is_null($this->_productCollection)) {
 91:             $filters        = array();
 92:             $request        = $this->getRequest();
 93:             $requestParams  = $request->getParams();
 94:             $layer          = $this->getLayer();
 95:             if (!$layer) {
 96:                 return null;
 97:             }
 98:             $category       = $this->getCategory();
 99:             if ($category && is_object($category) && $category->getId()) {
100:                 $layer->setCurrentCategory($category);
101:             }
102:             if (!$this->getNeedBlockApplyingFilters()) {
103:                 $attributes     = $layer->getFilterableAttributes();
104:                 /**
105:                  * Apply filters
106:                  */
107:                 foreach ($attributes as $attributeItem) {
108:                     $attributeCode  = $attributeItem->getAttributeCode();
109:                     list($filterModel, $filterBlock) = $this->helper('xmlconnect')->getFilterByKey($attributeCode);
110: 
111:                     $filterModel->setLayer($layer)->setAttributeModel($attributeItem);
112: 
113:                     $filterParam = parent::REQUEST_FILTER_PARAM_REFIX . $attributeCode;
114:                     /**
115:                      * Set new request var
116:                      */
117:                     if (isset($requestParams[$filterParam])) {
118:                         $filterModel->setRequestVar($filterParam);
119:                     }
120:                     $filterModel->apply($request, $filterBlock);
121:                     $filters[] = $filterModel;
122:                 }
123: 
124:                 /**
125:                  * Separately apply and save category filter
126:                  */
127:                 list($categoryFilter, $categoryFilterBlock) = $this->helper('xmlconnect')->getFilterByKey('category');
128:                 $filterParam = parent::REQUEST_FILTER_PARAM_REFIX . $categoryFilter->getRequestVar();
129:                 $categoryFilter->setLayer($layer)->setRequestVar($filterParam)
130:                     ->apply($this->getRequest(), $categoryFilterBlock);
131:                 $filters[] = $categoryFilter;
132: 
133:                 $this->_collectedFilters = $filters;
134:             }
135: 
136:             /**
137:              * Products
138:              */
139:             $layer      = $this->getLayer();
140:             $collection = $layer->getProductCollection();
141: 
142:             /**
143:              * Add rating and review summary, image attribute, apply sort params
144:              */
145:             $this->_prepareCollection($collection);
146: 
147:             /**
148:              * Apply offset and count
149:              */
150:             $offset = (int)$request->getParam('offset', 0);
151:             $count  = (int)$request->getParam('count', 0);
152:             $count  = $count <= 0 ? 1 : $count;
153:             if ($offset + $count < $collection->getSize()) {
154:                 $this->setHasProductItems(1);
155:             }
156:             $collection->getSelect()->limit($count, $offset);
157:             $collection->setFlag('require_stock_items', true);
158: 
159:             $this->_productCollection = $collection;
160:         }
161:         return $this->_productCollection;
162:     }
163: 
164:     /**
165:      * Add image attribute and apply sort fields to product collection
166:      *
167:      * @param Mage_Eav_Model_Entity_Collection_Abstract $collection
168:      * @return Mage_XmlConnect_Block_Catalog_Product_List
169:      */
170:     protected function _prepareCollection($collection)
171:     {
172:         /**
173:          * Apply sort params
174:          */
175:         $reguest = $this->getRequest();
176:         foreach ($reguest->getParams() as $key => $value) {
177:             if (0 === strpos($key, parent::REQUEST_SORT_ORDER_PARAM_REFIX)) {
178:                 $key = str_replace(parent::REQUEST_SORT_ORDER_PARAM_REFIX, '', $key);
179:                 if ($value != 'desc') {
180:                     $value = 'asc';
181:                 }
182:                 $collection->addAttributeToSort($key, $value);
183:             }
184:         }
185:         $collection->addAttributeToSelect(array('image', 'name', 'description'));
186: 
187:         return $this;
188:     }
189: 
190:     /**
191:      * Render products list xml
192:      *
193:      * @return string
194:      */
195:     protected function _toHtml()
196:     {
197:         return $this->getProductsXmlObject()->asNiceXml();
198:     }
199: }
200: