Mage_Catalog_Model_Product_Url Class Reference

Inheritance diagram for Mage_Catalog_Model_Product_Url:

List of all members.

Public Member Functions
	getUrlInstance ()
	getUrlRewrite ()
	getProductUrl ($product, $useSid=null)
	formatUrlKey ($str)
	getUrlPath ($product, $category=null)
Public Attributes
const	CACHE_TAG = 'url_rewrite'
Protected Member Functions
	_validImage ($image)
Static Protected Attributes
static	$_url
static	$_urlRewrite

---

Detailed Description

Product Url model

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 33 of file Url.php.

---

Member Function Documentation

_validImage

(

$

image

)

[protected]

'no_selection' shouldn't be a valid image attribute value

Parameters:

string

$image

Returns:

string

Definition at line 67 of file Url.php.

    {
        if($image == 'no_selection') {
            $image = null;
        }
        return $image;
    }

formatUrlKey

(

$

str

)

Definition at line 150 of file Url.php.

    {
        $urlKey = preg_replace('#[^0-9a-z]+#i', '-', Mage::helper('catalog/product_url')->format($str));
        $urlKey = strtolower($urlKey);
        $urlKey = trim($urlKey, '-');

        return $urlKey;
    }

getProductUrl	(	$	product,
		$	useSid = null
	)

Get product url

Parameters:

	Mage_Catalog_Model_Product	$product
	bool	$useSid

Returns:

string

Definition at line 82 of file Url.php.

    {
        if ($useSid === null) {
            $useSid = Mage::app()->getUseSessionInUrl();
        }

        $categoryId = $product->getCategoryId() && !$product->getDoNotUseCategoryId() ? $product->getCategoryId() : 0;

        $cacheUrlKey = sprintf('url_%d_%d', $categoryId, $useSid);
        $url = $product->getData($cacheUrlKey);

        if (is_null($url)) {
            if ($product->getStoreId()) {
                $this->getUrlInstance()->setStore($product->getStoreId());
            }

            // auto add SID to URL
            $originalSid = $this->getUrlInstance()->getUseSession();
            if ($originalSid != $useSid) {
                $this->getUrlInstance()->setUseSession($useSid);
            }

            if ($product->hasData('request_path') && $product->getRequestPath() != '') {
                $this->setData($cacheUrlKey, $this->getUrlInstance()->getDirectUrl($product->getRequestPath()));
                $this->getUrlInstance()->setUseSession($originalSid);
                return $this->getData($cacheUrlKey);
            }

            Varien_Profiler::start('REWRITE: '.__METHOD__);

            $rewrite = $this->getUrlRewrite();
            if ($product->getStoreId()) {
                $rewrite->setStoreId($product->getStoreId());
            }
            else {
                $rewrite->setStoreId(Mage::app()->getStore()->getId());
            }

            $idPath = 'product/'.$product->getId();
            if ($product->getCategoryId() && !$product->getDoNotUseCategoryId() && Mage::getStoreConfig('catalog/seo/product_use_categories')) {
                $idPath .= '/'.$product->getCategoryId();
            }

            $rewrite->loadByIdPath($idPath);
//echo $this->getUrlInstance()->getBaseUrl();
            if ($rewrite->getId()) {
                $this->setData($cacheUrlKey, $this->getUrlInstance()->getDirectUrl($rewrite->getRequestPath()));
                Varien_Profiler::stop('REWRITE: '.__METHOD__);
                $this->getUrlInstance()->setUseSession($originalSid);
                return $this->getData($cacheUrlKey);
            }

            Varien_Profiler::stop('REWRITE: '.__METHOD__);
            Varien_Profiler::start('REGULAR: '.__METHOD__);

            $url = $this->getUrlInstance()->getUrl('catalog/product/view', array(
                'id'        => $product->getId(),
                's'         => $product->getUrlKey(),
                'category'  => $product->getCategoryId()
            ));

            $this->getUrlInstance()->setUseSession($originalSid);

            Varien_Profiler::stop('REGULAR: '.__METHOD__);
        }
        return $url;
    }

getUrlInstance

(

)

Returns:

Mage_Core_Model_Url

Definition at line 43 of file Url.php.

    {
        if (!self::$_url) {
            self::$_url = Mage::getModel('core/url');
        }
        return self::$_url;
    }

getUrlPath	(	$	product,
		$	category = null
	)

Retrieve Product Url path (with category if exists)

Parameters:

	Mage_Catalog_Model_Product	$product
	Mage_Catalog_Model_Category	$category

Returns:

string

Todo:

get default category

Definition at line 167 of file Url.php.

    {
        $path = $product->getData('url_path');

        if (is_null($category)) {
            /** @todo get default category */
            return $path;
        } elseif (!$category instanceof Mage_Catalog_Model_Category) {
            Mage::throwException('Invalid category object supplied');
        }

        return Mage::helper('catalog/category')->getCategoryUrlPath($category->getUrlPath())
            . '/' . $path;
    }

getUrlRewrite

(

)

Returns:

Mage_Core_Model_Url_Rewrite

Definition at line 54 of file Url.php.

    {
        if (!self::$_urlRewrite) {
            self::$_urlRewrite = Mage::getModel('core/url_rewrite');
        }
        return self::$_urlRewrite;
    }

---

Member Data Documentation

$_url [static, protected]

Definition at line 35 of file Url.php.

$_urlRewrite [static, protected]

Definition at line 36 of file Url.php.

const CACHE_TAG = 'url_rewrite'

Definition at line 38 of file Url.php.

---

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

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