Docs For Class Zend_Controller_Router_Route

Description

StaticRoute is used for managing static URIs.

It's a lot faster compared to the standard Route implementation.

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Controller/Router/Route/Static.php (line 36)

Zend_Controller_Router_Route_Abstract
   |
   --Zend_Controller_Router_Route_Static

Variable Summary

mixed $_defaults

mixed $_route

Method Summary

static void getInstance ( $config)

Zend_Controller_Router_Route_Static __construct (string $route, [array $defaults = array()])

string assemble ([array $data = array()], [ $reset = false], [ $encode = false], [ $partial = false])

string getDefault (string $name)

array getDefaults ()

void getVersion ()

array|false match (string $path, [ $partial = false])

Variables

mixed $_defaults = array() (line 40)

access: protected

mixed $_route = null (line 39)

access: protected

Inherited Variables

Inherited from Zend_Controller_Router_Route_Abstract

Zend_Controller_Router_Route_Abstract::$_isAbstract
Zend_Controller_Router_Route_Abstract::$_matchedPath

Methods

static getInstance (line 51)

Instantiates route based on passed Zend_Config structure

access: public

static void getInstance ( $config)

Zend_Config $config: Configuration object

Constructor __construct (line 63)

Prepares the route for mapping.

access: public

Zend_Controller_Router_Route_Static __construct (string $route, [array $defaults = array()])

string $route: Map used to match with later submitted URL path
array $defaults: Defaults for map variables with keys as variable names

assemble (line 98)

Assembles a URL path defined by this route

return: Route path with user submitted parameters
access: public

string assemble ([array $data = array()], [ $reset = false], [ $encode = false], [ $partial = false])

array $data: An array of variable and value pairs used as parameters
$reset
$encode
$partial

getDefault (line 109)

Return a single parameter of route's defaults

return: Previously set default
access: public

string getDefault (string $name)

string $name: Array key of the parameter

getDefaults (line 121)

Return an array of defaults

return: Route defaults
access: public

array getDefaults ()

getVersion (line 42)

access: public

void getVersion ()

Redefinition of:

Zend_Controller_Router_Route_Abstract::getVersion(): Get the version of the route

match (line 76)

Matches a user submitted path with a previously defined route.

Assigns and returns an array of defaults on a successful match.

return: An array of assigned values or a false on a mismatch
access: public

array|false match (string $path, [ $partial = false])

string $path: Path used to match against this routing map
$partial

Inherited Methods

Inherited From Zend_Controller_Router_Route_Abstract

Zend_Controller_Router_Route_Abstract::chain()
Zend_Controller_Router_Route_Abstract::getMatchedPath()
Zend_Controller_Router_Route_Abstract::getVersion()
Zend_Controller_Router_Route_Abstract::isAbstract()
Zend_Controller_Router_Route_Abstract::setMatchedPath()