PHP;"> PHP interface Zend_Controller_Router_Interface { /** * Processes a request and sets its controller and action. If * no route was possible,an exception is thrown. * * @param Zend_Controller_Request_Abstract * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Request_Abstract|boolean */ public function route(Zend_Controller_Request_Abstract $dispatcher); /** * Generates a URL path that can be used in URL creation,redirection,etc. * * May be passed user params to override ones from URI,Request or even defaults. * If passed parameter has a value of null,it's URL variable will be reset to * default. * * If null is passed as a route name assemble will use the current Route or 'default' * if current is not yet set. * * Reset is used to signal that all parameters should be reset to it's defaults. * Ignoring all URL specified values. User specified params still get precedence. * * Encode tells to url encode resulting path parts. * * @param array $userParams Options passed by a user used to override parameters * @param mixed $name The name of a Route to use * @param bool $reset Whether to reset to the route defaults ignoring URL params * @param bool $encode Tells to encode URL parts on output * @throws Zend_Controller_Router_Exception * @return string Resulting URL path */ public function assemble($userParams,$name = null,$reset = false,$encode = true); /** * Retrieve Front Controller * * @return Zend_Controller_Front */ public function getFrontController(); /** * Set Front Controller * * @param Zend_Controller_Front $controller * @return Zend_Controller_Router_Interface */ public function setFrontController(Zend_Controller_Front $controller); /** * Add or modify a parameter with which to instantiate any helper objects * * @param string $name * @param mixed $param * @return Zend_Controller_Router_Interface */ public function setParam($name,$value); /** * Set an array of a parameters to pass to helper object constructors * * @param array $params * @return Zend_Controller_Router_Interface */ public function setParams(array $params); /** * Retrieve a single parameter from the controller parameter stack * * @param string $name * @return mixed */ public function getParam($name); /** * Retrieve the parameters to pass to helper object constructors * * @return array */ public function getParams(); /** * Clear the controller parameter stack * * By default,clears all parameters. If a parameter name is given,clears * only that parameter; if an array of parameter names is provided,clears * each. * * @param null|string|array single key or array of keys for params to clear * @return Zend_Controller_Router_Interface */ public function clearParams($name = null); }

PHP;"> setParams($params); } /** * Add or modify a parameter to use when instantiating an action controller * * @param string $name * @param mixed $value * @return Zend_Controller_Router */ public function setParam($name,$value) { $name = (string) $name; $this->_invokeParams[$name] = $value; return $this; } /** * Set parameters to pass to action controller constructors * * @param array $params * @return Zend_Controller_Router */ public function setParams(array $params) { $this->_invokeParams = array_merge($this->_invokeParams,$params); return $this; } /** * Retrieve a single parameter from the controller parameter stack * * @param string $name * @return mixed */ public function getParam($name) { if(isset($this->_invokeParams[$name])) { return $this->_invokeParams[$name]; } return null; } /** * Retrieve action controller instantiation parameters * * @return array */ public function getParams() { return $this->_invokeParams; } /** * Clear the controller parameter stack * * By default,clears * each. * * @param null|string|array single key or array of keys for params to clear * @return Zend_Controller_Router */ public function clearParams($name = null) { if (null === $name) { $this->_invokeParams = array(); } elseif (is_string($name) && isset($this->_invokeParams[$name])) { unset($this->_invokeParams[$name]); } elseif (is_array($name)) { foreach ($name as $key) { if (is_string($key) && isset($this->_invokeParams[$key])) { unset($this->_invokeParams[$key]); } } } return $this; } /** * Retrieve Front Controller * * @return Zend_Controller_Front */ public function getFrontController() { // Used cache version if found if (null !== $this->_frontController) { return $this->_frontController; } require_once 'Zend/Controller/Front.PHP'; $this->_frontController = Zend_Controller_Front::getInstance(); return $this->_frontController; } /** * Set Front Controller * * @param Zend_Controller_Front $controller * @return Zend_Controller_Router_Interface */ public function setFrontController(Zend_Controller_Front $controller) { $this->_frontController = $controller; return $this; } }

PHP;"> hasRoute('default')) { $dispatcher = $this->getFrontController()->getDispatcher(); $request = $this->getFrontController()->getRequest(); require_once 'Zend/Controller/Router/Route/Module.PHP'; $compat = new Zend_Controller_Router_Route_Module(array(),$dispatcher,$request); $this->_routes = array('default' => $compat) + $this->_routes; } return $this; } /** * Add route to the route chain * * If route contains method setRequest(),it is initialized with a request object * * @param string $name Name of the route * @param Zend_Controller_Router_Route_Interface $route Instance of the route * @return Zend_Controller_Router_Rewrite */ public function addRoute($name,Zend_Controller_Router_Route_Interface $route) { if (method_exists($route,'setRequest')) { $route->setRequest($this->getFrontController()->getRequest()); } $this->_routes[$name] = $route; return $this; } /** * Add routes to the route chain * * @param array $routes Array of routes with names as keys and routes as values * @return Zend_Controller_Router_Rewrite */ public function addRoutes($routes) { foreach ($routes as $name => $route) { $this->addRoute($name,$route); } return $this; } /** * Create routes out of Zend_Config configuration * * Example INI: * routes.archive.route = "archive/:year/*" * routes.archive.defaults.controller = archive * routes.archive.defaults.action = show * routes.archive.defaults.year = 2000 * routes.archive.reqs.year = "\d+" * * routes.news.type = "Zend_Controller_Router_Route_Static" * routes.news.route = "news" * routes.news.defaults.controller = "news" * routes.news.defaults.action = "list" * * And finally after you have created a Zend_Config with above ini: * $router = new Zend_Controller_Router_Rewrite(); * $router->addConfig($config,'routes'); * * @param Zend_Config $config Configuration object * @param string $section Name of the config section containing route's definitions * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Router_Rewrite */ public function addConfig(Zend_Config $config,$section = null) { if ($section !== null) { if ($config->{$section} === null) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("No route configuration in section '{$section}'"); } $config = $config->{$section}; } foreach ($config as $name => $info) { $route = $this->_getRouteFromConfig($info); if ($route instanceof Zend_Controller_Router_Route_Chain) { if (!isset($info->chain)) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("No chain defined"); } if ($info->chain instanceof Zend_Config) { $childRouteNames = $info->chain; } else { $childRouteNames = explode(',',$info->chain); } foreach ($childRouteNames as $childRouteName) { $childRoute = $this->getRoute(trim($childRouteName)); $route->chain($childRoute); } $this->addRoute($name,$route); } elseif (isset($info->chains) && $info->chains instanceof Zend_Config) { $this->_addChainRoutesFromConfig($name,$route,$info->chains); } else { $this->addRoute($name,$route); } } return $this; } /** * Get a route frm a config instance * * @param Zend_Config $info * @return Zend_Controller_Router_Route_Interface */ protected function _getRouteFromConfig(Zend_Config $info) { $class = (isset($info->type)) ? $info->type : 'Zend_Controller_Router_Route'; if (!class_exists($class)) { require_once 'Zend/Loader.PHP'; Zend_Loader::loadClass($class); } $route = call_user_func(array($class,'getInstance'),$info); if (isset($info->abstract) && $info->abstract && method_exists($route,'isAbstract')) { $route->isAbstract(true); } return $route; } /** * Add chain routes from a config route * * @param string $name * @param Zend_Controller_Router_Route_Interface $route * @param Zend_Config $childRoutesInfo * @return void */ protected function _addChainRoutesFromConfig($name,Zend_Controller_Router_Route_Interface $route,Zend_Config $childRoutesInfo) { foreach ($childRoutesInfo as $childRouteName => $childRouteInfo) { if (is_string($childRouteInfo)) { $childRouteName = $childRouteInfo; $childRoute = $this->getRoute($childRouteName); } else { $childRoute = $this->_getRouteFromConfig($childRouteInfo); } if ($route instanceof Zend_Controller_Router_Route_Chain) { $chainRoute = clone $route; $chainRoute->chain($childRoute); } else { $chainRoute = $route->chain($childRoute); } $chainName = $name . $this->_chainNameSeparator . $childRouteName; if (isset($childRouteInfo->chains)) { $this->_addChainRoutesFromConfig($chainName,$chainRoute,$childRouteInfo->chains); } else { $this->addRoute($chainName,$chainRoute); } } } /** * Remove a route from the route chain * * @param string $name Name of the route * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Router_Rewrite */ public function removeRoute($name) { if (!isset($this->_routes[$name])) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("Route $name is not defined"); } unset($this->_routes[$name]); return $this; } /** * Remove all standard default routes * * @param Zend_Controller_Router_Route_Interface Route * @return Zend_Controller_Router_Rewrite */ public function removeDefaultRoutes() { $this->_useDefaultRoutes = false; return $this; } /** * Check if named route exists * * @param string $name Name of the route * @return boolean */ public function hasRoute($name) { return isset($this->_routes[$name]); } /** * Retrieve a named route * * @param string $name Name of the route * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Router_Route_Interface Route object */ public function getRoute($name) { if (!isset($this->_routes[$name])) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("Route $name is not defined"); } return $this->_routes[$name]; } /** * Retrieve a currently matched route * * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Router_Route_Interface Route object */ public function getCurrentRoute() { if (!isset($this->_currentRoute)) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("Current route is not defined"); } return $this->getRoute($this->_currentRoute); } /** * Retrieve a name of currently matched route * * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Router_Route_Interface Route object */ public function getCurrentRouteName() { if (!isset($this->_currentRoute)) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception("Current route is not defined"); } return $this->_currentRoute; } /** * Retrieve an array of routes added to the route chain * * @return array All of the defined routes */ public function getRoutes() { return $this->_routes; } /** * Find a matching route to the current PATH_INFO and inject * returning values to the Request object. * * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Request_Abstract Request object */ public function route(Zend_Controller_Request_Abstract $request) { if (!$request instanceof Zend_Controller_Request_Http) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception('Zend_Controller_Router_Rewrite requires a Zend_Controller_Request_Http-based request object'); } if ($this->_useDefaultRoutes) { $this->addDefaultRoutes(); } // Find the matching route $routeMatched = false; foreach (array_reverse($this->_routes,true) as $name => $route) { // TODO: Should be an interface method. Hack for 1.0 BC if (method_exists($route,'isAbstract') && $route->isAbstract()) { continue; } // TODO: Should be an interface method. Hack for 1.0 BC if (!method_exists($route,'getVersion') || $route->getVersion() == 1) { $match = $request->getPathInfo(); } else { $match = $request; } if ($params = $route->match($match)) { $this->_setRequestParams($request,$params); $this->_currentRoute = $name; $routeMatched = true; break; } } if (!$routeMatched) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception('No route matched the request',404); } if($this->_useCurrentParamsAsGlobal) { $params = $request->getParams(); foreach($params as $param => $value) { $this->setGlobalParam($param,$value); } } return $request; } protected function _setRequestParams($request,$params) { foreach ($params as $param => $value) { $request->setParam($param,$value); if ($param === $request->getModuleKey()) { $request->setModuleName($value); } if ($param === $request->getControllerKey()) { $request->setControllerName($value); } if ($param === $request->getActionKey()) { $request->setActionName($value); } } } /** * Generates a URL path that can be used in URL creation,etc. * * @param array $userParams Options passed by a user used to override parameters * @param mixed $name The name of a Route to use * @param bool $reset Whether to reset to the route defaults ignoring URL params * @param bool $encode Tells to encode URL parts on output * @throws Zend_Controller_Router_Exception * @return string Resulting absolute URL path */ public function assemble($userParams,$encode = true) { if (!is_array($userParams)) { require_once 'Zend/Controller/Router/Exception.PHP'; throw new Zend_Controller_Router_Exception('userParams must be an array'); } if ($name == null) { try { $name = $this->getCurrentRouteName(); } catch (Zend_Controller_Router_Exception $e) { $name = 'default'; } } // Use UNION (+) in order to preserve numeric keys $params = $userParams + $this->_globalParams; $route = $this->getRoute($name); $url = $route->assemble($params,$reset,$encode); if (!preg_match('|^[a-z]+://|',$url)) { $url = rtrim($this->getFrontController()->getBaseUrl(),self::URI_DELIMITER) . self::URI_DELIMITER . $url; } return $url; } /** * Set a global parameter * * @param string $name * @param mixed $value * @return Zend_Controller_Router_Rewrite */ public function setGlobalParam($name,$value) { $this->_globalParams[$name] = $value; return $this; } /** * Set the separator to use with chain names * * @param string $separator The separator to use * @return Zend_Controller_Router_Rewrite */ public function setChainNameSeparator($separator) { $this->_chainNameSeparator = $separator; return $this; } /** * Get the separator to use for chain names * * @return string */ public function getChainNameSeparator() { return $this->_chainNameSeparator; } /** * Determines/returns whether to use the request parameters as global parameters. * * @param boolean|null $use * Null/unset when you want to retrieve the current state. * True when request parameters should be global,false otherwise * @return boolean|Zend_Controller_Router_Rewrite * Returns a boolean if first param isn't set,returns an * instance of Zend_Controller_Router_Rewrite otherwise. * */ public function useRequestParametersAsGlobal($use = null) { if($use === null) { return $this->_useCurrentParamsAsGlobal; } $this->_useCurrentParamsAsGlobal = (bool) $use; return $this; } }

getRouter(); // returns a rewrite router by default $router->addRoute('user',new Zend_Controller_Router_Route('user/:username'));

PHP;"> "url(array('username' => 'martel'),'user') ?>">Martel

setControllerDirectory( array( 'default' => '/path/to/default/controllers','news' => '/path/to/news/controllers','blog' => '/path/to/blog/controllers' ) ); Module only: http://example/news module == news Invalid module maps to controller name: http://example/foo controller == foo Module + controller: http://example/blog/archive module == blog controller == archive Module + controller + action: http://example/blog/archive/list module == blog controller == archive action == list Module + controller + action + params: http://example/blog/archive/list/sort/alpha/date/desc module == blog controller == archive action == list sort == alpha date == desc

addRoute('default',$compat);

removeDefaultRoutes();

'profile','action' => 'userinfo' ) ); $router->addRoute('user',$route);

'martel','controller' => 'profile','action' => 'userinfo' );

getRequest(); $username = $request->getParam('username'); $username = $this->_getParam('username'); }

'default') ); $router->addRoute('default',$route);

2006) ); $router->addRoute('archive',$route);

2006,'controller' => 'archive','action' => 'show' ) ); $router->addRoute('archive',$route);

'show' ),array('year' => '\d+') ); $router->addRoute('archive',$route);

'blog.mysite.com','path' => 'archive' ),array( 'module' => 'blog','action' => 'index' ) ); $router->addRoute('archive',$route);

array( 'regex' => '([a-z]+).mysite.com','reverse' => '%s.mysite.com' 'params' => array( 1 => 'username' ) ),'path' => '' ),array( 'module' => 'users','action' => 'index' ) ); $router->addRoute('profile',$route);

'auth','action' => 'login') ); $router->addRoute('login',$route);

'archive',$route);

'2006','action' => 'show' );

getRequest(); $year = $request->getParam(1); // $year = '2006'; }

'2006',$route);

'show' ),array( 1 => 'year' ) ); $router->addRoute('archive',$route);

'2006','action' => 'show' );

'year') ); // OR $route = new Zend_Controller_Router_Route_Regex( 'archive/(\d+)',array('year' => 1) );

1) );

'2006',2 => 10,'action' => 'show' );

1),'archive/%s' );

'blog','action' => 'view' ),array( 1 => 'id',2 => 'description' ),'blog/archive/%d-%s.html' ); $router->addRoute('blogArchive',$route);

addConfig($config,'routes');

PHP;"> interface Zend_Controller_Router_Interface { /** * @param Zend_Controller_Request_Abstract $request * @throws Zend_Controller_Router_Exception * @return Zend_Controller_Request_Abstract */ public function route(Zend_Controller_Request_Abstract $request); }