Docs For Class Mage_Catalog_Helper

Description

Catalog category helper

author: Magento Core Team <[email protected]>

Located in /Catalog/Helper/Category.php (line 34)

Mage_Core_Helper_Abstract
   |
   --Mage_Catalog_Helper_Category

Class Constant Summary

XML_PATH_CATEGORY_URL_SUFFIX = 'catalog/seo/category_url_suffix'

XML_PATH_USE_CATEGORY_CANONICAL_TAG = 'catalog/seo/category_canonical_tag'

Variable Summary

array $_categoryUrlSuffix

array $_storeCategories

Method Summary

boolean canShow (Mage_Catalog_Model_Category|int $category)

bool canUseCanonicalTag ([$store $store = null])

string getCategoryUrl (Mage_Catalog_Model_Category $category)

string getCategoryUrlPath ( $urlPath, [bool $slash = false], [int $storeId = null], string $url)

string getCategoryUrlSuffix ([int $storeId = null])

Varien_Data_Tree_Node_Collection|Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Collection|array getStoreCategories ([boolean|string $sorted = false], [boolean $asCollection = false], [ $toLoad = true])

Variables

array $_categoryUrlSuffix = array() (line 52)

Cache for category rewrite suffix

access: protected

array $_storeCategories = array() (line 45)

Store categories cache

access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

canShow (line 110)

Check if a category can be shown

access: public

boolean canShow (Mage_Catalog_Model_Category|int $category)

Mage_Catalog_Model_Category|int $category

canUseCanonicalTag (line 181)

Check if <link rel="canonical"> can be used for category

access: public

bool canUseCanonicalTag ([$store $store = null])

$store $store

getCategoryUrl (line 94)

Retrieve category url

access: public

string getCategoryUrl (Mage_Catalog_Model_Category $category)

Mage_Catalog_Model_Category $category

getCategoryUrlPath (line 157)

Retrieve clear url for category as parrent

access: public

string getCategoryUrlPath ( $urlPath, [bool $slash = false], [int $storeId = null], string $url)

string $url
bool $slash
int $storeId
$urlPath

getCategoryUrlSuffix (line 136)

Retrieve category rewrite sufix for store

access: public

string getCategoryUrlSuffix ([int $storeId = null])

int $storeId

getStoreCategories (line 61)

Retrieve current store categories

access: public

Varien_Data_Tree_Node_Collection|Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Collection|array getStoreCategories ([boolean|string $sorted = false], [boolean $asCollection = false], [ $toLoad = true])

boolean|string $sorted
boolean $asCollection
$toLoad

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

XML_PATH_CATEGORY_URL_SUFFIX = 'catalog/seo/category_url_suffix' (line 36)

XML_PATH_USE_CATEGORY_CANONICAL_TAG = 'catalog/seo/category_canonical_tag' (line 37)

Class Mage_Catalog_Helper_Category

Inherited Variables

Inherited Methods