Mage_Core_Controller_Varien_Front Class Reference

Inheritance diagram for Mage_Core_Controller_Varien_Front:

List of all members.

Public Member Functions
	setDefault ($key, $value=null)
	getDefault ($key=null)
	getRequest ()
	getResponse ()
	addRouter ($name, Mage_Core_Controller_Varien_Router_Abstract $router)
	getRouter ($name)
	init ()
	dispatch ()
	getRouterByRoute ($routeName)
	getRouterByFrontName ($frontName)
	rewrite ()
Public Attributes
const	XML_STORE_ROUTERS_PATH = 'web/routers'
Protected Attributes
	$_defaults = array()
	$_routers = array()
	$_urlCache = array()

---

Detailed Description

Definition at line 28 of file Front.php.

---

Member Function Documentation

addRouter	(	$	name,
		Mage_Core_Controller_Varien_Router_Abstract $	router
	)

Adding new router

Parameters:

	string	$name
	Mage_Core_Controller_Varien_Router_Abstract	$router

Returns:

Mage_Core_Controller_Varien_Front

Definition at line 90 of file Front.php.

    {
        $router->setFront($this);
        $this->_routers[$name] = $router;
        return $this;
    }

dispatch

(

)

Definition at line 141 of file Front.php.

    {
        $request = $this->getRequest();
        $request->setPathInfo()->setDispatched(false);

        Varien_Profiler::start('mage::dispatch::db_url_rewrite');
        Mage::getModel('core/url_rewrite')->rewrite();
        Varien_Profiler::stop('mage::dispatch::db_url_rewrite');

        Varien_Profiler::start('mage::dispatch::config_url_rewrite');
        $this->rewrite();
        Varien_Profiler::stop('mage::dispatch::config_url_rewrite');

        Varien_Profiler::start('mage::dispatch::routers_match');
        $i = 0;
        while (!$request->isDispatched() && $i++<100) {
            foreach ($this->_routers as $router) {
                if ($router->match($this->getRequest())) {
                    break;
                }
            }
        }
        Varien_Profiler::stop('mage::dispatch::routers_match');
        if ($i>100) {
            Mage::throwException('Front controller reached 100 router match iterations');
        }

        Varien_Profiler::start('mage::app::dispatch::send_response');
        $this->getResponse()->sendResponse();
        Varien_Profiler::stop('mage::app::dispatch::send_response');

        return $this;
    }

getDefault

(

$

key = null

)

Definition at line 53 of file Front.php.

    {
        if (is_null($key)) {
            return $this->_defaults;
        } elseif (isset($this->_defaults[$key])) {
            return $this->_defaults[$key];
        }
        return false;
    }

getRequest

(

)

Retrieve request object

Returns:

Mage_Core_Controller_Request_Http

Definition at line 68 of file Front.php.

    {
        return Mage::app()->getRequest();
    }

getResponse

(

)

Retrieve response object

Returns:

Zend_Controller_Response_Http

Definition at line 78 of file Front.php.

    {
        return Mage::app()->getResponse();
    }

getRouter

(

$

name

)

Retrieve router by name

Parameters:

string

$name

Returns:

Mage_Core_Controller_Varien_Router_Abstract

Definition at line 103 of file Front.php.

    {
        if (isset($this->_routers[$name])) {
            return $this->_routers[$name];
        }
        return false;
    }

getRouterByFrontName

(

$

frontName

)

Definition at line 196 of file Front.php.

    {
        // empty route supplied - return base url
        if (empty($frontName)) {
            $router = $this->getRouter('standard');
        } elseif ($this->getRouter('admin')->getRouteByFrontName($frontName)) {
            // try standard router url assembly
            $router = $this->getRouter('admin');
        } elseif ($this->getRouter('standard')->getRouteByFrontName($frontName)) {
            // try standard router url assembly
            $router = $this->getRouter('standard');
        } elseif ($router = $this->getRouter($frontName)) {
            // try custom router url assembly
        } else {
            // get default router url
            $router = $this->getRouter('default');
        }

        return $router;
    }

getRouterByRoute

(

$

routeName

)

Definition at line 175 of file Front.php.

    {
        // empty route supplied - return base url
        if (empty($routeName)) {
            $router = $this->getRouter('standard');
        } elseif ($this->getRouter('admin')->getFrontNameByRoute($routeName)) {
            // try standard router url assembly
            $router = $this->getRouter('admin');
        } elseif ($this->getRouter('standard')->getFrontNameByRoute($routeName)) {
            // try standard router url assembly
            $router = $this->getRouter('standard');
        } elseif ($router = $this->getRouter($routeName)) {
            // try custom router url assembly
        } else {
            // get default router url
            $router = $this->getRouter('default');
        }

        return $router;
    }

init

(

)

Definition at line 111 of file Front.php.

    {
        Mage::dispatchEvent('controller_front_init_before', array('front'=>$this));

        $routersInfo = Mage::app()->getStore()->getConfig(self::XML_STORE_ROUTERS_PATH);

        Varien_Profiler::start('mage::app::init_front_controller::collect_routers');
        foreach ($routersInfo as $routerCode => $routerInfo) {
            if (isset($routerInfo['disabled']) && $routerInfo['disabled']) {
                continue;
            }
            if (isset($routerInfo['class'])) {
                $router = new $routerInfo['class'];
                if (isset($routerInfo['area'])) {
                    $router->collectRoutes($routerInfo['area'], $routerCode);
                }
                $this->addRouter($routerCode, $router);
            }
        }
        Varien_Profiler::stop('mage::app::init_front_controller::collect_routers');

        Mage::dispatchEvent('controller_front_init_routers', array('front'=>$this));

        // Add default router at the last
        $default = new Mage_Core_Controller_Varien_Router_Default();
        $this->addRouter('default', $default);

        return $this;
    }

rewrite

(

)

Definition at line 217 of file Front.php.

    {
        $request = $this->getRequest();
        $config = Mage::getConfig()->getNode('global/rewrite');
        if (!$config) {
            return;
        }
        foreach ($config->children() as $rewrite) {
            $from = (string)$rewrite->from;
            $to = (string)$rewrite->to;
            if (empty($from) || empty($to)) {
                continue;
            }
            $pathInfo = preg_replace($from, $to, $request->getPathInfo());
            $request->setPathInfo($pathInfo);
        }
    }

setDefault	(	$	key,
		$	value = null
	)

Definition at line 43 of file Front.php.

    {
        if (is_array($key)) {
            $this->_defaults = $key;
        } else {
            $this->_defaults[$key] = $value;
        }
        return $this;
    }

---

Member Data Documentation

$_defaults = array() [protected]

Definition at line 30 of file Front.php.

$_routers = array() [protected]

Definition at line 37 of file Front.php.

$_urlCache = array() [protected]

Definition at line 39 of file Front.php.

const XML_STORE_ROUTERS_PATH = 'web/routers'

Definition at line 41 of file Front.php.

---

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

• app/code/core/Mage/Core/Controller/Varien/Front.php