Mage_Core_Model_Url_Rewrite Class Reference

Inheritance diagram for Mage_Core_Model_Url_Rewrite:

List of all members.

Public Member Functions
	loadByRequestPath ($path)
	loadByIdPath ($path)
	loadByTags ($tags)
	hasOption ($key)
	addTag ($tags)
	removeTag ($tags)
	rewrite (Zend_Controller_Request_Http $request=null, Zend_Controller_Response_Http $response=null)
	getStoreId ()
Public Attributes
const	TYPE_CATEGORY = 1
const	TYPE_PRODUCT = 2
const	TYPE_CUSTOM = 3
const	REWRITE_REQUEST_PATH_ALIAS = 'rewrite_request_path'
Protected Member Functions
	_construct ()
	_getQueryString ()

---

Detailed Description

Definition at line 36 of file Rewrite.php.

---

Member Function Documentation

_construct

(

)

[protected]

Enter description here...

Reimplemented from Varien_Object.

Definition at line 43 of file Rewrite.php.

    {
        $this->_init('core/url_rewrite');
    }

_getQueryString

(

)

[protected]

Definition at line 255 of file Rewrite.php.

    {
        if (!empty($_SERVER['QUERY_STRING'])) {
            $queryParams = array();
            parse_str($_SERVER['QUERY_STRING'], $queryParams);
            $hasChanges = false;
            foreach ($queryParams as $key=>$value) {
                if (substr($key, 0, 3) === '___') {
                    unset($queryParams[$key]);
                    $hasChanges = true;
                }
            }
            if ($hasChanges) {
                return http_build_query($queryParams);
            }
            else {
                return $_SERVER['QUERY_STRING'];
            }
        }
        return false;
    }

addTag

(

$

tags

)

Definition at line 115 of file Rewrite.php.

    {
        $curTags = $this->getTags();

        $addTags = is_array($tags) ? $tags : explode(',', $tags);

        foreach ($addTags as $k=>$t) {
            if (!is_numeric($k)) {
                $t = $k.'='.$t;
            }
            if (!in_array($t, $curTags)) {
                $curTags[] = $t;
            }
        }

        $this->setTags($curTags);

        return $this;
    }

getStoreId

(

)

Definition at line 277 of file Rewrite.php.

    {
        return $this->_getData('store_id');
    }

hasOption

(

$

key

)

Definition at line 108 of file Rewrite.php.

    {
        $optArr = explode(',', $this->getOptions());

        return array_search($key, $optArr) !== false;
    }

loadByIdPath

(

$

path

)

Definition at line 74 of file Rewrite.php.

    {
        $this->setId(null)->load($path, 'id_path');
        return $this;
    }

loadByRequestPath

(

$

path

)

Load rewrite information for request

if $path is array - that mean what we need try load for each item

Parameters:

mixed

$path

Returns:

Mage_Core_Model_Url_Rewrite

Definition at line 56 of file Rewrite.php.

    {
        $this->setId(null);

        if (is_array($path)) {
            foreach ($path as $pathInfo) {
                $this->load($pathInfo, 'request_path');
                if ($this->getId()) {
                    return $this;
                }
            }
        }
        else {
            $this->load($path, 'request_path');
        }
        return $this;
    }

loadByTags

(

$

tags

)

Definition at line 80 of file Rewrite.php.

    {
        $this->setId(null);

        $loadTags = is_array($tags) ? $tags : explode(',', $tags);

        $search = $this->getResourceCollection();
        foreach ($loadTags as $k=>$t) {
            if (!is_numeric($k)) {
                $t = $k.'='.$t;
            }
            $search->addTagsFilter($t);
        }
        if (!is_null($this->getStoreId())) {
            $search->addStoreFilter($this->getStoreId());
        }

        $search->setPageSize(1)->load();

        if ($search->getSize()>0) {
            foreach ($search as $rewrite) {
                $this->setData($rewrite->getData());
            }
        }

        return $this;
    }

removeTag

(

$

tags

)

Definition at line 135 of file Rewrite.php.

    {
        $curTags = $this->getTags();

        $removeTags = is_array($tags) ? $tags : explode(',', $tags);

        foreach ($removeTags as $t) {
            if (!is_numeric($k)) {
                $t = $k.'='.$t;
            }
            if ($key = array_search($t, $curTags)) {
                unset($curTags[$key]);
            }
        }

        $this->setTags(',', $curTags);

        return $this;
    }

rewrite	(	Zend_Controller_Request_Http $	request = null,
		Zend_Controller_Response_Http $	response = null
	)

Implement logic of custom rewrites

Parameters:

	Zend_Controller_Request_Http	$request
	Zend_Controller_Response_Http	$response

Returns:

Mage_Core_Model_Url

We need try to find rewrites information for both cases More priority has url with query params

Try to find rewrite by request path at first, if no luck - try to find by id_path

Definition at line 162 of file Rewrite.php.

    {
        if (!Mage::isInstalled()) {
            return false;
        }
        if (is_null($request)) {
            $request = Mage::app()->getFrontController()->getRequest();
        }
        if (is_null($response)) {
            $response = Mage::app()->getFrontController()->getResponse();
        }
        if (is_null($this->getStoreId()) || false===$this->getStoreId()) {
            $this->setStoreId(Mage::app()->getStore()->getId());
        }

        $requestCases = array();
        $requestPath = trim($request->getPathInfo(), '/');

        /**
         * We need try to find rewrites information for both cases
         * More priority has url with query params
         */
        if ($queryString = $this->_getQueryString()) {
            $requestCases[] = $requestPath .'?'.$queryString;
            $requestCases[] = $requestPath;
        }
        else {
            $requestCases[] = $requestPath;
        }

        $this->loadByRequestPath($requestCases);

        /**
         * Try to find rewrite by request path at first, if no luck - try to find by id_path
         */
        if (!$this->getId() && isset($_GET['___from_store'])) {
            try {
                $fromStoreId = Mage::app()->getStore($_GET['___from_store']);
            }
            catch (Exception $e) {
                return false;
            }

            $this->setStoreId($fromStoreId)->loadByRequestPath($requestCases);
            if (!$this->getId()) {
                return false;
            }
            $this->setStoreId(Mage::app()->getStore()->getId())->loadByIdPath($this->getIdPath());
        }

        if (!$this->getId()) {
            return false;
        }


        $request->setAlias(self::REWRITE_REQUEST_PATH_ALIAS, $this->getRequestPath());
        $external = substr($this->getTargetPath(), 0, 6);
        $isPermanentRedirectOption = $this->hasOption('RP');
        if ($external === 'http:/' || $external === 'https:') {
            if ($isPermanentRedirectOption) {
                header('HTTP/1.1 301 Moved Permanently');
            }
            header("Location: ".$this->getTargetPath());
            exit;
        } else {
            $targetUrl = $request->getBaseUrl(). '/' . $this->getTargetPath();
        }
        $isRedirectOption = $this->hasOption('R');
        if ($isRedirectOption || $isPermanentRedirectOption) {
            if (Mage::getStoreConfig('web/url/use_store') && $storeCode = Mage::app()->getStore()->getCode()) {
                $targetUrl = $request->getBaseUrl(). '/' . $storeCode . '/' .$this->getTargetPath();
            }
            if ($isPermanentRedirectOption) {
                header('HTTP/1.1 301 Moved Permanently');
            }
            header('Location: '.$targetUrl);
            exit;
        }

        if (Mage::getStoreConfig('web/url/use_store') && $storeCode = Mage::app()->getStore()->getCode()) {
                $targetUrl = $request->getBaseUrl(). '/' . $storeCode . '/' .$this->getTargetPath();
            }

        if ($queryString = $this->_getQueryString()) {
            $targetUrl .= '?'.$queryString;
        }

        $request->setRequestUri($targetUrl);
        $request->setPathInfo($this->getTargetPath());

        return true;
    }

---

Member Data Documentation

const REWRITE_REQUEST_PATH_ALIAS = 'rewrite_request_path'

Definition at line 41 of file Rewrite.php.

const TYPE_CATEGORY = 1

Definition at line 38 of file Rewrite.php.

const TYPE_CUSTOM = 3

Definition at line 40 of file Rewrite.php.

const TYPE_PRODUCT = 2

Definition at line 39 of file Rewrite.php.

---

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

• app/code/core/Mage/Core/Model/Url/Rewrite.php