Controller/Router/Route.php

Show:

inherited

Classes
- \Zend_Controller_Router_Route

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Controller
Subpackage: Router
Version: $Id: Route.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Controller_Router_Route
jump to top

Package: Zend\Controller\Router

Route

Implements interface and provides convenience methods

Parent(s): \Zend_Controller_Router_Route_Abstract
See: \global\http://manuals.rubyonrails.com/read/chapter/65
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                URI_DELIMITER
                = '/'

inherited

URI delimiter

Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Inherited_from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Properties

mixed $_defaultLocale =

static

Default locale

Details

Type: mixed

$_defaultRegex = null

Default valuenullDetails

Type: n/a

\Zend_Translate $_defaultTranslator =

static

Default translator

Details

Type: \Zend_Translate

array $_defaults = array()

Holds user submitted default values for route's variables.

Name and value pairs.

Default valuearray()Details

Type: array

boolean $_isAbstract = false

inherited

Wether this route is abstract or not

Inherited from: \Zend_Controller_Router_Route_Abstract::$$_isAbstract

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Controller_Router_Route_Abstract::$$_isAbstract

boolean $_isTranslated = false

Wether this is a translated route or not

Default valuefalseDetails

Type: boolean

mixed $_locale =

Locale

Details

Type: mixed

string $_matchedPath = null

inherited

Path matched by this route

Inherited from: \Zend_Controller_Router_Route_Abstract::$$_matchedPath

Default valuenullDetails

Type: string
Inherited_from: \Zend_Controller_Router_Route_Abstract::$$_matchedPath

array $_parts = array()

Holds Route patterns for all URL parts.

In case of a variable it stores it's regex requirement or null. In case of a static part, it holds only it's direct value. In case of a wildcard, it stores an asterisk (*)

Default valuearray()Details

Type: array

$_regexDelimiter = '#'

Default value'#'Details

Type: n/a

array $_requirements = array()

Holds user submitted regular expression patterns for route's variables' values.

Name and value pairs.

Default valuearray()Details

Type: array

int $_staticCount = 0

Helper var that holds a count of route pattern's static parts for validation

Default value0Details

Type: int

array $_translatable = array()

Translatable variables

Default valuearray()Details

Type: array

\Zend_Translate $_translator =

Translator

Details

Type: \Zend_Translate

$_urlDelimiter = self::URI_DELIMITER

Default valueself::URI_DELIMITERDetails

Type: n/a

$_urlVariable = ':'

Default value':'Details

Type: n/a

array $_values = array()

Associative array filled on match() that holds matched path values for given variable names.

Default valuearray()Details

Type: array

array $_variables = array()

Holds names of all route's pattern variable names.

Array index holds a position in URL.

Default valuearray()Details

Type: array

array $_wildcardData = array()

Associative array filled on match() that holds wildcard variable names and values.

Default valuearray()Details

Type: array

Methods

__construct(string $route, array $defaults = array(), array $reqs = array(), \Zend_Translate $translator = null,  $locale = null) : void

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

Name	Type	Description
$route	string	Map used to match with later submitted URL path
$defaults	array	Defaults for map variables with keys as variable names
$reqs	array	Regular expression requirements for variables (keys as variable names)
$translator	\Zend_Translate	Translator to use for this instance
$locale

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

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

Parameters

Name	Type	Description
$data	array	An array of variable and value pairs used as parameters
$reset	boolean	Whether or not to set route defaults with those provided in $data
$encode
$partial

Returns

Type	Description
string	Route path with user submitted parameters

chain(\Zend_Controller_Router_Route_Abstract $route, string $separator = '/') : \Zend_Controller_Router_Route_Chain

inherited

Create a new chain

Inherited from: \Zend_Controller_Router_Route_Abstract::chain()

Parameters

Name	Type	Description
$route	\Zend_Controller_Router_Route_Abstract
$separator	string

Returns

Type	Description
\Zend_Controller_Router_Route_Chain

getDefault(string $name) : string

Return a single parameter of route's defaults

Parameters

Name	Type	Description
$name	string	Array key of the parameter

Returns

Type	Description
string	Previously set default

getDefaultLocale() : mixed

static

Get the default locale

Returns

Type	Description
mixed

getDefaultTranslator() : \Zend_Translate

static

Get the default translator

Returns

Type	Description
\Zend_Translate

getDefaults() : array

Return an array of defaults

Returns

Type	Description
array	Route defaults

getInstance(\Zend_Config $config) : void

static

Instantiates route based on passed Zend_Config structure

Parameters

Name	Type	Description
$config	\Zend_Config	Configuration object

getLocale() : mixed

Get the locale

Returns

Type	Description
mixed

getMatchedPath() : string

inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()

Returns

Type	Description
string

getTranslator() : \Zend_Translate

Get the translator

Returns

Type	Description
\Zend_Translate

Throws

Exception	Description
\Zend_Controller_Router_Exception	When no translator can be found

getVariables() : array

Get all variables which are used by the route

Returns

Type	Description
array

getVersion() : integer

Get the version of the route

Returns

Type	Description
integer

isAbstract(boolean $flag = null) : boolean

inherited

Check or set wether this is an abstract route or not

Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()

Parameters

Name	Type	Description
$flag	boolean

Returns

Type	Description
boolean

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

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

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

Parameters

Name	Type	Description
$path	string	Path used to match against this routing map
$partial

Returns

Type	Description
array \| false	An array of assigned values or a false on a mismatch

setDefaultLocale(mixed $locale = null) : void

static

Set a default locale

Parameters

Name	Type	Description
$locale	mixed

setDefaultTranslator(\Zend_Translate $translator = null) : void

static

Set a default translator

Parameters

Name	Type	Description
$translator	\Zend_Translate

setLocale(mixed $locale) : void

Set a locale

Parameters

Name	Type	Description
$locale	mixed

setMatchedPath(string $path) : void

inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()

Parameters

Name	Type	Description
$path	string

setTranslator(\Zend_Translate $translator) : void

Set a translator

Parameters

Name	Type	Description
$translator	\Zend_Translate

Controller/Router/Route.php

\Zend_Controller_Router_Routejump to top

Constants

Properties

Methods

\Zend_Controller_Router_Route
jump to top