Controller/Router/Route/Chain.php
Show:
inherited
inherited
Classes
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_Chain
Package: Zend_Controller\Router
Returns
Chain route is used for managing route chaining.
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
$_routes = array()Default value
array()Details- Type
- n/a
$_separators = array()Default value
array()Details- Type
- n/a
Methods
assemble(array $data = array(), bool $reset = false, bool $encode = false) : stringAssembles a URL path defined by this route
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | array | An array of variable and value pairs used as parameters |
| $reset | bool | |
| $encode | bool |
| Type | Description |
|---|---|
| string | Route path with user submitted parameters |
chain(\Zend_Controller_Router_Route_Abstract $route, string $separator = self::URI_DELIMITER) : \Zend_Controller_Router_Route_ChainAdd a route to this chain
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $route | \Zend_Controller_Router_Route_Abstract | |
| $separator | string |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Route_Chain |
getDefault(string $name) : stringReturn a single parameter of route's defaults
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Array key of the parameter |
| Type | Description |
|---|---|
| string | Previously set default |
getDefaults() : arrayReturn an array of defaults
Returns
| Type | Description |
|---|---|
| array | Route defaults |
getInstance(\Zend_Config $config) : \Zend_Controller_Router_Route_Chainstatic
Instantiates route based on passed Zend_Config structure
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $config | \Zend_Config | Configuration object |
| Type | Description |
|---|---|
| \Zend_Controller_Router_Route_Chain |
match(\Zend_Controller_Request_Http $request, null $partial = null) : array | falseMatches a user submitted path with a previously defined route.
Assigns and returns an array of defaults on a successful match.
Parameters| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Http | Request to get the path info from |
| $partial | null |
| Type | Description |
|---|---|
| array | false | An array of assigned values or a false on a mismatch |
setRequest(\Zend_Controller_Request_Abstract | null $request = null) : voidSet the request object for this and the child routes
Parameters
| Name | Type | Description |
|---|---|---|
| $request | \Zend_Controller_Request_Abstract | null |