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 category helper
 29:  *
 30:  * @category   Mage
 31:  * @package    Mage_Catalog
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_Catalog_Helper_Category extends Mage_Core_Helper_Abstract
 35: {
 36:     const XML_PATH_CATEGORY_URL_SUFFIX          = 'catalog/seo/category_url_suffix';
 37:     const XML_PATH_USE_CATEGORY_CANONICAL_TAG   = 'catalog/seo/category_canonical_tag';
 38:     const XML_PATH_CATEGORY_ROOT_ID             = 'catalog/category/root_id';
 39: 
 40:     /**
 41:      * Store categories cache
 42:      *
 43:      * @var array
 44:      */
 45:     protected $_storeCategories = array();
 46: 
 47:     /**
 48:      * Cache for category rewrite suffix
 49:      *
 50:      * @var array
 51:      */
 52:     protected $_categoryUrlSuffix = array();
 53: 
 54:     /**
 55:      * Retrieve current store categories
 56:      *
 57:      * @param   boolean|string $sorted
 58:      * @param   boolean $asCollection
 59:      * @return  Varien_Data_Tree_Node_Collection|Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Collection|array
 60:      */
 61:     public function getStoreCategories($sorted=false, $asCollection=false, $toLoad=true)
 62:     {
 63:         $parent     = Mage::app()->getStore()->getRootCategoryId();
 64:         $cacheKey   = sprintf('%d-%d-%d-%d', $parent, $sorted, $asCollection, $toLoad);
 65:         if (isset($this->_storeCategories[$cacheKey])) {
 66:             return $this->_storeCategories[$cacheKey];
 67:         }
 68: 
 69:         /**
 70:          * Check if parent node of the store still exists
 71:          */
 72:         $category = Mage::getModel('catalog/category');
 73:         /* @var $category Mage_Catalog_Model_Category */
 74:         if (!$category->checkId($parent)) {
 75:             if ($asCollection) {
 76:                 return new Varien_Data_Collection();
 77:             }
 78:             return array();
 79:         }
 80: 
 81:         $recursionLevel  = max(0, (int) Mage::app()->getStore()->getConfig('catalog/navigation/max_depth'));
 82:         $storeCategories = $category->getCategories($parent, $recursionLevel, $sorted, $asCollection, $toLoad);
 83: 
 84:         $this->_storeCategories[$cacheKey] = $storeCategories;
 85:         return $storeCategories;
 86:     }
 87: 
 88:     /**
 89:      * Retrieve category url
 90:      *
 91:      * @param   Mage_Catalog_Model_Category $category
 92:      * @return  string
 93:      */
 94:     public function getCategoryUrl($category)
 95:     {
 96:         if ($category instanceof Mage_Catalog_Model_Category) {
 97:             return $category->getUrl();
 98:         }
 99:         return Mage::getModel('catalog/category')
100:             ->setData($category->getData())
101:             ->getUrl();
102:     }
103: 
104:     /**
105:      * Check if a category can be shown
106:      *
107:      * @param  Mage_Catalog_Model_Category|int $category
108:      * @return boolean
109:      */
110:     public function canShow($category)
111:     {
112:         if (is_int($category)) {
113:             $category = Mage::getModel('catalog/category')->load($category);
114:         }
115: 
116:         if (!$category->getId()) {
117:             return false;
118:         }
119: 
120:         if (!$category->getIsActive()) {
121:             return false;
122:         }
123:         if (!$category->isInRootCategoryList()) {
124:             return false;
125:         }
126: 
127:         return true;
128:     }
129: 
130: /**
131:      * Retrieve category rewrite sufix for store
132:      *
133:      * @param int $storeId
134:      * @return string
135:      */
136:     public function getCategoryUrlSuffix($storeId = null)
137:     {
138:         if (is_null($storeId)) {
139:             $storeId = Mage::app()->getStore()->getId();
140:         }
141: 
142:         if (!isset($this->_categoryUrlSuffix[$storeId])) {
143:             $this->_categoryUrlSuffix[$storeId] = Mage::getStoreConfig(self::XML_PATH_CATEGORY_URL_SUFFIX, $storeId);
144:         }
145:         return $this->_categoryUrlSuffix[$storeId];
146:     }
147: 
148:     /**
149:      * Retrieve clear url for category as parrent
150:      *
151:      * @param string $url
152:      * @param bool $slash
153:      * @param int $storeId
154:      *
155:      * @return string
156:      */
157:     public function getCategoryUrlPath($urlPath, $slash = false, $storeId = null)
158:     {
159:         if (!$this->getCategoryUrlSuffix($storeId)) {
160:             return $urlPath;
161:         }
162: 
163:         if ($slash) {
164:             $regexp     = '#('.preg_quote($this->getCategoryUrlSuffix($storeId), '#').')/$#i';
165:             $replace    = '/';
166:         }
167:         else {
168:             $regexp     = '#('.preg_quote($this->getCategoryUrlSuffix($storeId), '#').')$#i';
169:             $replace    = '';
170:         }
171: 
172:         return preg_replace($regexp, $replace, $urlPath);
173:     }
174: 
175:     /**
176:      * Check if <link rel="canonical"> can be used for category
177:      *
178:      * @param $store
179:      * @return bool
180:      */
181:     public function canUseCanonicalTag($store = null)
182:     {
183:         return Mage::getStoreConfig(self::XML_PATH_USE_CATEGORY_CANONICAL_TAG, $store);
184:     }
185: }
186: