API Documentation

Controller/Router/Route.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  
version
$Id: Route.php 24183 2011-07-04 16:08:16Z guilhermeblanco $  

\Zend_Controller_Router_Route

Route

Implements interface and provides convenience methods

Extends from
\Zend_Controller_Router_Route_Abstract
see
\http://manuals.rubyonrails.com/read/chapter/65  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  

Properties

Propertyprotectedmixed  $_defaultLocale= ''
static

Default locale

Details
Type
mixed
Propertyprotected  $_defaultRegex= 'null'
Default valuenullDetails
Type
Propertyprotected\Zend_Translate  $_defaultTranslator= ''
static

Default translator

Details
Type
\Zend_Translate
Propertyprotectedarray  $_defaults= 'array'

Holds user submitted default values for route's variables. Name and value pairs.

Default valuearrayDetails
Type
array
Propertyprotectedboolean  $_isTranslated= 'false'

Wether this is a translated route or not

Default valuefalseDetails
Type
boolean
Propertyprotectedmixed  $_locale= ''

Locale

Details
Type
mixed
Propertyprotectedarray  $_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 valuearrayDetails
Type
array
Propertyprotected  $_regexDelimiter= '#'
Default value#Details
Type
Propertyprotectedarray  $_requirements= 'array'

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

Name and value pairs.

Default valuearrayDetails
Type
array
Propertyprotectedint  $_staticCount= '0'

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

Default value0Details
Type
int
Propertyprotectedarray  $_translatable= 'array'

Translatable variables

Default valuearrayDetails
Type
array
Propertyprotected\Zend_Translate  $_translator= ''

Translator

Details
Type
\Zend_Translate
Propertyprotected  $_urlDelimiter= 'self'
Default valueselfDetails
Type
Propertyprotected  $_urlVariable= ':'
Default value:Details
Type
Propertyprotectedarray  $_values= 'array'

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

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_variables= 'array'

Holds names of all route's pattern variable names. Array index holds a position in URL.

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_wildcardData= 'array'

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

Default valuearrayDetails
Type
array

Methods

methodpublic__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
methodpublicassemble( 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
methodpublicchain( \Zend_Controller_Router_Route_Abstract $route, string $separator = / ) : \Zend_Controller_Router_Route_Chain

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
methodpublicgetDefault( 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
methodpublicgetDefaultLocale( ) : mixed
static

Get the default locale

Returns
Type Description
mixed
methodpublicgetDefaultTranslator( ) : \Zend_Translate
static

Get the default translator

Returns
Type Description
\Zend_Translate
methodpublicgetDefaults( ) : array

Return an array of defaults

Returns
Type Description
array Route defaults
methodpublicgetInstance( \Zend_Config $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config \Zend_Config Configuration object
methodpublicgetLocale( ) : mixed

Get the locale

Returns
Type Description
mixed
methodpublicgetMatchedPath( ) : string

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()
Returns
Type Description
string
methodpublicgetTranslator( ) : \Zend_Translate

Get the translator

Returns
Type Description
\Zend_Translate
Throws
Exception Description
\Zend_Controller_Router_Exception When no translator can be found
methodpublicgetVariables( ) : array

Get all variables which are used by the route

Returns
Type Description
array
methodpublicgetVersion( ) : integer

Get the version of the route

Returns
Type Description
integer
methodpublicisAbstract( boolean $flag = null ) : boolean

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
methodpublicmatch( 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
arrayfalse An array of assigned values or a false on a mismatch
methodpublicsetDefaultLocale( mixed $locale = null ) : void
static

Set a default locale

Parameters
Name Type Description
$locale mixed
methodpublicsetDefaultTranslator( \Zend_Translate $translator = null ) : void
static

Set a default translator

Parameters
Name Type Description
$translator \Zend_Translate
methodpublicsetLocale( mixed $locale ) : void

Set a locale

Parameters
Name Type Description
$locale mixed
methodpublicsetMatchedPath( string $path ) : void

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
Name Type Description
$path string
methodpublicsetTranslator( \Zend_Translate $translator ) : void

Set a translator

Parameters
Name Type Description
$translator \Zend_Translate
Documentation was generated by DocBlox 0.13.3.