Zend_Controller_Router_Route Class Reference

Public Member Functions
	getVersion ()
	__construct ($route, $defaults=array(), $reqs=array(), Zend_Translate $translator=null, $locale=null)
	Prepares the route for mapping by splitting (exploding) it to a corresponding atomic parts.
	match ($path, $partial=false)
	Matches a user submitted path with parts defined by a map.
	assemble ($data=array(), $reset=false, $encode=false, $partial=false)
	Assembles user submitted parameters forming a URL path defined by this route.
	getDefault ($name)
	Return a single parameter of route's defaults.
	getDefaults ()
	Return an array of defaults.
	getVariables ()
	Get all variables which are used by the route.
	setTranslator (Zend_Translate $translator)
	Set a translator.
	getTranslator ()
	Get the translator.
	setLocale ($locale)
	Set a locale.
	getLocale ()
	Get the locale.
Public Member Functions inherited from Zend_Controller_Router_Route_Abstract
	getVersion ()
	Get the version of the route.
	setMatchedPath ($path)
	Set partially matched path.
	getMatchedPath ()
	Get partially matched path.
	isAbstract ($flag=null)
	Check or set wether this is an abstract route or not.
	chain (Zend_Controller_Router_Route_Abstract $route, $separator= '/')
	Create a new chain.
Public Member Functions inherited from Zend_Controller_Router_Route_Interface
	match ($path)
	assemble ($data=array(), $reset=false, $encode=false)

Static Public Member Functions
static	getInstance (Zend_Config $config)
	Instantiates route based on passed Zend_Config structure.
static	setDefaultTranslator (Zend_Translate $translator=null)
	Set a default translator.
static	getDefaultTranslator ()
	Get the default translator.
static	setDefaultLocale ($locale=null)
	Set a default locale.
static	getDefaultLocale ()
	Get the default locale.

Protected Attributes
	$_translator
	$_locale
	$_isTranslated = false
	$_translatable = array()
	$_urlVariable = ':'
	$_urlDelimiter = self::URI_DELIMITER
	$_regexDelimiter = '#'
	$_defaultRegex = null
	$_variables = array()
	$_parts = array()
	$_defaults = array()
	$_requirements = array()
	$_values = array()
	$_wildcardData = array()
	$_staticCount = 0
Protected Attributes inherited from Zend_Controller_Router_Route_Abstract
	$_isAbstract = false
	$_matchedPath = null

Static Protected Attributes
static	$_defaultTranslator
static	$_defaultLocale

Additional Inherited Members
Public Attributes inherited from Zend_Controller_Router_Route_Abstract
const	URI_DELIMITER = '/'
	URI delimiter.

Constructor & Destructor Documentation

__construct	(		$route,
			$defaults = array(),
			$reqs = array(),
		Zend_Translate	$translator = null,
			$locale = null
	)

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.

Parameters

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)
Zend_Translate	$translator	Translator to use for this instance

Member Function Documentation

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

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

Parameters

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

Returns

string Route path with user submitted parameters

getDefault

(

$name

)

Return a single parameter of route's defaults.

Parameters

string

$name

Array key of the parameter

Returns

string Previously set default

static getDefaultLocale ( )

static

Get the default locale.

Returns

mixed

getDefaults

(

)

Return an array of defaults.

Returns

array Route defaults

static getDefaultTranslator ( )

static

Get the default translator.

Returns

Zend_Translate

static getInstance ( Zend_Config  $config )

static

Instantiates route based on passed Zend_Config structure.

Parameters

Zend_Config

$config

Configuration object

Implements Zend_Controller_Router_Route_Interface.

getLocale

(

)

Get the locale.

Returns

mixed

getTranslator

(

)

Get the translator.

Exceptions

Zend_Controller_Router_Exception

When no translator can be found

Returns

Zend_Translate

getVariables

(

)

Get all variables which are used by the route.

Returns

array

getVersion

(

)

match	(		$path,
			$partial = false
	)

Matches a user submitted path with parts defined by a map.

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

Parameters

string

$path

Path used to match against this routing map

Returns

array|false An array of assigned values or a false on a mismatch

static setDefaultLocale (   $locale = null )

static

Set a default locale.

Parameters

mixed

$locale

Returns

void

static setDefaultTranslator ( Zend_Translate  $translator = null )

static

Set a default translator.

Parameters

Zend_Translate

$translator

Returns

void

setLocale

(

$locale

)

Set a locale.

Parameters

mixed

$locale

Returns

void

setTranslator

(

Zend_Translate

$translator

)

Set a translator.

Parameters

Zend_Translate

$translator

Returns

void

Member Data Documentation

$_defaultLocale

staticprotected

$_defaultRegex = null

protected

$_defaults = array()

protected

$_defaultTranslator

staticprotected

$_isTranslated = false

protected

$_locale

protected

$_parts = array()

protected

$_regexDelimiter = '#'

protected

$_requirements = array()

protected

$_staticCount = 0

protected

$_translatable = array()

protected

$_translator

protected

$_urlDelimiter = self::URI_DELIMITER

protected

$_urlVariable = ':'

protected

$_values = array()

protected

$_variables = array()

protected

$_wildcardData = array()

protected