API Documentation

Rest/Route.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_Rest  
version
$Id: Route.php 24013 2011-05-04 21:19:12Z ralph $  

\Zend_Rest_Route

Rest Route

Request-aware route for RESTful modular routing

Extends from
\Zend_Controller_Router_Route_Module
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Rest  

Properties

Propertyprotected\Zend_Controller_Front  $_front= ''

Details
Type
\Zend_Controller_Front
Propertyprotectedarray  $_restfulControllers= 'null'

Specific Modules=>Controllers to receive RESTful routes

Default valuenullDetails
Type
array
Propertyprotectedarray  $_restfulModules= 'null'

Specific Modules to receive RESTful routes

Default valuenullDetails
Type
array

Methods

methodpublic__construct( \Zend_Controller_Front $front, array $defaults = array, array $responders = array ) : void

Constructor

Parameters
Name Type Description
$front \Zend_Controller_Front Front Controller object
$defaults array Defaults for map variables with keys as variable names
$responders array Modules or controllers to receive RESTful routes
methodprotected_allRestful( ) : bool

Determines if RESTful routing applies to the entire app

Returns
Type Description
bool
methodprotected_checkRestfulController( string $moduleName, string $controllerName ) : bool

Determine if a specified module + controller combination supports RESTful routing

Parameters
Name Type Description
$moduleName string
$controllerName string
Returns
Type Description
bool
methodprotected_checkRestfulModule( string $moduleName ) : bool

Determine if a specified module supports RESTful routing

Parameters
Name Type Description
$moduleName string
Returns
Type Description
bool
methodprotected_fullRestfulModule( string $moduleName ) : bool

Determines if RESTful routing applies to an entire module

Parameters
Name Type Description
$moduleName string
Returns
Type Description
bool
methodprotected_parseResponders( array $responders ) : void

Parses the responders array sent to constructor to know which modules and/or controllers are RESTful

Parameters
Name Type Description
$responders array
methodprotected_setRequestKeys( ) : void

Set request keys based on values in request object

Inherited from: \Zend_Controller_Router_Route_Module::_setRequestKeys()
methodpublicassemble( array $data = array, bool $reset = false, bool $encode = true ) : string

Assembles user submitted parameters forming 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 Weither to reset the current params
$encode bool Weither to return urlencoded string
Returns
Type Description
string Route path with user submitted parameters
methodpublicchain( \Zend_Controller_Router_Route_Abstract $route, string $separator = / ) : \Zend_Controller_Router_Route_Chain

Create a new chain

Inherited from: \Zend_Controller_Router_Route_Abstract::chain()
Parameters
Name Type Description
$route \Zend_Controller_Router_Route_Abstract
$separator string
Returns
Type Description
\Zend_Controller_Router_Route_Chain
methodpublicgetDefault( string $name ) : string

Return a single parameter of route's defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefault()
Parameters
Name Type Description
$name string Array key of the parameter
Returns
Type Description
string Previously set default
methodpublicgetDefaults( ) : array

Return an array of defaults

Inherited from: \Zend_Controller_Router_Route_Module::getDefaults()
Returns
Type Description
array Route defaults
methodpublicgetInstance(  $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config
methodpublicgetMatchedPath( ) : string

Get partially matched path

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

Tells Rewrite Router which version this Route is

Returns
Type Description
int Route "version"
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 = false ) : array

Matches a user submitted request. Assigns and returns an array of variables on a successful match.

If a request object is registered, it uses its setModuleName(), setControllerName(), and setActionName() accessors to set those values. Always returns the values as an array.

Parameters
Name Type Description
$request \Zend_Controller_Request_Http Request used to match against this routing ruleset
$partial
Returns
Type Description
array 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
Documentation was generated by DocBlox 0.13.3.