Controller/Router/Route/Regex.php

Show:

inherited

Classes
- \Zend_Controller_Router_Route_Regex

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: Regex.php 24593 2012-01-05 20:35:02Z matthew $

\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-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

$_defaults = array()

Default valuearray()Details

Type: n/a

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

$_map = array()

Default valuearray()Details

Type: n/a

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

$_regex = null

Default valuenullDetails

Type: n/a

$_reverse = null

Default valuenullDetails

Type: n/a

$_values = array()

Default valuearray()Details

Type: n/a

Methods

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

Parameters

Name	Type	Description
$route
$defaults
$map
$reverse

_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

Name	Type	Description
$array1	array
$array2	array

Returns

Type	Description
array

_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

Name	Type	Description
$values	array	Indexed or associative array of values to map
$reversed	boolean	False means translation of index to association. True means reverse.
$preserve	boolean	Should wrong type of keys be preserved or stripped.

Returns

Type	Description
array	An array of mapped values

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

Assembles a URL path defined by this route

Parameters

Name	Type	Description
$data	array	An array of name (or index) and value pairs used as parameters
$reset
$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

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

getMatchedPath() : string

inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()

Returns

Type	Description
string

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

Assigns and returns an array of defaults 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

setMatchedPath(string $path) : void

inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()

Parameters

Name	Type	Description
$path	string

Controller/Router/Route/Regex.php

\Zend_Controller_Router_Route_Regexjump to top

Constants

Properties

Methods

\Zend_Controller_Router_Route_Regex
jump to top