API Documentation

Zend/Controller/Router/Route/Chain.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Router_Route_Chain

Package: Zend\Controller\Router

Chain route is used for managing route chaining.

Parent(s)
\Zend_Controller_Router_Route_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_routes= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_separators= 'array()'
Default valuearray()Details
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::URI_DELIMITER ) : \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

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
array|false An array of assigned values or a false on a mismatch
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.15.1.