API Documentation

Controller/Router/Route/Chain.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Router
version
$Id: Chain.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Controller_Router_Route_Chain

Description

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.

Zend_Controller_Router_Route_Chain
jump to top

Extends from
Zend_Controller_Router_Route_Abstract
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Router
Properties
$_routes
$_separators
Methods
getInstance
chain
match
assemble
setRequest

Description

Chain route is used for managing route chaining.

Properties

$_routes
jump to class

 $_routes = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_separators
jump to class

 $_separators = 'array'

Details

visibility
protected
default
array
final
false
static
false

Methods

assemble
jump to class

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

Assembles a URL path defined by this route

Arguments
$data
array
An array of variable and value pairs used as parameters
$reset
$encode
Output
string
Route path with user submitted parameters
Details
visibility
public
final
false
static
false

chain
jump to class

chain( Zend_Controller_Router_Route_Abstract $route, string $separator = / ) : Zend_Controller_Router_Route_Chain

Add a route to this chain

Arguments
$route
Zend_Controller_Router_Route_Abstract
$separator
string
Output
Zend_Controller_Router_Route_Chain
Details
visibility
public
final
false
static
false

getInstance
jump to class

getInstance( Zend_Config $config ) :

Instantiates route based on passed Zend_Config structure

Arguments
$config
Zend_Config
Configuration object
Details
visibility
public
final
false
static
true

match
jump to class

match( 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.

Arguments
$request
Zend_Controller_Request_Http
Request to get the path info from
$partial
Output
array|false
An array of assigned values or a false on a mismatch
Details
visibility
public
final
false
static
false

setRequest
jump to class

setRequest( Zend_Controller_Request_Abstract|null $request = null ) : void

Set the request object for this and the child routes

Arguments
$request
Zend_Controller_Request_Abstractnull
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.