Docs For Class Mage_Core_Controller_Varien_Router

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/Router/Standard.php (line 27)

Mage_Core_Controller_Varien_Router_Abstract
   |
   --Mage_Core_Controller_Varien_Router_Standard

Direct descendents

Class	Description
Mage_Core_Controller_Varien_Router_Admin	Magento

Variable Summary

mixed $_dispatchData

mixed $_modules

mixed $_routes

Method Summary

void addModule ( $frontName, $moduleName, $routeName)

void collectRoutes ( $configArea, $useRouterName)

void fetchDefault ()

void getControllerClassName ( $realModule, $controller)

void getControllerFileName ( $realModule, $controller)

void getFrontNameByRoute ( $routeName)

void getModuleByFrontName ( $frontName)

void getModuleByName ( $moduleName, $modules)

void getRouteByFrontName ( $frontName)

void match ( $request)

void rewrite ( $p)

void validateControllerFileName ( $fileName)

bool _afterModuleMatch ()

bool _beforeModuleMatch ()

void _checkShouldBeSecure ( $request, [ $path = ''])

void _getCurrentSecureUrl ( $request)

string _getDefaultPath ()

bool _includeControllerClass (string $controllerFileName, string $controllerClassName)

void _inludeControllerClass ( $controllerFileName, $controllerClassName)

bool _noRouteShouldBeApplied ()

void _shouldBeSecure ( $path)

mixed _validateControllerClassName ( $realModule, $controller)

Variables

mixed $_dispatchData = array() (line 31)

access: protected

mixed $_modules = array() (line 29)

access: protected

mixed $_routes = array() (line 30)

access: protected

Inherited Variables

Inherited from Mage_Core_Controller_Varien_Router_Abstract

Mage_Core_Controller_Varien_Router_Abstract::$_front

Methods

addModule (line 335)

access: public

void addModule ( $frontName, $moduleName, $routeName)

$frontName
$moduleName
$routeName

collectRoutes (line 33)

access: public

void collectRoutes ( $configArea, $useRouterName)

$configArea
$useRouterName

fetchDefault (line 72)

access: public

void fetchDefault ()

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::fetchDefault()

getControllerClassName (line 394)

access: public

void getControllerClassName ( $realModule, $controller)

$realModule
$controller

getControllerFileName (line 374)

access: public

void getControllerFileName ( $realModule, $controller)

$realModule
$controller

getFrontNameByRoute (line 361)

access: public

void getFrontNameByRoute ( $routeName)

$routeName

Redefinition of:

Mage_Core_Controller_Varien_Router_Abstract::getFrontNameByRoute()

getModuleByFrontName (line 342)

access: public

void getModuleByFrontName ( $frontName)

$frontName

getModuleByName (line 350)

access: public

void getModuleByName ( $moduleName, $modules)

$moduleName
$modules

getRouteByFrontName (line 369)

access: public

void getRouteByFrontName ( $frontName)

$frontName

Redefinition of:

Mage_Core_Controller_Varien_Router_Abstract::getRouteByFrontName()

match (line 105)

access: public

void match ( $request)

Zend_Controller_Request_Http $request

Redefinition of:

Mage_Core_Controller_Varien_Router_Abstract::match()

rewrite (line 400)

access: public

void rewrite ( $p)

array $p

validateControllerFileName (line 386)

access: public

void validateControllerFileName ( $fileName)

$fileName

_afterModuleMatch (line 99)

dummy call to pass through checking

access: protected

bool _afterModuleMatch ()

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_afterModuleMatch() : checking if we installed or not and doing redirect

_beforeModuleMatch (line 86)

checking if this admin if yes then we don't use this router

access: protected

bool _beforeModuleMatch ()

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_beforeModuleMatch() : dummy call to pass through checking

_checkShouldBeSecure (line 422)

access: protected

void _checkShouldBeSecure ( $request, [ $path = ''])

$request
$path

_getCurrentSecureUrl (line 438)

access: protected

void _getCurrentSecureUrl ( $request)

$request

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_getCurrentSecureUrl()

_getDefaultPath (line 262)

Get router default request path

access: protected

string _getDefaultPath ()

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_getDefaultPath() : Get router default request path

_includeControllerClass (line 320)

Include the file containing controller class if this class is not defined yet

access: protected

bool _includeControllerClass (string $controllerFileName, string $controllerClassName)

string $controllerFileName
string $controllerClassName

_inludeControllerClass (line 308)

see: Mage_Core_Controller_Varien_Router_Standard::_includeControllerClass()
deprecated:
access: protected

void _inludeControllerClass ( $controllerFileName, $controllerClassName)

$controllerFileName
$controllerClassName

_noRouteShouldBeApplied (line 272)

Allow to control if we need to enable no route functionality in current router

access: protected

bool _noRouteShouldBeApplied ()

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_noRouteShouldBeApplied() : We need to have noroute action in this router not to pass dispatching to next routers

_shouldBeSecure (line 447)

access: protected

void _shouldBeSecure ( $path)

$path

Redefined in descendants as:

Mage_Core_Controller_Varien_Router_Admin::_shouldBeSecure()

_validateControllerClassName (line 283)

Generating and validating class file name, class and if evrything ok do include if needed and return of class name

access: protected

mixed _validateControllerClassName ( $realModule, $controller)

$realModule
$controller

Inherited Methods

Inherited From Mage_Core_Controller_Varien_Router_Abstract

Mage_Core_Controller_Varien_Router_Abstract::getFront()
Mage_Core_Controller_Varien_Router_Abstract::getFrontNameByRoute()
Mage_Core_Controller_Varien_Router_Abstract::getRouteByFrontName()
Mage_Core_Controller_Varien_Router_Abstract::match()
Mage_Core_Controller_Varien_Router_Abstract::setFront()

Class Mage_Core_Controller_Varien_Router_Standard

Inherited Variables

Inherited Methods