Controller/Router/Route/Chain.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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Router  
Version
$Id: Chain.php 25249 2013-02-06 09:54:24Z frosch $  

\Zend_Controller_Router_Route_Chain

Package: Zend\Controller\Router
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  URI_DELIMITER = '/'
inherited
URI delimiter
Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Properties

>VPropertyprotectedboolean $_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  
>VPropertyprotectedstring $_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  
>VPropertyprotected$_routes = array()
Default valuearray()Details
Type
n/a
>VPropertyprotected$_separators = array()
Default valuearray()Details
Type
n/a

Methods

methodpublicassemble(array $data = array(), bool $reset = false, bool $encode = false) : string

Assembles a URL path defined by this route

Parameters
NameTypeDescription
$dataarray

An array of variable and value pairs used as parameters

$resetbool
$encodebool
Returns
TypeDescription
stringRoute path with user submitted parameters
methodpublicchain(\Zend_Controller_Router_Route_Abstract $route, string $separator = self::URI_DELIMITER) : \Zend_Controller_Router_Route_Chain

Add a route to this chain

Parameters
NameTypeDescription
$route\Zend_Controller_Router_Route_Abstract
$separatorstring
Returns
TypeDescription
\Zend_Controller_Router_Route_Chain
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) : \Zend_Controller_Router_Route_Chain
static

Instantiates route based on passed Zend_Config structure

Parameters
NameTypeDescription
$config\Zend_Config

Configuration object

Returns
TypeDescription
\Zend_Controller_Router_Route_Chain
methodpublicgetMatchedPath() : string
inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()
Returns
TypeDescription
string
methodpublicgetVersion() : integer
inherited

Get the version of the route

Inherited from: \Zend_Controller_Router_Route_Abstract::getVersion()
Returns
TypeDescription
integer
methodpublicisAbstract(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
NameTypeDescription
$flagboolean
Returns
TypeDescription
boolean
methodpublicmatch(\Zend_Controller_Request_Http $request, null $partial = null) : 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
$request\Zend_Controller_Request_Http

Request to get the path info from

$partialnull
Returns
TypeDescription
array | falseAn array of assigned values or a false on a mismatch
methodpublicsetMatchedPath(string $path) : void
inherited

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
NameTypeDescription
$pathstring
methodpublicsetRequest(\Zend_Controller_Request_Abstract | null $request = null) : void

Set the request object for this and the child routes

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract | null
Documentation was generated by phpDocumentor 2.0.0a12.