Docs For Class Mage_Core_Controller_Varien

Description

Magento

NOTICE OF LICENSE

This source file is subject to the Open Software License (OSL 3.0) that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://opensource.org/licenses/osl-3.0.php If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

DISCLAIMER

Do not edit or add to this file if you wish to upgrade Magento to newer versions in the future. If you wish to customize Magento for your needs please refer to http://www.magentocommerce.com for more information.

copyright: Copyright (c) 2010 Magento Inc. (http://www.magentocommerce.com)
license: Open Software License (OSL 3.0)

Located in /Core/Controller/Varien/Front.php (line 28)

Varien_Object
   |
   --Mage_Core_Controller_Varien_Front

Class Constant Summary

XML_STORE_ROUTERS_PATH = 'web/routers'

Variable Summary

mixed $_defaults

array $_routers

mixed $_urlCache

Method Summary

Mage_Core_Controller_Varien_Front addRouter (string $name, Mage_Core_Controller_Varien_Router_Abstract $router)

void dispatch ()

void getDefault ([ $key = null])

Mage_Core_Controller_Request_Http getRequest ()

Zend_Controller_Response_Http getResponse ()

Mage_Core_Controller_Varien_Router_Abstract getRouter (string $name)

void getRouterByFrontName ( $frontName)

void getRouterByRoute ( $routeName)

array getRouters ()

Mage_Core_Controller_Varien_Front init ()

Mage_Core_Controller_Varien_Front rewrite ()

void setDefault ( $key, [ $value = null])

void _checkBaseUrl (Zend_Controller_Request_Http $request)

string _processRewriteUrl (string $url)

Variables

mixed $_defaults = array() (line 30)

access: protected

array $_routers = array() (line 37)

Available routers array

access: protected

mixed $_urlCache = array() (line 39)

access: protected

Methods

addRouter (line 90)

Adding new router

access: public

Mage_Core_Controller_Varien_Front addRouter (string $name, Mage_Core_Controller_Varien_Router_Abstract $router)

string $name
Mage_Core_Controller_Varien_Router_Abstract $router

dispatch (line 156)

access: public

void dispatch ()

getDefault (line 53)

access: public

void getDefault ([ $key = null])

$key

getRequest (line 68)

Retrieve request object

access: public

Mage_Core_Controller_Request_Http getRequest ()

getResponse (line 78)

Retrieve response object

access: public

Zend_Controller_Response_Http getResponse ()

getRouter (line 103)

Retrieve router by name

access: public

Mage_Core_Controller_Varien_Router_Abstract getRouter (string $name)

string $name

getRouterByFrontName (line 215)

access: public

void getRouterByFrontName ( $frontName)

$frontName

getRouterByRoute (line 194)

access: public

void getRouterByRoute ( $routeName)

$routeName

getRouters (line 116)

Retrieve routers collection

access: public

array getRouters ()

init (line 126)

Init Fron Controller

access: public

Mage_Core_Controller_Varien_Front init ()

rewrite (line 241)

Apply configuration rewrites to current url

access: public

Mage_Core_Controller_Varien_Front rewrite ()

setDefault (line 43)

access: public

void setDefault ( $key, [ $value = null])

$key
$value

_checkBaseUrl (line 294)

Auto-redirect to base url (without SID) if the requested url doesn't match it.

By default this feature is enabled in configuration.

access: protected

void _checkBaseUrl (Zend_Controller_Request_Http $request)

Zend_Controller_Request_Http $request

_processRewriteUrl (line 273)

Replace route name placeholders in url to front name

access: protected

string _processRewriteUrl (string $url)

string $url

Class Constants

XML_STORE_ROUTERS_PATH = 'web/routers' (line 41)

Class Mage_Core_Controller_Varien_Front