Mage_Catalog_Model_Url Class Reference

List of all members.

Public Member Functions
	getStores ($storeId=null)
	getResource ()
	getCategoryModel ()
	getProductModel ()
	refreshRewrites ($storeId=null)
	refreshCategoryRewrite ($categoryId, $storeId=null, $refreshProducts=true)
	refreshProductRewrite ($productId, $storeId=null)
	refreshProductRewrites ($storeId)
	getUnusedPath ($storeId, $requestPath, $idPath)
	getProductUrlSuffix ($storeId)
	getCategoryUrlSuffix ($storeId)
	generatePath ($type= 'target', $product=null, $category=null, $parentPath=null)
Public Attributes
const	MAX_REQUEST_PATH_LENGTH = 240
const	ALLOWED_REQUEST_PATH_OVERFLOW = 10
Protected Member Functions
	_refreshCategoryRewrites (Varien_Object $category, $parentPath=null, $refreshProducts=true)
	_refreshProductRewrite (Varien_Object $product, Varien_Object $category)
	_refreshCategoryProductRewrites (Varien_Object $category)
Protected Attributes
	$_resourceModel
	$_categories = array()
	$_rewrites = array()
	$_rewrite
	$_productUrlSuffix = array()
	$_categoryUrlSuffix = array()

---

Detailed Description

Definition at line 34 of file Url.php.

---

Member Function Documentation

_refreshCategoryProductRewrites

(

Varien_Object $

category

)

[protected]

Refresh products for catwgory

Parameters:

Varien_Object

$category

Returns:

Mage_Catalog_Model_Url

Definition at line 278 of file Url.php.

    {
        $originalRewrites = $this->_rewrites;
        $process = true;
        $lastEntityId = 0;
        while ($process == true) {
            $products = $this->getResource()->getProductsByCategory($category, $lastEntityId);
            if (!$products) {
                $process = false;
                break;
            }

            $this->_rewrites = $this->getResource()->prepareRewrites($category->getStoreId(), $category->getId(), array_keys($products));

            foreach ($products as $product) {
                $this->_refreshProductRewrite($product, $category);
            }
            unset($products);
        }
        $this->_rewrites = $originalRewrites;
        return $this;
    }

_refreshCategoryRewrites	(	Varien_Object $	category,
		$	parentPath = null,
		$	refreshProducts = true
	)			[protected]

Refresh category rewrite

Parameters:

	Varien_Object	$category
	string	$parentPath

Returns:

Mage_Catalog_Model_Url

Definition at line 166 of file Url.php.

    {
        if ($category->getId() != $this->getStores($category->getStoreId())->getRootCategoryId()) {
            if ($category->getUrlKey() == '') {
                $urlKey = $this->getCategoryModel()->formatUrlKey($category->getName());
            }
            else {
                $urlKey = $this->getCategoryModel()->formatUrlKey($category->getUrlKey());
            }

            $idPath      = $this->generatePath('id', null, $category);
            $targetPath  = $this->generatePath('target', null, $category);
            $requestPath = $this->generatePath('request', null, $category, $parentPath);

            $rewriteData = array(
                'store_id'      => $category->getStoreId(),
                'category_id'   => $category->getId(),
                'product_id'    => null,
                'id_path'       => $idPath,
                'request_path'  => $requestPath,
                'target_path'   => $targetPath,
                'is_system'     => 1
            );

            $this->getResource()->saveRewrite($rewriteData, $this->_rewrite);

            if ($category->getUrlKey() != $urlKey) {
                $category->setUrlKey($urlKey);
                $this->getResource()->saveCategoryAttribute($category, 'url_key');
            }
            if ($category->getUrlPath() != $requestPath) {
                $category->setUrlPath($requestPath);
                $this->getResource()->saveCategoryAttribute($category, 'url_path');
            }
        }
        else {
            if ($category->getUrlPath() != '') {
                $category->setUrlPath('');
                $this->getResource()->saveCategoryAttribute($category, 'url_path');
            }
        }

        if ($refreshProducts) {
            $this->_refreshCategoryProductRewrites($category);
        }

        foreach ($category->getChilds() as $child) {
            $this->_refreshCategoryRewrites($child, $category->getUrlPath() . '/', $refreshProducts);
        }

        return $this;
    }

_refreshProductRewrite	(	Varien_Object $	product,
		Varien_Object $	category
	)			[protected]

Refresh product rewrite

Parameters:

	Varien_Object	$product
	Varien_Object	$category

Returns:

Mage_Catalog_Model_Url

Definition at line 226 of file Url.php.

    {
        if ($category->getId() == $category->getPath()) {
            return $this;
        }
        if ($product->getUrlKey() == '') {
            $urlKey = $this->getProductModel()->formatUrlKey($product->getName());
        }
        else {
            $urlKey = $this->getProductModel()->formatUrlKey($product->getUrlKey());
        }

        $idPath      = $this->generatePath('id', $product, $category);
        $targetPath  = $this->generatePath('target', $product, $category);
        $requestPath = $this->generatePath('request', $product, $category);
        $categoryId = null;
        $updateKeys = true;
        if ($category->getUrlPath()) {
            $categoryId = $category->getId();
            $updateKeys = false;
        }

        $rewriteData = array(
            'store_id'      => $category->getStoreId(),
            'category_id'   => $categoryId,
            'product_id'    => $product->getId(),
            'id_path'       => $idPath,
            'request_path'  => $requestPath,
            'target_path'   => $targetPath,
            'is_system'     => 1
        );

        $this->getResource()->saveRewrite($rewriteData, $this->_rewrite);

        if ($updateKeys && $product->getUrlKey() != $urlKey) {
            $product->setUrlKey($urlKey);
            $this->getResource()->saveProductAttribute($product, 'url_key');
        }
        if ($updateKeys && $product->getUrlPath() != $requestPath) {
            $product->setUrlPath($requestPath);
            $this->getResource()->saveProductAttribute($product, 'url_path');
        }

        return $this;
    }

generatePath	(	$	type = 'target',
		$	product = null,
		$	category = null,
		$	parentPath = null
	)

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:

	string	$type
	Varien_Object	$product
	Varien_Object	$category
	string	$parentPath

Returns:

string

Exceptions:

Mage_Core_Exception

Definition at line 515 of file Url.php.

    {
        if (!$product && !$category) {
            Mage::throwException(Mage::helper('core')->__('Specify either category or product, or both.'));
        }

        // generate id_path
        if ('id' === $type) {
            if (!$product) {
                return 'category/' . $category->getId();
            }
            if ($category && $category->getUrlPath()) {
                return 'product/' . $product->getId() . '/' . $category->getId();
            }
            return 'product/' . $product->getId();
        }

        // generate request_path
        if ('request' === $type) {
            // for category
            if (!$product) {
                if ($category->getUrlKey() == '') {
                    $urlKey = $this->getCategoryModel()->formatUrlKey($category->getName());
                }
                else {
                    $urlKey = $this->getCategoryModel()->formatUrlKey($category->getUrlKey());
                }

                $categoryUrlSuffix = $this->getCategoryUrlSuffix($category->getStoreId());
                if (null === $parentPath) {
                    $parentPath = $this->getResource()->getCategoryParentPath($category);
                }
                elseif ($parentPath == '/') {
                    $parentPath = '';
                }
                $parentPath = Mage::helper('catalog/category')->getCategoryUrlPath($parentPath, true, $category->getStoreId());

                return $this->getUnusedPath($category->getStoreId(), $parentPath . $urlKey . $categoryUrlSuffix,
                    $this->generatePath('id', null, $category)
                );
            }

            // for product & category
            if (!$category) {
                Mage::throwException(Mage::helper('core')->__('Category object is required for determining product request path')); // why?
            }

            if ($product->getUrlKey() == '') {
                $urlKey = $this->getProductModel()->formatUrlKey($product->getName());
            }
            else {
                $urlKey = $this->getProductModel()->formatUrlKey($product->getUrlKey());
            }
            $productUrlSuffix  = $this->getProductUrlSuffix($category->getStoreId());
            if ($category->getUrlPath()) {
                $categoryUrl = Mage::helper('catalog/category')->getCategoryUrlPath($category->getUrlPath(), false, $category->getStoreId());
                return $this->getUnusedPath($category->getStoreId(), $categoryUrl . '/' . $urlKey . $productUrlSuffix,
                    $this->generatePath('id', $product, $category)
                );
            }

            // for product only
            return $this->getUnusedPath($category->getStoreId(), $urlKey . $productUrlSuffix,
                $this->generatePath('id', $product)
            );
        }

        // generate target_path
        if (!$product) {
            return 'catalog/category/view/id/' . $category->getId();
        }
        if ($category && $category->getUrlPath()) {
            return 'catalog/product/view/id/' . $product->getId() . '/category/' . $category->getId();
        }
        return 'catalog/product/view/id/' . $product->getId();
    }

getCategoryModel

(

)

Retrieve Category model singleton

Returns:

Mage_Catalog_Model_Category

Definition at line 122 of file Url.php.

    {
        return $this->getResource()->getCategoryModel();
    }

getCategoryUrlSuffix

(

$

storeId

)

Retrieve category rewrite sufix for store

Parameters:

int

$storeId

Returns:

string

Definition at line 496 of file Url.php.

    {
        return Mage::helper('catalog/category')->getCategoryUrlSuffix($storeId);
    }

getProductModel

(

)

Retrieve product model singleton

Returns:

Mage_Catalog_Model_Product

Definition at line 132 of file Url.php.

    {
        return $this->getResource()->getProductModel();
    }

getProductUrlSuffix

(

$

storeId

)

Retrieve product rewrite sufix for store

Parameters:

int

$storeId

Returns:

string

Definition at line 485 of file Url.php.

    {
        return Mage::helper('catalog/product')->getProductUrlSuffix($storeId);
    }

getResource

(

)

Retrieve resource model

Returns:

Mage_Catalog_Model_Resource_Eav_Mysql4_Url

Definition at line 109 of file Url.php.

    {
        if (is_null($this->_resourceModel)) {
            $this->_resourceModel = Mage::getResourceModel('catalog/url');
        }
        return $this->_resourceModel;
    }

getStores

(

$

storeId = null

)

Retrieve stores array or store model

Parameters:

int

$storeId

Returns:

Mage_Core_Model_Store|array

Definition at line 99 of file Url.php.

    {
        return $this->getResource()->getStores($storeId);
    }

getUnusedPath	(	$	storeId,
		$	requestPath,
		$	idPath
	)

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:

	int	$storeId
	string	$requestPath
	string	$idPath

Returns:

string

Definition at line 435 of file Url.php.

    {
        if (empty($requestPath)) {
            $requestPath = '-';
        }
        elseif ($requestPath == $this->getProductUrlSuffix($storeId)) {
            $requestPath = '-' . $this->getProductUrlSuffix($storeId);
        }

        if (strlen($requestPath) > self::MAX_REQUEST_PATH_LENGTH + self::ALLOWED_REQUEST_PATH_OVERFLOW) {
            $requestPath = substr($requestPath, 0, self::MAX_REQUEST_PATH_LENGTH);
        }

        if (isset($this->_rewrites[$idPath])) {
            $this->_rewrite = $this->_rewrites[$idPath];
            if ($this->_rewrites[$idPath]->getRequestPath() == $requestPath) {
                return $requestPath;
            }
        }
        else {
            $this->_rewrite = null;
        }

        $rewrite = $this->getResource()->getRewriteByRequestPath($requestPath, $storeId);
        if ($rewrite && $rewrite->getId()) {
            if ($rewrite->getIdPath() == $idPath) {
                $this->_rewrite = $rewrite;
                return $requestPath;
            }
            // retrieve url_suffix for product urls
            $productUrlSuffix = $this->getProductUrlSuffix($storeId);
            // match request_url abcdef1234(-12)(.html) pattern
            $match = array();
            if (!preg_match('#^([0-9a-z/-]+?)(-([0-9]+))?('.preg_quote($productUrlSuffix).')?$#i', $requestPath, $match)) {
                return $this->getUnusedPath($storeId, '-', $idPath);
            }
            $requestPath = $match[1].(isset($match[3])?'-'.($match[3]+1):'-1').(isset($match[4])?$match[4]:'');
            return $this->getUnusedPath($storeId, $requestPath, $idPath);
        }
        else {
            return $requestPath;
        }
    }

refreshCategoryRewrite	(	$	categoryId,
		$	storeId = null,
		$	refreshProducts = true
	)

Refresh category and childs rewrites

Parameters:

	int	$categoryId
	int	$storeId
	bool	$refreshProducts

Returns:

Mage_Catalog_Model_Url

Definition at line 309 of file Url.php.

    {
        if (is_null($storeId)) {
            foreach ($this->getStores() as $store) {
                $this->refreshCategoryRewrite($categoryId, $store->getId(), $refreshProducts);
            }
            return $this;
        }

        $category = $this->getResource()->getCategory($categoryId, $storeId);
        if (!$category) {
            return $this;
        }
        $category = $this->getResource()->loadCategoryChilds($category);
        $categoryIds = array($category->getId());
        if ($category->getAllChilds()) {
            $categoryIds = array_merge($categoryIds, array_keys($category->getAllChilds()));
        }
        $this->_rewrites = $this->getResource()->prepareRewrites($storeId, $categoryIds);
        $this->_refreshCategoryRewrites($category, null, $refreshProducts);

        unset($category);
        $this->_rewrites = array();

        return $this;
    }

refreshProductRewrite	(	$	productId,
		$	storeId = null
	)

Refresh product and categories urls

Parameters:

	int	$productId
	int	$storeId

Returns:

Mage_Catalog_Model_Url

Definition at line 343 of file Url.php.

    {
        if (is_null($storeId)) {
            foreach ($this->getStores() as $store) {
                $this->refreshProductRewrite($productId, $store->getId());
            }
            return $this;
        }

        if ($product = $this->getResource()->getProduct($productId, $storeId)) {
            $storeRootCategoryId = $this->getStores($storeId)->getRootCategoryId();
            $categories = $this->getResource()->getCategories($product->getCategoryIds(), $storeId);
            $this->_rewrites = $this->getResource()->prepareRewrites($storeId, '', $productId);

            if (!isset($categories[$storeRootCategoryId])) {
                $categories[$storeRootCategoryId] = $this->getResource()->getCategory($storeRootCategoryId, $storeId);
            }

            foreach ($categories as $category) {
                $this->_refreshProductRewrite($product, $category);
            }

            unset($categories);
            unset($product);

//            $this->getResource()->clearCategoryProduct($storeId);
        }

        return $this;
    }

refreshProductRewrites

(

$

storeId

)

Definition at line 374 of file Url.php.

    {
        $this->_categories = array();
        $storeRootCategoryId = $this->getStores($storeId)->getRootCategoryId();
        $this->_categories[$storeRootCategoryId] = $this->getResource()->getCategory($storeRootCategoryId, $storeId);

        $lastEntityId = 0;
        $process = true;

        while ($process == true) {
            $products = $this->getResource()->getProductsByStore($storeId, $lastEntityId);
            if (!$products) {
                $process = false;
                break;
            }

            $this->_rewrites = array();
            $this->_rewrites = $this->getResource()->prepareRewrites($storeId, false, array_keys($products));

            $loadCategories = array();
            foreach ($products as $product) {
                foreach ($product->getCategoryIds() as $categoryId) {
                    if (!isset($this->_categories[$categoryId])) {
                        $loadCategories[$categoryId] = $categoryId;
                    }
                }
            }

            if ($loadCategories) {
                foreach ($this->getResource()->getCategories($loadCategories, $storeId) as $category) {
                    $this->_categories[$category->getId()] = $category;
                }
            }

            foreach ($products as $product) {
                $this->_refreshProductRewrite($product, $this->_categories[$storeRootCategoryId]);
                foreach ($product->getCategoryIds() as $categoryId) {
                    if ($categoryId != $storeRootCategoryId && isset($this->_categories[$categoryId])) {
                        $this->_refreshProductRewrite($product, $this->_categories[$categoryId]);
                    }
                }
            }

            unset($products);
            $this->_rewrites = array();
        }

        $this->_categories = array();
        return $this;
    }

refreshRewrites

(

$

storeId = null

)

Refresh rewrite urls

Parameters:

int

$storeId

Returns:

Mage_Catalog_Model_Url

Definition at line 143 of file Url.php.

    {
        if (is_null($storeId)) {
            foreach ($this->getStores() as $store) {
                $this->refreshRewrites($store->getId());
            }
            return $this;
        }

        $this->refreshCategoryRewrite($this->getStores($storeId)->getRootCategoryId(), $storeId, false);
        $this->refreshProductRewrites($storeId);
        $this->getResource()->clearCategoryProduct($storeId);

        return $this;
    }

---

Member Data Documentation

$_categories = array() [protected]

Definition at line 63 of file Url.php.

$_categoryUrlSuffix = array() [protected]

Definition at line 91 of file Url.php.

$_productUrlSuffix = array() [protected]

Definition at line 84 of file Url.php.

$_resourceModel [protected]

Definition at line 56 of file Url.php.

$_rewrite [protected]

Definition at line 77 of file Url.php.

$_rewrites = array() [protected]

Definition at line 70 of file Url.php.

const ALLOWED_REQUEST_PATH_OVERFLOW = 10

Definition at line 49 of file Url.php.

const MAX_REQUEST_PATH_LENGTH = 240

Definition at line 41 of file Url.php.

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Catalog/Model/Url.php