Class Mage_Catalog_Model_Url

Catalog url model

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/Url.php

Methods summary
`protected`	# `_addCategoryUrlPath( Varien_Object $category )` Adds url_path property for non-root category - to ensure that url path is not empty. Adds url_path property for non-root category - to ensure that url path is not empty. Sometimes attribute 'url_path' can be empty, because url_path hasn't been generated yet, in this case category is loaded with empty url_path and we should generate it manually. Parameters `$category` `Varien_Object` $category
`public Mage_Core_Model_Store\|array`	# `getStores( integer $storeId = null )` Retrieve stores array or store model Retrieve stores array or store model Parameters `$storeId` `integer` $storeId Returns `Mage_Core_Model_Store\|array`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Url`	# `getResource( )` Retrieve resource model Retrieve resource model Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Url`
`public Mage_Catalog_Model_Category`	# `getCategoryModel( )` Retrieve Category model singleton Retrieve Category model singleton Returns `Mage_Catalog_Model_Category`
`public Mage_Catalog_Model_Product`	# `getProductModel( )` Retrieve product model singleton Retrieve product model singleton Returns `Mage_Catalog_Model_Product`
`public Varien_Object`	# `getStoreRootCategory( integer $storeId )` Returns store root category, uses caching for it Returns store root category, uses caching for it Parameters `$storeId` `integer` $storeId Returns `Varien_Object`
`public Mage_Catalog_Model_Url`	# `setShouldSaveRewritesHistory( boolean $flag )` Setter for $_saveRewritesHistory Force Rewrites History save bypass config settings Setter for $_saveRewritesHistory Force Rewrites History save bypass config settings Parameters `$flag` `boolean` $flag Returns `Mage_Catalog_Model_Url`
`public boolean`	# `getShouldSaveRewritesHistory( integer $storeId = null )` Indicate whether to save URL Rewrite History or not (create redirects to old URLs) Indicate whether to save URL Rewrite History or not (create redirects to old URLs) Parameters `$storeId` `integer` $storeId Store View Returns `boolean`
`public Mage_Catalog_Model_Url`	# `refreshRewrites( integer $storeId = null )` Refresh all rewrite urls for some store or for all stores Used to make full reindexing of url rewrites Refresh all rewrite urls for some store or for all stores Used to make full reindexing of url rewrites Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Url`
`protected Mage_Catalog_Model_Url`	# `_refreshCategoryRewrites( Varien_Object $category, string $parentPath = null, boolean $refreshProducts = true )` Refresh category rewrite Refresh category rewrite Parameters `$category` `Varien_Object` $category `$parentPath` `string` $parentPath `$refreshProducts` `boolean` $refreshProducts Returns `Mage_Catalog_Model_Url`
`protected Mage_Catalog_Model_Url`	# `_refreshProductRewrite( Varien_Object $product, Varien_Object $category )` Refresh product rewrite Refresh product rewrite Parameters `$product` `Varien_Object` $product `$category` `Varien_Object` $category Returns `Mage_Catalog_Model_Url`
`protected Mage_Catalog_Model_Url`	# `_refreshCategoryProductRewrites( Varien_Object $category )` Refresh products for catwgory Refresh products for catwgory Parameters `$category` `Varien_Object` $category Returns `Mage_Catalog_Model_Url`
`public Mage_Catalog_Model_Url`	# `refreshCategoryRewrite( integer $categoryId, integer\|null $storeId = null, boolean $refreshProducts = true )` Refresh category and childs rewrites Called when reindexing all rewrites and as a reaction on category change that affects rewrites Refresh category and childs rewrites Called when reindexing all rewrites and as a reaction on category change that affects rewrites Parameters `$categoryId` `integer` $categoryId `$storeId` `integer\|null` $storeId `$refreshProducts` `boolean` $refreshProducts Returns `Mage_Catalog_Model_Url`
`public Mage_Catalog_Model_Url`	# `refreshProductRewrite( integer $productId, integer\|null $storeId = null )` Refresh product rewrite urls for one store or all stores Called as a reaction on product change that affects rewrites Refresh product rewrite urls for one store or all stores Called as a reaction on product change that affects rewrites Parameters `$productId` `integer` $productId `$storeId` `integer\|null` $storeId Returns `Mage_Catalog_Model_Url`
`public Mage_Catalog_Model_Url`	# `refreshProductRewrites( integer $storeId )` Refresh all product rewrites for designated store Refresh all product rewrites for designated store Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Url`
`public Mage_Catalog_Model_Url`	# `clearStoreInvalidRewrites( integer $storeId = null )` Deletes old rewrites for store, left from the times when store had some other root category Deletes old rewrites for store, left from the times when store had some other root category Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Url`
`public string`	# `getUnusedPath( integer $storeId, string $requestPath, string $idPath )` Get requestPath that was not used yet. Get requestPath that was not used yet. Will try to get unique path by adding -1 -2 etc. between url_key and optional url_suffix Parameters `$storeId` `integer` $storeId `$requestPath` `string` $requestPath `$idPath` `string` $idPath Returns `string`
`public string`	# `getProductUrlSuffix( integer $storeId )` Retrieve product rewrite sufix for store Retrieve product rewrite sufix for store Parameters `$storeId` `integer` $storeId Returns `string`
`public string`	# `getCategoryUrlSuffix( integer $storeId )` Retrieve category rewrite sufix for store Retrieve category rewrite sufix for store Parameters `$storeId` `integer` $storeId Returns `string`
`public string`	# `getCategoryRequestPath( Varien_Object $category, string $parentPath )` Get unique category request path Get unique category request path Parameters `$category` `Varien_Object` $category `$parentPath` `string` $parentPath Returns `string`
`protected boolean`	# `_deleteOldTargetPath( string $requestPath, string $idPath, integer $storeId )` Check if current generated request path is one of the old paths Check if current generated request path is one of the old paths Parameters `$requestPath` `string` $requestPath `$idPath` `string` $idPath `$storeId` `integer` $storeId Returns `boolean`
`public string`	# `getProductRequestPath( Varien_Object $product, Varien_Object $category )` Get unique product request path Get unique product request path Parameters `$product` `Varien_Object` $product `$category` `Varien_Object` $category Returns `string`
`public string`	# `generatePath( string $type = 'target', Varien_Object $product = null, Varien_Object $category = null, string $parentPath = null )` Generate either id path, request path or target path for product and/or category Generate either id path, request path or target path for product and/or category For generating id or system path, either product or category is required For generating request path - category is required $parentPath used only for generating category path Parameters `$type` `string` $type `$product` `Varien_Object` $product `$category` `Varien_Object` $category `$parentPath` `string` $parentPath Returns `string` Throws `Mage_Core_Exception`
`public string`	# `generateUniqueIdPath( )` Return unique string based on the time in microseconds. Return unique string based on the time in microseconds. Returns `string`
`protected Mage_Catalog_Model_Url`	# `_saveRewriteHistory( array $rewriteData, Varien_Object $rewrite )` Create Custom URL Rewrite for old product/category URL after url_key changed It will perform permanent redirect from old URL to new URL Create Custom URL Rewrite for old product/category URL after url_key changed It will perform permanent redirect from old URL to new URL Parameters `$rewriteData` `array` $rewriteData New rewrite data `$rewrite` `Varien_Object` $rewrite Rewrite model Returns `Mage_Catalog_Model_Url`

Constants summary
`integer`	`MAX_REQUEST_PATH_LENGTH`	`240`	# Number of characters allowed to be in URL path Number of characters allowed to be in URL path
`integer`	`ALLOWED_REQUEST_PATH_OVERFLOW`	`10`	# Number of characters allowed to be in URL path after MAX_REQUEST_PATH_LENGTH number of characters Number of characters allowed to be in URL path after MAX_REQUEST_PATH_LENGTH number of characters

Properties summary
`protected Mage_Catalog_Model_Resource_Eav_Mysql4_Url`	`$_resourceModel`		# Resource model Resource model
`protected array`	`$_categories`	`array()`	# Categories cache for products Categories cache for products
`protected array`	`$_rootCategories`	`array()`	# Store root categories cache Store root categories cache
`protected array`	`$_rewrites`	`array()`	# Rewrite cache Rewrite cache
`protected Varien_Object`	`$_rewrite`		# Current url rewrite rule Current url rewrite rule
`protected array`	`$_productUrlSuffix`	`array()`	# Cache for product rewrite suffix Cache for product rewrite suffix
`protected array`	`$_categoryUrlSuffix`	`array()`	# Cache for category rewrite suffix Cache for category rewrite suffix
`protected boolean`	`$_saveRewritesHistory`	`null`	# Flag to overwrite config settings for Catalog URL rewrites history maintainance Flag to overwrite config settings for Catalog URL rewrites history maintainance
`protected static Mage_Catalog_Model_Category`	`$_categoryForUrlPath`		# Singleton of category model for building URL path Singleton of category model for building URL path

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Url

Parameters

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns