Controller/Router/Route/Chain.php

Show:

inherited

Classes
- \Zend_Controller_Router_Route_Chain

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
jump to top

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

 
                URI_DELIMITER
                = '/'

inherited

URI delimiter

Inherited from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Inherited_from: \Zend_Controller_Router_Route_Abstract::URI_DELIMITER

Properties

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

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

$_routes = array()

Default valuearray()Details

Type: n/a

$_separators = array()

Default valuearray()Details

Type: n/a

Methods

assemble(array $data = array(), bool $reset = false, bool $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	bool
$encode	bool

Returns

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

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) : \Zend_Controller_Router_Route_Chain

static

Instantiates route based on passed Zend_Config structure

Parameters

Name	Type	Description
$config	\Zend_Config	Configuration object

Returns

Type	Description
\Zend_Controller_Router_Route_Chain

getMatchedPath() : string

inherited

Get partially matched path

Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()

Returns

Type	Description
string

getVersion() : integer

inherited

Get the version of the route

Inherited from: \Zend_Controller_Router_Route_Abstract::getVersion()

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

Name	Type	Description
$request	\Zend_Controller_Request_Http	Request to get the path info from
$partial	null

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

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

Controller/Router/Route/Chain.php

\Zend_Controller_Router_Route_Chainjump to top

Constants

Properties

Methods

\Zend_Controller_Router_Route_Chain
jump to top