Class Mage_Catalog_Model_Resource_Url

Catalog url rewrite resource model

Mage_Catalog_Model_Resource_Url

Direct known subclasses

Mage_Catalog_Model_Resource_Eav_Mysql4_Url

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

Methods summary
`protected`	# `_construct( )` Load core Url rewrite model Load core Url rewrite model
`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_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\|false`	# `getRewriteByIdPath( string $idPath, integer $storeId )` Retrieve rewrite by idPath Retrieve rewrite by idPath Parameters `$idPath` `string` $idPath `$storeId` `integer` $storeId Returns `Varien_Object\|false`
`public Varien_Object\|false`	# `getRewriteByRequestPath( string $requestPath, integer $storeId )` Retrieve rewrite by requestPath Retrieve rewrite by requestPath Parameters `$requestPath` `string` $requestPath `$storeId` `integer` $storeId Returns `Varien_Object\|false`
`public integer`	# `getLastUsedRewriteRequestIncrement( string $prefix, string $suffix, integer $storeId )` Get last used increment part of rewrite request path Get last used increment part of rewrite request path Parameters `$prefix` `string` $prefix `$suffix` `string` $suffix `$storeId` `integer` $storeId Returns `integer`
`public false`	# `checkRequestPaths( array $paths, integer $storeId )` Validate array of request paths. Return first not used path in case if validations passed Validate array of request paths. Return first not used path in case if validations passed Parameters `$paths` `array` $paths `$storeId` `integer` $storeId Returns `false` \| string
`public array`	# `prepareRewrites( integer $storeId, integer\|array $categoryIds = null, integer\|array $productIds = null )` Prepare rewrites for condition Prepare rewrites for condition Parameters `$storeId` `integer` $storeId `$categoryIds` `integer\|array` $categoryIds `$productIds` `integer\|array` $productIds Returns `array`
`public Mage_Catalog_Model_Resource_Url`	# `saveRewrite( array $rewriteData, integer\|Varien_Object $rewrite )` Save rewrite URL Save rewrite URL Parameters `$rewriteData` `array` $rewriteData `$rewrite` `integer\|Varien_Object` $rewrite Returns `Mage_Catalog_Model_Resource_Url`
`public Mage_Catalog_Model_Resource_Url`	# `saveRewriteHistory( array $rewriteData )` Saves rewrite history Saves rewrite history Parameters `$rewriteData` `array` $rewriteData Returns `Mage_Catalog_Model_Resource_Url`
`public Mage_Catalog_Model_Resource_Url`	# `saveCategoryAttribute( Varien_Object $category, string $attributeCode )` Save category attribute Save category attribute Parameters `$category` `Varien_Object` $category `$attributeCode` `string` $attributeCode Returns `Mage_Catalog_Model_Resource_Url`
`protected array`	# `_getCategoryAttribute( string $attributeCode, integer\|array $categoryIds, integer $storeId )` Retrieve category attributes Retrieve category attributes Parameters `$attributeCode` `string` $attributeCode `$categoryIds` `integer\|array` $categoryIds `$storeId` `integer` $storeId Returns `array`
`public Mage_Catalog_Model_Resource_Url`	# `saveProductAttribute( Varien_Object $product, string $attributeCode )` Save product attribute Save product attribute Parameters `$product` `Varien_Object` $product `$attributeCode` `string` $attributeCode Returns `Mage_Catalog_Model_Resource_Url`
`public array`	# `_getProductAttribute( string $attributeCode, integer\|array $productIds, string $storeId )` Retrieve product attribute Retrieve product attribute Parameters `$attributeCode` `string` $attributeCode `$productIds` `integer\|array` $productIds `$storeId` `string` $storeId Returns `array`
`protected Mage_Catalog_Model_Resource_Url`	# `_prepareCategoryParentId( Varien_Object $category )` Prepare category parentId Prepare category parentId Parameters `$category` `Varien_Object` $category Returns `Mage_Catalog_Model_Resource_Url`
`protected array`	# `_prepareStoreRootCategories( array $stores )` Prepare stores root categories Prepare stores root categories Parameters `$stores` `array` $stores Returns `array`
`protected array`	# `_getCategories( integer\|array $categoryIds, integer $storeId = null, string $path = null )` Retrieve categories objects Either $categoryIds or $path (with ending slash) must be specified Retrieve categories objects Either $categoryIds or $path (with ending slash) must be specified Parameters `$categoryIds` `integer\|array` $categoryIds `$storeId` `integer` $storeId `$path` `string` $path Returns `array`
`public Varien_Object`	# `getCategory( integer $categoryId, integer $storeId )` Retrieve category data object Retrieve category data object Parameters `$categoryId` `integer` $categoryId `$storeId` `integer` $storeId Returns `Varien_Object`
`public array`	# `getCategories( integer\|array $categoryIds, integer $storeId )` Retrieve categories data objects by their ids. Return only categories that belong to specified store. Retrieve categories data objects by their ids. Return only categories that belong to specified store. Parameters `$categoryIds` `integer\|array` $categoryIds `$storeId` `integer` $storeId Returns `array`
`public Varien_Object`	# `loadCategoryChilds( Varien_Object $category )` Retrieve category childs data objects Retrieve category childs data objects Parameters `$category` `Varien_Object` $category Returns `Varien_Object`
`public Varien_Object`	# `getRootChildrenIds( Varien_Object $categoryId, mixed $categoryPath, mixed $includeStart = true )` Retrieves all children ids of root category tree Actually this routine can be used to get children ids of any category, not only root. But as far as result is cached in memory, it's not recommended to do so. Retrieves all children ids of root category tree Actually this routine can be used to get children ids of any category, not only root. But as far as result is cached in memory, it's not recommended to do so. Parameters `$categoryId` `Varien_Object` $category `$categoryPath` `$includeStart` Returns `Varien_Object`
`public string`	# `getCategoryParentPath( Varien_Object $category )` Retrieve category parent path Retrieve category parent path Parameters `$category` `Varien_Object` $category Returns `string`
`public array`	# `getProductIdsByCategory( Varien_Object\|integer $category )` Retrieve product ids by category Retrieve product ids by category Parameters `$category` `Varien_Object\|integer` $category Returns `array`
`protected array`	# `_getProducts( integer\|array $productIds, integer $storeId, integer $entityId, integer & $lastEntityId )` Retrieve Product data objects Retrieve Product data objects Parameters `$productIds` `integer\|array` $productIds `$storeId` `integer` $storeId `$entityId` `integer` $entityId `$lastEntityId` `integer` $lastEntityId Returns `array`
`public Varien_Object`	# `getProduct( integer $productId, integer $storeId )` Retrieve Product data object Retrieve Product data object Parameters `$productId` `integer` $productId `$storeId` `integer` $storeId Returns `Varien_Object`
`public array`	# `getProductsByStore( integer $storeId, integer & $lastEntityId )` Retrieve Product data obects for store Retrieve Product data obects for store Parameters `$storeId` `integer` $storeId `$lastEntityId` `integer` $lastEntityId Returns `array`
`public array`	# `getProductsByCategory( Varien_Object $category, integer & $lastEntityId )` Retrieve Product data objects in category Retrieve Product data objects in category Parameters `$category` `Varien_Object` $category `$lastEntityId` `integer` $lastEntityId Returns `array`
`public Mage_Catalog_Model_Resource_Url`	# `clearCategoryProduct( integer $storeId )` Find and remove unused products rewrites - a case when products were moved away from the category (either to other category or deleted), so rewrite "category_id-product_id" is invalid Find and remove unused products rewrites - a case when products were moved away from the category (either to other category or deleted), so rewrite "category_id-product_id" is invalid Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Resource_Url`
`public Mage_Catalog_Model_Resource_Url`	# `clearProductRewrites( integer $productId, integer $storeId, array $excludeCategoryIds = array() )` Remove unused rewrites for product - called after we created all needed rewrites for product and know the categories where the product is contained ($excludeCategoryIds), so we can remove all invalid product rewrites that have other category ids Remove unused rewrites for product - called after we created all needed rewrites for product and know the categories where the product is contained ($excludeCategoryIds), so we can remove all invalid product rewrites that have other category ids Notice: this routine is not identical to clearCategoryProduct(), because after checking all categories this one removes rewrites for product still contained within categories. Parameters `$productId` `integer` $productId Product entity Id `$storeId` `integer` $storeId Store Id for rewrites `$excludeCategoryIds` `array` $excludeCategoryIds Array of category Ids that should be skipped Returns `Mage_Catalog_Model_Resource_Url`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Url`	# `clearStoreCategoriesInvalidRewrites( integer $storeId )` Finds and deletes all old category and category/product rewrites for store left from the times when categories/products belonged to store Finds and deletes all old category and category/product rewrites for store left from the times when categories/products belonged to store Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Url`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Url`	# `clearStoreProductsInvalidRewrites( integer $storeId, integer\|array\|null $productId = null )` Finds and deletes product rewrites (that are not assigned to any category) for store left from the times when product was assigned to this store's website and now is not assigned Finds and deletes product rewrites (that are not assigned to any category) for store left from the times when product was assigned to this store's website and now is not assigned Notice: this routine is different from clearProductRewrites() and clearCategoryProduct() because it handles direct rewrites to product without defined category (category_id IS NULL) whilst that routines handle only product rewrites within categories Parameters `$storeId` `integer` $storeId `$productId` `integer\|array\|null` $productId Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Url`
`public Mage_Catalog_Model_Resource_Eav_Mysql4_Url`	# `clearStoreInvalidRewrites( integer $storeId )` Finds and deletes old rewrites for store category rewrites left from the times when store had some other root category product rewrites left from products that once belonged to this site, but then deleted or just removed from website Finds and deletes old rewrites for store category rewrites left from the times when store had some other root category product rewrites left from products that once belonged to this site, but then deleted or just removed from website Parameters `$storeId` `integer` $storeId Returns `Mage_Catalog_Model_Resource_Eav_Mysql4_Url`
`public Mage_Catalog_Model_Resource_Url`	# `deleteCategoryProductRewrites( integer $categoryId, array $productIds )` Delete rewrites for associated to category products Delete rewrites for associated to category products Parameters `$categoryId` `integer` $categoryId `$productIds` `array` $productIds Returns `Mage_Catalog_Model_Resource_Url`
`public Mage_Catalog_Model_Resource_Url`	# `deleteCategoryProductStoreRewrites( integer $categoryId, array\|integer\|null $productIds = null, null\|integer $storeId = null )` Delete URL rewrites for category products of specific store Delete URL rewrites for category products of specific store Parameters `$categoryId` `integer` $categoryId `$productIds` `array\|integer\|null` $productIds `$storeId` `null\|integer` $storeId Returns `Mage_Catalog_Model_Resource_Url`
`public array`	# `getRewriteByProductStore( array $products )` Retrieve rewrites and visibility by store Input array format: product_id as key and store_id as value Output array format (product_id as key) store_id int; store id visibility int; visibility for store url_rewrite string; rewrite URL for store Retrieve rewrites and visibility by store Input array format: product_id as key and store_id as value Output array format (product_id as key) store_id int; store id visibility int; visibility for store url_rewrite string; rewrite URL for store Parameters `$products` `array` $products Returns `array`
`public string`	# `findFinalTargetPath( string $requestPath, integer $storeId, array & $_checkedPaths = array() )` Find and return final id path by request path Needed for permanent redirect old URLs. Find and return final id path by request path Needed for permanent redirect old URLs. Parameters `$requestPath` `string` $requestPath `$storeId` `integer` $storeId `$_checkedPaths` `array` $_checkedPaths internal varible to prevent infinite loops. Returns `string` \| bool
`public`	# `deleteRewrite( string $requestPath, integer $storeId )` Delete rewrite path record from the database. Delete rewrite path record from the database. Parameters `$requestPath` `string` $requestPath `$storeId` `integer` $storeId
`public`	# `deleteRewriteRecord( string $requestPath, integer $storeId, boolean $rp = false )` Delete rewrite path record from the database with RP checking. Delete rewrite path record from the database with RP checking. Parameters `$requestPath` `string` $requestPath `$storeId` `integer` $storeId `$rp` `boolean` $rp whether check rewrite option to be "Redirect = Permanent"

Methods inherited from Mage_Core_Model_Resource_Db_Abstract
_afterDelete(), _afterLoad(), _afterSave(), _beforeDelete(), _beforeSave(), _checkUnique(), _getConnection(), _getLoadSelect(), _getReadAdapter(), _getWriteAdapter(), _init(), _initUniqueFields(), _prepareDataForSave(), _prepareValueForSave(), _serializeFields(), _setMainTable(), _setResource(), addUniqueField(), afterLoad(), delete(), getChecksum(), getIdFieldName(), getMainTable(), getReadConnection(), getTable(), getUniqueFields(), getValueTable(), hasDataChanged(), load(), resetUniqueField(), save(), unserializeFields()

Methods inherited from Mage_Core_Model_Resource_Abstract
`__construct(), _prepareDataForTable(), _prepareTableValueForSave(), _serializeField(), _unserializeField(), addCommitCallback(), beginTransaction(), commit(), formatDate(), mktime(), rollBack()`

Properties summary
`protected array`	`$_stores`		# Stores configuration array Stores configuration array
`protected array`	`$_categoryAttributes`	`array()`	# Category attribute properties cache Category attribute properties cache
`protected array`	`$_productAttributes`	`array()`	# Product attribute properties cache Product attribute properties cache
`protected integer`	`$_productLimit`	`250`	# Limit products for select Limit products for select
`protected array`	`$_rootChildrenIds`	`array()`	# Cache of root category children ids Cache of root category children ids

Properties inherited from Mage_Core_Model_Resource_Db_Abstract
`$_connections, $_fieldsForUpdate, $_idFieldName, $_isPkAutoIncrement, $_mainTable, $_mainTableFields, $_resourceModel, $_resourcePrefix, $_resources, $_serializableFields, $_tables, $_uniqueFields, $_useIsObjectNew`

Properties inherited from Mage_Core_Model_Resource_Abstract
`$_commitCallbacks`

Packages

Classes

Interfaces

Class Mage_Catalog_Model_Resource_Url

Direct known subclasses

Parameters

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

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

Parameters