Class Zend_Controller_Router_Route

Description

Implements interfaces:

Route

Located in /Controller/Router/Route.php (line 37)


	
			
Variable Summary
Method Summary
 static void getInstance ( $config)
 Zend_Controller_Router_Route __construct (string $route, [array $defaults = array()], [array $reqs = array()])
 string assemble ([array $data = array()], [boolean $reset = false])
 string getDefault (name $name)
 array getDefaults ()
 array|false match (string $path)
 void _getWildcardData ( $parts,  $unique)
Variables
mixed $_defaultRegex = null (line 43)
  • access: protected
mixed $_defaults = array() (line 46)
  • access: protected
mixed $_params = array() (line 50)
  • access: protected
mixed $_parts (line 45)
  • access: protected
mixed $_regexDelimiter = '#' (line 42)
  • access: protected
mixed $_requirements = array() (line 47)
  • access: protected
mixed $_staticCount = 0 (line 48)
  • access: protected
mixed $_urlDelimiter = '/' (line 41)
  • access: protected
mixed $_urlVariable = ':' (line 40)
  • access: protected
mixed $_values = array() (line 51)
  • access: protected
mixed $_vars = array() (line 49)
  • access: protected
Methods
static getInstance (line 56)

Instantiates route based on passed Zend_Config structure

  • access: public
static void getInstance ( $config)

Implementation of:
Zend_Controller_Router_Route_Interface::getInstance()
Constructor __construct (line 72)

Prepares the route for mapping by splitting (exploding) it to a corresponding atomic parts. These parts are assigned a position which is later used for matching and preparing values.

  • access: public
Zend_Controller_Router_Route __construct (string $route, [array $defaults = array()], [array $reqs = array()])
  • string $route: Map used to match with later submitted URL path
  • array $defaults: Defaults for map variables with keys as variable names
  • array $reqs: Regular expression requirements for variables (keys as variable names)
assemble (line 210)

Assembles user submitted parameters forming a URL path defined by this route

  • return: Route path with user submitted parameters
  • access: public
string assemble ([array $data = array()], [boolean $reset = false])
  • array $data: An array of variable and value pairs used as parameters
  • boolean $reset: Whether or not to set route defaults with those provided in $data

Implementation of:
Zend_Controller_Router_Route_Interface::assemble()
getDefault (line 274)

Return a single parameter of route's defaults

  • return: Previously set default
  • access: public
string getDefault (name $name)
  • name $name: Array key of the parameter
getDefaults (line 286)

Return an array of defaults

  • return: Route defaults
  • access: public
array getDefaults ()
match (line 124)

Matches a user submitted path with parts defined by a map. Assigns and returns an array of variables on a successful match.

  • return: An array of assigned values or a false on a mismatch
  • access: public
array|false match (string $path)
  • string $path: Path used to match against this routing map

Implementation of:
Zend_Controller_Router_Route_Interface::match()
_getWildcardData (line 101)
  • access: protected
void _getWildcardData ( $parts,  $unique)
  • $parts
  • $unique

Documentation generated on Wed, 28 Nov 2007 15:48:06 -0600 by phpDocumentor 1.4.0