API Documentation

Controller/Router/Route/Chain.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  
version
$Id: Chain.php 24182 2011-07-03 13:43:05Z adamlundrigan $  

\Zend_Controller_Router_Route_Chain

Chain route is used for managing route chaining.

Implements interface and provides convenience methods

Extends from
\Zend_Controller_Router_Route_Abstract
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Controller  
subpackage
Router  

Properties

Propertyprotected  $_routes= 'array'
Default valuearrayDetails
Type
Propertyprotected  $_separators= 'array'
Default valuearrayDetails
Type

Methods

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

Assembles a URL path defined by this route

Parameters
Name Type Description
$data array An array of variable and value pairs used as parameters
$reset
$encode
Returns
Type Description
string Route path with user submitted parameters
methodpublicchain( \Zend_Controller_Router_Route_Abstract $route, string $separator = self ) : \Zend_Controller_Router_Route_Chain

Add a route to this chain

Parameters
Name Type Description
$route \Zend_Controller_Router_Route_Abstract
$separator string
Returns
Type Description
\Zend_Controller_Router_Route_Chain
methodpublicgetInstance( \Zend_Config $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config \Zend_Config Configuration object
methodpublicgetMatchedPath( ) : string

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()
Returns
Type Description
string
methodpublicgetVersion( ) : integer

Get the version of the route

Inherited from: \Zend_Controller_Router_Route_Abstract::getVersion()
Returns
Type Description
integer
methodpublicisAbstract( boolean $flag = null ) : boolean

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
methodpublicmatch( \Zend_Controller_Request_Http $request,  $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
Name Type Description
$request \Zend_Controller_Request_Http Request to get the path info from
$partial
Returns
Type Description
arrayfalse An array of assigned values or a false on a mismatch
methodpublicsetMatchedPath( string $path ) : void

Set partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()
Parameters
Name Type Description
$path string
methodpublicsetRequest( \Zend_Controller_Request_Abstract|null $request = null ) : void

Set the request object for this and the child routes

Parameters
Name Type Description
$request \Zend_Controller_Request_Abstract|null
Documentation was generated by DocBlox 0.13.3.