Controller/Router/Route.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Router  
Version
$Id$  

\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
 
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedmixed $_defaultLocale
static
Default locale
Details
Type
mixed
>VPropertyprotected$_defaultRegex = null
Default valuenullDetails
Type
n/a
>VPropertyprotected\Zend_Translate $_defaultTranslator
static
Default translator
Details
Type
\Zend_Translate
>VPropertyprotectedarray $_defaults = array()
Holds user submitted default values for route's variables. Name and value pairs.
Default valuearray()Details
Type
array
>VPropertyprotectedboolean $_isTranslated = false
Wether this is a translated route or not
Default valuefalseDetails
Type
boolean
>VPropertyprotectedmixed $_locale
Locale
Details
Type
mixed
>VPropertyprotectedarray $_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
>VPropertyprotected$_regexDelimiter = '#'
Default value'#'Details
Type
n/a
>VPropertyprotectedarray $_requirements = array()
Holds user submitted regular expression patterns for route's variables' values.
Name and value pairs.
Default valuearray()Details
Type
array
>VPropertyprotectedint $_staticCount = 0
Helper var that holds a count of route pattern's static parts for validation
Default value0Details
Type
int
>VPropertyprotectedarray $_translatable = array()
Translatable variables
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Translate $_translator
Translator
Details
Type
\Zend_Translate
>VPropertyprotected$_urlDelimiter = self::URI_DELIMITER
Default valueself::URI_DELIMITERDetails
Type
n/a
>VPropertyprotected$_urlVariable = ':'
Default value':'Details
Type
n/a
>VPropertyprotectedarray $_values = array()
Associative array filled on match() that holds matched path values for given variable names.
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_variables = array()
Holds names of all route's pattern variable names. Array index holds a position in URL.
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_wildcardData = array()
Associative array filled on match() that holds wildcard variable names and values.
Default valuearray()Details
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
NameTypeDescription
$routestring

Map used to match with later submitted URL path

$defaultsarray

Defaults for map variables with keys as variable names

$reqsarray

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
NameTypeDescription
$dataarray

An array of variable and value pairs used as parameters

$resetboolean

Whether or not to set route defaults with those provided in $data

$encode
$partial
Returns
TypeDescription
stringRoute path with user submitted parameters
methodpublicgetDefault(string $name) : string

Return a single parameter of route's defaults

Parameters
NameTypeDescription
$namestring

Array key of the parameter

Returns
TypeDescription
stringPreviously set default
methodpublicgetDefaultLocale() : mixed
static

Get the default locale

Returns
TypeDescription
mixed
methodpublicgetDefaultTranslator() : \Zend_Translate
static

Get the default translator

Returns
TypeDescription
\Zend_Translate
methodpublicgetDefaults() : array

Return an array of defaults

Returns
TypeDescription
arrayRoute defaults
methodpublicgetInstance(\Zend_Config $config) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
NameTypeDescription
$config\Zend_Config

Configuration object

methodpublicgetLocale() : mixed

Get the locale

Returns
TypeDescription
mixed
methodpublicgetTranslator() : \Zend_Translate

Get the translator

Returns
TypeDescription
\Zend_Translate
Throws
ExceptionDescription
\Zend_Controller_Router_ExceptionWhen no translator can be found
methodpublicgetVariables() : array

Get all variables which are used by the route

Returns
TypeDescription
array
methodpublicgetVersion() : void

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
NameTypeDescription
$pathstring

Path used to match against this routing map

$partial
Returns
TypeDescription
array | falseAn array of assigned values or a false on a mismatch
methodpublicsetDefaultLocale(mixed $locale = null) : void
static

Set a default locale

Parameters
NameTypeDescription
$localemixed
methodpublicsetDefaultTranslator(\Zend_Translate $translator = null) : void
static

Set a default translator

Parameters
NameTypeDescription
$translator\Zend_Translate
methodpublicsetLocale(mixed $locale) : void

Set a locale

Parameters
NameTypeDescription
$localemixed
methodpublicsetTranslator(\Zend_Translate $translator) : void

Set a translator

Parameters
NameTypeDescription
$translator\Zend_Translate
Documentation was generated by phpDocumentor 2.2.0 .