Mage_Core_Controller_Varien_Router_Standard Class Reference

Inheritance diagram for Mage_Core_Controller_Varien_Router_Standard:

List of all members.

Public Member Functions
	collectRoutes ($configArea, $useRouterName)
	fetchDefault ()
	match (Zend_Controller_Request_Http $request)
	addModule ($frontName, $moduleName, $routeName)
	getModuleByFrontName ($frontName)
	getModuleByName ($moduleName, $modules)
	getFrontNameByRoute ($routeName)
	getRouteByFrontName ($frontName)
	getControllerFileName ($realModule, $controller)
	validateControllerFileName ($fileName)
	getControllerClassName ($realModule, $controller)
	rewrite (array $p)
Protected Member Functions
	_beforeModuleMatch ()
	_afterModuleMatch ()
	_noRouteShouldBeApplied ()
	_validateControllerClassName ($realModule, $controller)
	_inludeControllerClass ($controllerFileName, $controllerClassName)
	_checkShouldBeSecure ($request, $path='')
	_getCurrentSecureUrl ($request)
	_shouldBeSecure ($path)
Protected Attributes
	$_modules = array()
	$_routes = array()
	$_dispatchData = array()

---

Detailed Description

Definition at line 27 of file Standard.php.

---

Member Function Documentation

_afterModuleMatch

(

)

[protected]

dummy call to pass through checking

Returns:

bool

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 100 of file Standard.php.

    {
        return true;
    }

_beforeModuleMatch

(

)

[protected]

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

Returns:

bool

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 87 of file Standard.php.

    {
        if (Mage::app()->getStore()->isAdmin()) {
            return false;
        }
        return true;
    }

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

Definition at line 399 of file Standard.php.

    {
        if (!Mage::isInstalled() || $request->getPost()) {
            return;
        }

        if ($this->_shouldBeSecure($path) && !Mage::app()->getStore()->isCurrentlySecure()) {
            $url = $this->_getCurrentSecureUrl($request);

            Mage::app()->getFrontController()->getResponse()
                ->setRedirect($url)
                ->sendResponse();
            exit;
        }
    }

_getCurrentSecureUrl

(

$

request

)

[protected]

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 415 of file Standard.php.

    {
        return Mage::getBaseUrl('link', true).ltrim($request->getPathInfo(), '/');
    }

_inludeControllerClass	(	$	controllerFileName,
		$	controllerClassName
	)			[protected]

Including controller class if checking of existense class before include

Parameters:

	string	$controllerFileName
	string	$controllerClassName

Returns:

bool

Definition at line 297 of file Standard.php.

    {
        if (!class_exists($controllerClassName, false)) {
            if (!file_exists($controllerFileName)) {
                return false;
            }
            include $controllerFileName;

            if (!class_exists($controllerClassName, false)) {
                throw Mage::exception('Mage_Core', Mage::helper('core')->__('Controller file was loaded but class does not exist'));
            }
        }
        return true;
    }

_noRouteShouldBeApplied

(

)

[protected]

Allow to control if we need to enable norout functionality in current router

Returns:

bool

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 258 of file Standard.php.

    {
        return false;
    }

_shouldBeSecure

(

$

path

)

[protected]

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 420 of file Standard.php.

    {
        return substr(Mage::getStoreConfig('web/unsecure/base_url'),0,5)==='https'
            || Mage::getStoreConfigFlag('web/secure/use_in_frontend')
            && substr(Mage::getStoreConfig('web/secure/base_url'),0,5)=='https'
            && Mage::getConfig()->shouldUrlBeSecure($path);
    }

_validateControllerClassName	(	$	realModule,
		$	controller
	)			[protected]

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

Returns:

mixed

Definition at line 269 of file Standard.php.

    {
        $controllerFileName = $this->getControllerFileName($realModule, $controller);
        if (!$this->validateControllerFileName($controllerFileName)) {
            return false;
        }

        $controllerClassName = $this->getControllerClassName($realModule, $controller);
        if (!$controllerClassName) {
            return false;
        }

        // include controller file if needed
        if (!$this->_inludeControllerClass($controllerFileName, $controllerClassName)) {
            return false;
        }

        return $controllerClassName;
    }

addModule	(	$	frontName,
		$	moduleName,
		$	routeName
	)

Definition at line 312 of file Standard.php.

    {
        $this->_modules[$frontName] = $moduleName;
        $this->_routes[$routeName] = $frontName;
        return $this;
    }

collectRoutes	(	$	configArea,
		$	useRouterName
	)

Definition at line 33 of file Standard.php.

    {
        $routers = array();
        $routersConfigNode = Mage::getConfig()->getNode($configArea.'/routers');
        if($routersConfigNode) {
            $routers = $routersConfigNode->children();
        }
        foreach ($routers as $routerName=>$routerConfig) {
            $use = (string)$routerConfig->use;
            if ($use == $useRouterName) {
                $modules = array((string)$routerConfig->args->module);
                if ($routerConfig->args->modules) {
                    foreach ($routerConfig->args->modules->children() as $customModule) {
                        if ($customModule) {
                            if ($before = $customModule->getAttribute('before')) {
                                $position = array_search($before, $modules);
                                if ($position === false) {
                                    $position = 0;
                                }
                                array_splice($modules, $position, 0, (string)$customModule);
                            } elseif ($after = $customModule->getAttribute('after')) {
                                $position = array_search($after, $modules);
                                if ($position === false) {
                                    $position = count($modules);
                                }
                                array_splice($modules, $position+1, 0, (string)$customModule);
                            } else {
                                $modules[] = (string)$customModule;
                            }
                        }
                    }
                }

                $frontName = (string)$routerConfig->args->frontName;
                $this->addModule($frontName, $modules, $routerName);
            }
        }
    }

fetchDefault

(

)

Reimplemented in Mage_Core_Controller_Varien_Router_Admin.

Definition at line 72 of file Standard.php.

    {
        $d = explode('/', Mage::getStoreConfig('web/default/front'));
        $this->getFront()->setDefault(array(
            'module'     => !empty($d[0]) ? $d[0] : 'core',
            'controller' => !empty($d[1]) ? $d[1] : 'index',
            'action'     => !empty($d[2]) ? $d[2] : 'index'
        ));
    }

getControllerClassName	(	$	realModule,
		$	controller
	)

Definition at line 371 of file Standard.php.

    {
        $class = $realModule.'_'.uc_words($controller).'Controller';
        return $class;
    }

getControllerFileName	(	$	realModule,
		$	controller
	)

Definition at line 351 of file Standard.php.

    {
        $parts = explode('_', $realModule);
        $realModule = implode('_', array_splice($parts, 0, 2));
        $file = Mage::getModuleDir('controllers', $realModule);
        if (count($parts)) {
            $file .= DS . implode(DS, $parts);
        }
        $file .= DS.uc_words($controller, DS).'Controller.php';
        return $file;
    }

getFrontNameByRoute

(

$

routeName

)

Reimplemented from Mage_Core_Controller_Varien_Router_Abstract.

Definition at line 338 of file Standard.php.

    {
        if (isset($this->_routes[$routeName])) {
            return $this->_routes[$routeName];
        }
        return false;
    }

getModuleByFrontName

(

$

frontName

)

Definition at line 319 of file Standard.php.

    {
        if (isset($this->_modules[$frontName])) {
            return $this->_modules[$frontName];
        }
        return false;
    }

getModuleByName	(	$	moduleName,
		$	modules
	)

Definition at line 327 of file Standard.php.

    {
        foreach ($modules as $module) {
            if ($moduleName === $module || (is_array($module)
                    && $this->getModuleByName($moduleName, $module))) {
                return true;
            }
        }
        return false;
    }

getRouteByFrontName

(

$

frontName

)

Reimplemented from Mage_Core_Controller_Varien_Router_Abstract.

Definition at line 346 of file Standard.php.

    {
        return array_search($frontName, $this->_routes);
    }

match

(

Zend_Controller_Request_Http $

request

)

Searching router args by module name from route using it as key

If we did not found anything we searching exact this module name in array values

Going through modules to find appropriate controller

if we did not found any siutibul

Reimplemented from Mage_Core_Controller_Varien_Router_Abstract.

Definition at line 105 of file Standard.php.

    {
        //checkings before even try to findout that current module
        //should use this router
        if (!$this->_beforeModuleMatch()) {
            return false;
        }

        $this->fetchDefault();

        $front = $this->getFront();

        $p = explode('/', trim($request->getPathInfo(), '/'));

        // get module name
        if ($request->getModuleName()) {
            $module = $request->getModuleName();
        } else {
            if(!empty($p[0])) {
                $module = $p[0];
            } else {
                $module = $this->getFront()->getDefault('module');
                $request->setAlias(Mage_Core_Model_Url_Rewrite::REWRITE_REQUEST_PATH_ALIAS, '');
            }
        }
        if (!$module) {
            if (Mage::app()->getStore()->isAdmin()) {
                $module = 'admin';
            } else {
                return false;
            }
        }

        /**
         * Searching router args by module name from route using it as key
         */
        $modules = $this->getModuleByFrontName($module);

        /**
         * If we did not found anything  we searching exact this module
         * name in array values
         */
        if ($modules === false) {
            if ($moduleFrontName = $this->getModuleByName($module, $this->_modules)) {
                $modules = array($module);
                $module = $moduleFrontName;
            } else {
                return false;
            }
        }

        //checkings after we foundout that this router should be used for current module
        if (!$this->_afterModuleMatch()) {
            return false;
        }

        /**
         * Going through modules to find appropriate controller
         */
        $found = false;
        foreach ($modules as $realModule) {
            $request->setRouteName($this->getRouteByFrontName($module));

            // get controller name
            if ($request->getControllerName()) {
                $controller = $request->getControllerName();
            } else {
                if (!empty($p[1])) {
                    $controller = $p[1];
                } else {
                    $controller = $front->getDefault('controller');
                    $request->setAlias(
                        Mage_Core_Model_Url_Rewrite::REWRITE_REQUEST_PATH_ALIAS,
                        ltrim($request->getOriginalPathInfo(), '/')
                    );
                }
            }

            // get action name
            if (empty($action)) {
                if ($request->getActionName()) {
                    $action = $request->getActionName();
                } else {
                    $action = !empty($p[2]) ? $p[2] : $front->getDefault('action');
                }
            }

            //checking if this place should be secure
            $this->_checkShouldBeSecure($request, '/'.$module.'/'.$controller.'/'.$action);

            $controllerClassName = $this->_validateControllerClassName($realModule, $controller);
            if (!$controllerClassName) {
                continue;
            }

            // instantiate controller class
            $controllerInstance = new $controllerClassName($request, $front->getResponse());

            if (!$controllerInstance->hasAction($action)) {
                continue;
            }

            $found = true;
            break;
        }

        /**
         * if we did not found any siutibul
         */
        if (!$found) {
            if ($this->_noRouteShouldBeApplied()) {
                $controller = 'index';
                $action = 'noroute';

                $controllerClassName = $this->_validateControllerClassName($realModule, $controller);
                if (!$controllerClassName) {
                    return false;
                }

                // instantiate controller class
                $controllerInstance = new $controllerClassName($request, $front->getResponse());

                if (!$controllerInstance->hasAction($action)) {
                    return false;
                }
            } else {
                return false;
            }
        }

        // set values only after all the checks are done
        $request->setModuleName($module);
        $request->setControllerName($controller);
        $request->setActionName($action);
        $request->setControllerModule($realModule);

        // set parameters from pathinfo
        for ($i=3, $l=sizeof($p); $i<$l; $i+=2) {
            $request->setParam($p[$i], isset($p[$i+1]) ? $p[$i+1] : '');
        }

        // dispatch action
        $request->setDispatched(true);
        $controllerInstance->dispatch($action);

        return true;
    }

rewrite

(

array $

p

)

Definition at line 377 of file Standard.php.

    {
        $rewrite = Mage::getConfig()->getNode('global/rewrite');
        if ($module = $rewrite->{$p[0]}) {
            if (!$module->children()) {
                $p[0] = trim((string)$module);
            }
        }
        if (isset($p[1]) && ($controller = $rewrite->{$p[0]}->{$p[1]})) {
            if (!$controller->children()) {
                $p[1] = trim((string)$controller);
            }
        }
        if (isset($p[2]) && ($action = $rewrite->{$p[0]}->{$p[1]}->{$p[2]})) {
            if (!$action->children()) {
                $p[2] = trim((string)$action);
            }
        }
#echo "<pre>".print_r($p,1)."</pre>";
        return $p;
    }

validateControllerFileName

(

$

fileName

)

Definition at line 363 of file Standard.php.

    {
        if ($fileName && is_readable($fileName) && false===strpos($fileName, '//')) {
            return true;
        }
        return false;
    }

---

Member Data Documentation

$_dispatchData = array() [protected]

Definition at line 31 of file Standard.php.

$_modules = array() [protected]

Definition at line 29 of file Standard.php.

$_routes = array() [protected]

Definition at line 30 of file Standard.php.

---

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

• app/code/core/Mage/Core/Controller/Varien/Router/Standard.php