Class Mage_Catalog_Model_Category

Catalog category

Varien_Object

Mage_Catalog_Model_Category

Package: Mage\Catalog
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Catalog/Model/Category.php

Methods summary
`protected`	# `_construct( )` Initialize resource mode Initialize resource mode
`public Mage_Core_Model_Url`	# `getUrlInstance( )` Retrieve URL instance Retrieve URL instance Returns `Mage_Core_Model_Url`
`public Mage_Core_Model_Url_Rewrite`	# `getUrlRewrite( )` Get url rewrite model Get url rewrite model Returns `Mage_Core_Model_Url_Rewrite`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree`	# `getTreeModel( )` Retrieve category tree model Retrieve category tree model Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree`	# `getTreeModelInstance( )` Enter description here... Enter description here... Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree`
`public Mage_Catalog_Model_Category`	# `move( integer $parentId, integer $afterCategoryId )` Move category Move category Parameters `$parentId` `integer` $parentId new parent category id `$afterCategoryId` `integer` $afterCategoryId category id after which we have put current category Returns `Mage_Catalog_Model_Category`
`public integer`	# `getDefaultAttributeSetId( )` Retrieve default attribute set id Retrieve default attribute set id Returns `integer`
`public Varien_Data_Collection_Db`	# `getProductCollection( )` Get category products collection Get category products collection Returns `Varien_Data_Collection_Db`
`public array`	# `getAttributes( mixed $noDesignAttributes = false )` Retrieve all customer attributes Retrieve all customer attributes Returns `array`
`public array`	# `getProductsPosition( )` Retrieve array of product id's for category Retrieve array of product id's for category array($productId => $position) Returns `array`
`public array`	# `getStoreIds( )` Retrieve array of store ids for category Retrieve array of store ids for category Returns `array`
`public string`	# `getLayoutUpdateHandle( )` Retrieve Layout Update Handle name Retrieve Layout Update Handle name Returns `string`
`public integer`	# `getStoreId( )` Return store id. Return store id. If store id is underfined for category return current active store id Returns `integer`
`public Mage_Catalog_Model_Category`	# `setStoreId( integer $storeId )` Set store id Set store id Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Category`
`public string`	# `getUrl( )` Get category url Get category url Returns `string`
`public string`	# `getCategoryIdUrl( )` Retrieve category id URL Retrieve category id URL Returns `string`
`public string`	# `formatUrlKey( string $str )` Format URL key from name or defined key Format URL key from name or defined key Parameters `$str` `string` $str Returns `string`
`public string`	# `getImageUrl( )` Retrieve image URL Retrieve image URL Returns `string`
`public string`	# `getUrlPath( )` Retrieve URL path Retrieve URL path Returns `string`
`public Mage_Catalog_Model_Category`	# `getParentCategory( )` Get parent category object Get parent category object Returns `Mage_Catalog_Model_Category`
`public integer`	# `getParentId( )` Get parent category identifier Get parent category identifier Returns `integer`
`public array`	# `getParentIds( )` Get all parent categories ids Get all parent categories ids Returns `array`
`public array`	# `getCustomDesignDate( )` Retrieve dates for custom design (from & to) Retrieve dates for custom design (from & to) Returns `array`
`public array`	# `getDesignAttributes( )` Retrieve design attributes array Retrieve design attributes array Returns `array`
`private Mage_Eav_Model_Entity_Attribute_Abstract`	# `_getAttribute( string $attributeCode )` Retrieve attribute by code Retrieve attribute by code Parameters `$attributeCode` `string` $attributeCode Returns `Mage_Eav_Model_Entity_Attribute_Abstract`
`public array\|string`	# `getAllChildren( boolean $asArray = false )` Get all children categories IDs Get all children categories IDs Parameters `$asArray` `boolean` $asArray return result as array instead of comma-separated list of IDs Returns `array\|string`
`public string`	# `getChildren( )` Retrieve children ids comma separated Retrieve children ids comma separated Returns `string`
`public string`	# `getPathInStore( )` Retrieve Stores where isset category Path Return comma separated string Retrieve Stores where isset category Path Return comma separated string Returns `string`
`public boolean`	# `checkId( integer $id )` Check category id exising Check category id exising Parameters `$id` `integer` $id Returns `boolean`
`public array`	# `getPathIds( )` Get array categories ids which are part of category path Result array contain id of current category because it is part of the path Get array categories ids which are part of category path Result array contain id of current category because it is part of the path Returns `array`
`public integer`	# `getLevel( )` Retrieve level Retrieve level Returns `integer`
`public boolean`	# `verifyIds( array $ids )` Verify category ids Verify category ids Parameters `$ids` `array` $ids Returns `boolean`
`public boolean`	# `hasChildren( )` Retrieve Is Category has children flag Retrieve Is Category has children flag Returns `boolean`
`public string`	# `getRequestPath( )` Retrieve Request Path Retrieve Request Path Returns `string`
`public string`	# `getName( )` Retrieve Name data wrapper Retrieve Name data wrapper Returns `string`
`protected Mage_Catalog_Model_Category`	# `_beforeDelete( )` Before delete process Before delete process Returns `Mage_Catalog_Model_Category` Overrides `Mage_Core_Model_Abstract::_beforeDelete()`
`public array`	# `getAnchorsAbove( )` Retrieve anchors above Retrieve anchors above Returns `array`
`public integer`	# `getProductCount( )` Retrieve count products of category Retrieve count products of category Returns `integer`
`public mixed`	# `getCategories( integer $parent, integer $recursionLevel = 0, boolean $sorted = false, boolean $asCollection = false, boolean $toLoad = true )` Retrieve categories by parent Retrieve categories by parent Parameters `$parent` `integer` $parent `$recursionLevel` `integer` $recursionLevel `$sorted` `boolean` $sorted `$asCollection` `boolean` $asCollection `$toLoad` `boolean` $toLoad Returns `mixed`
`public array`	# `getParentCategories( )` Return parent categories of current category Return parent categories of current category Returns `array`
`public array`	# `getChildrenCategories( )` Retuen children categories of current category Retuen children categories of current category Returns `array`
`public Mage_Catalog_Model_Category`	# `getParentDesignCategory( )` Return parent category of current category with own custom design settings Return parent category of current category with own custom design settings Returns `Mage_Catalog_Model_Category`
`public boolean`	# `isInRootCategoryList( )` Check category is in Root Category list Check category is in Root Category list Returns `boolean`
`public null\|array`	# `getAvailableSortBy( )` Retrieve Available int Product Listing sort by Retrieve Available int Product Listing sort by Returns `null\|array`
`public array`	# `getAvailableSortByOptions( )` Retrieve Available Product Listing Sort By code as key, value - name Retrieve Available Product Listing Sort By code as key, value - name Returns `array`
`public string`	# `getDefaultSortBy( )` Retrieve Product Listing Default Sort By Retrieve Product Listing Default Sort By Returns `string`
`public boolean\|array`	# `validate( )` Validate attribute values Validate attribute values Returns `boolean\|array` Throws `Mage_Eav_Model_Entity_Attribute_Exception`
`protected Mage_Catalog_Model_Category`	# `_afterSave( )` Init indexing process after category save Init indexing process after category save Returns `Mage_Catalog_Model_Category` Overrides `Mage_Core_Model_Abstract::_afterSave()`

Methods inherited from Mage_Catalog_Model_Abstract
`_beforeSave(), getAttributeDefaultValue(), getExistsStoreValueFlag(), getLockedAttributes(), getResourceCollection(), getStore(), getWebsiteStoreIds(), hasLockedAttributes(), isDeleteable(), isLockedAttribute(), isReadonly(), loadByAttribute(), lockAttribute(), setAttributeDefaultValue(), setData(), setExistsStoreValueFlag(), setIsDeleteable(), setIsReadonly(), unlockAttribute(), unlockAttributes(), unsetData()`

Methods inherited from Mage_Core_Model_Abstract
`_afterDelete(), _afterDeleteCommit(), _afterLoad(), _beforeLoad(), _clearData(), _clearReferences(), _getEventData(), _getResource(), _hasModelChanged(), _init(), _protectFromNonAdmin(), _setResourceModel(), afterCommitCallback(), afterLoad(), cleanModelCache(), clearInstance(), delete(), getCacheIdTags(), getCacheTags(), getCollection(), getEntityId(), getId(), getIdFieldName(), getResource(), getResourceName(), isObjectNew(), load(), save(), setId()`

Constants summary
`string`	`ENTITY`	`'catalog_category'`	# Entity code. Can be used as part of method name for entity processing Entity code. Can be used as part of method name for entity processing
`string`	`DM_PRODUCT`	`'PRODUCTS'`	# Category display modes Category display modes
`string`	`DM_PAGE`	`'PAGE'`	#
`string`	`DM_MIXED`	`'PRODUCTS_AND_PAGE'`	#
`integer`	`TREE_ROOT_ID`	`1`	#
`string`	`CACHE_TAG`	`'catalog_category'`	#

Constants inherited from Mage_Catalog_Model_Abstract
`DEFAULT_STORE_ID`

Properties summary
`protected string`	`$_eventPrefix`	`'catalog_category'`	# Prefix of model events names Prefix of model events names
`protected string`	`$_eventObject`	`'category'`	# Parameter name in event Parameter name in event
`protected string`	`$_cacheTag`	`Mage_Catalog_Model_Category::CACHE_TAG`	# Model cache tag for clear cache in after save and after delete Model cache tag for clear cache in after save and after delete
`protected static Mage_Core_Model_Url`	`$_url`		# URL Model instance URL Model instance
`protected static Mage_Core_Model_Url_Rewrite`	`$_urlRewrite`		# URL rewrite model URL rewrite model
`protected boolean`	`$_useFlatResource`	`false`	# Use flat resource model flag Use flat resource model flag
`private array`	`$_designAttributes`	`array( 'custom_design', 'custom_design_from', 'custom_design_to', 'page_layout', 'custom_layout_update', 'custom_apply_to_products' )`	# Category design attributes Category design attributes
`protected Mage_Catalog_Model_Resource_Eav_Mysql4_Category_Tree`	`$_treeModel`	`null`	# Category tree model Category tree model

Properties inherited from Mage_Catalog_Model_Abstract
`$_defaultValues, $_isDeleteable, $_isReadonly, $_lockedAttributes, $_storeValuesFlags`

Properties inherited from Mage_Core_Model_Abstract
`$_dataSaveAllowed, $_isObjectNew, $_resource, $_resourceCollectionName, $_resourceName`

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Category

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Overrides

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Throws

Returns

Overrides