Rest/Route.php

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_Rest
version: $Id: Route.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Rest_Route

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

Extends from: Zend_Controller_Router_Route_Module
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_Rest
Properties: $_restfulModules; $_restfulControllers; $_front
Methods: __construct; getInstance; match; assemble; getVersion; _parseResponders; _checkRestfulModule; _checkRestfulController; _allRestful; _fullRestfulModule

Description

Rest Route

Request-aware route for RESTful modular routing

Properties

$_front
jump to class

Zend_Controller_Front $_front = ''

Details

$_front: Zend_Controller_Front
visibility: protected
default
final: false
static: false

$_restfulControllers
jump to class

array $_restfulControllers = 'null'

Specific Modules=>Controllers to receive RESTful routes

Details

$_restfulControllers: array
visibility: protected
default: null
final: false
static: false

$_restfulModules
jump to class

array $_restfulModules = 'null'

Specific Modules to receive RESTful routes

Details

$_restfulModules: array
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          Zend_Controller_Front $front, array $defaults
              =
              array, array $responders
              =
              array
          )
        
        :

Constructor

Arguments

$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

Details

visibility: public
final: false
static: false

_allRestful
jump to class

_allRestful(
          
          )
        
        :
        bool

Determines if RESTful routing applies to the entire app

Output

bool

Details

visibility: protected
final: false
static: false

_checkRestfulController
jump to class

_checkRestfulController(
          string $moduleName, string $controllerName
          )
        
        :
        bool

Determine if a specified module + controller combination supports RESTful routing

Arguments

$moduleName: string
$controllerName: string

Output

bool

Details

visibility: protected
final: false
static: false

_checkRestfulModule
jump to class

_checkRestfulModule(
          string $moduleName
          )
        
        :
        bool

Determine if a specified module supports RESTful routing

Arguments

$moduleName: string

Output

bool

Details

visibility: protected
final: false
static: false

_fullRestfulModule
jump to class

_fullRestfulModule(
          string $moduleName
          )
        
        :
        bool

Determines if RESTful routing applies to an entire module

Arguments

$moduleName: string

Output

bool

Details

visibility: protected
final: false
static: false

_parseResponders
jump to class

_parseResponders(
          array $responders
          )
        
        :

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

Arguments

$responders: array

Details

visibility: protected
final: false
static: false

assemble
jump to class

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

Assembles user submitted parameters forming a URL path defined by this route

Arguments

$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

Output

string: Route path with user submitted parameters

Details

visibility: public
final: false
static: false

getInstance
jump to class

getInstance(
           $config
          )
        
        :

Instantiates route based on passed Zend_Config structure

Arguments

$config

Details

visibility: public
final: false
static: true

getVersion
jump to class

getVersion(
          
          )
        
        :
        int

Tells Rewrite Router which version this Route is

Output

int: Route "version"

Details

visibility: public
final: false
static: false

match
jump to class

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

Arguments

$request: Zend_Controller_Request_Http
Request used to match against this routing ruleset
$partial

Output

array: An array of assigned values or a false on a mismatch

Details

visibility: public
final: false
static: false

API Documentation

Rest/Route.php

Description

Zend_Rest_Routejump to top

Description

Properties

$_frontjump to class

Details

$_restfulControllersjump to class

Details

$_restfulModulesjump to class

Details

Methods

__constructjump to class

Arguments

Details

_allRestfuljump to class

Output

Details

_checkRestfulControllerjump to class

Arguments

Output

Details

_checkRestfulModulejump to class

Arguments

Output

Details

_fullRestfulModulejump to class

Arguments

Output

Details

_parseRespondersjump to class

Arguments

Details

assemblejump to class

Arguments

Output

Details

getInstancejump to class

Arguments

Details

getVersionjump to class

Output

Details

matchjump to class

Arguments

Output

Details

Zend_Rest_Route
jump to top

$_front
jump to class

$_restfulControllers
jump to class

$_restfulModules
jump to class

__construct
jump to class

_allRestful
jump to class

_checkRestfulController
jump to class

_checkRestfulModule
jump to class

_fullRestfulModule
jump to class

_parseResponders
jump to class

assemble
jump to class

getInstance
jump to class

getVersion
jump to class

match
jump to class