Controller/Router/Route/Regex.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 license@zend.com 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_Regex
jump to top

Package: Zend_Controller\Router
Regex Route
Implements interface and provides convenience methods
Parent(s)
\Zend_Controller_Router_Route_Abstract
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_defaults = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_map = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_regex = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_reverse = null
Default valuenullDetails
Type
n/a
>VPropertyprotected$_values = array()
Default valuearray()Details
Type
n/a

Methods

methodpublic__construct( $route,  $defaults = array(),  $map = array(),  $reverse = null) : void

Parameters
NameTypeDescription
$route
$defaults
$map
$reverse
methodprotected_arrayMergeNumericKeys(array $array1, array $array2) : array

_arrayMergeNumericKeys() - allows for a strict key (numeric's included) array_merge.

php's array_merge() lacks the ability to merge with numeric keys.
Parameters
NameTypeDescription
$array1array
$array2array
Returns
TypeDescription
array
methodprotected_getMappedValues(array $values, boolean $reversed = false, boolean $preserve = false) : array

Maps numerically indexed array values to it's associative mapped counterpart.

Or vice versa. Uses user provided map array which consists of index => name parameter mapping. If map is not found, it returns original array. Method strips destination type of keys form source array. Ie. if source array is indexed numerically then every associative key will be stripped. Vice versa if reversed is set to true.
Parameters
NameTypeDescription
$valuesarray

Indexed or associative array of values to map

$reversedboolean

False means translation of index to association. True means reverse.

$preserveboolean

Should wrong type of keys be preserved or stripped.

Returns
TypeDescription
arrayAn array of mapped values
methodpublicassemble(array $data = array(),  $reset = false,  $encode = false,  $partial = false) : string

Assembles a URL path defined by this route

Parameters
NameTypeDescription
$dataarray

An array of name (or index) and value pairs used as parameters

$reset
$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
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

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 a previously defined route.

Assigns and returns an array of defaults 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
Documentation was generated by phpDocumentor 2.2.0 .