Rest/Controller.php

Show: PublicProtectedPrivateinherited
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_Rest  
Version
$Id: Controller.php 25024 2012-07-30 15:08:15Z rob $  

\Zend_Rest_Controller

Package: Zend\Rest
An abstract class to guide implementation of action controllers for use with Zend_Rest_Route.
Parent(s)
\Zend_Controller_Action
See
\global\Zend_Rest_Route  
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedarray $_classMethods
inherited

of existing class methods

Inherited from: \Zend_Controller_Action::$$_classMethods
Details
Type
array
Inherited_from
\Zend_Controller_Action::$$_classMethods  
>VPropertyprotectedarray $_delimiters
inherited
Word delimiters (used for normalizing view script paths)
Inherited from: \Zend_Controller_Action::$$_delimiters
Details
Type
array
Inherited_from
\Zend_Controller_Action::$$_delimiters  
>VPropertyprotected\Zend_Controller_Front $_frontController
inherited
Front controller instance
Inherited from: \Zend_Controller_Action::$$_frontController
>VPropertyprotected\Zend_Controller_Action_HelperBroker $_helper = null
inherited
Helper Broker to assist in routing help requests to the proper object
Inherited from: \Zend_Controller_Action::$$_helper
>VPropertyprotectedarray $_invokeArgs = array()
inherited
Array of arguments provided to the constructor, minus the {@link $_request Request object}.
Inherited from: \Zend_Controller_Action::$$_invokeArgs
Default valuearray()Details
Type
array
Inherited_from
\Zend_Controller_Action::$$_invokeArgs  
>VPropertyprotected\Zend_Controller_Request_Abstract $_request = null
inherited
Zend_Controller_Request_Abstract object wrapping the request environment
Inherited from: \Zend_Controller_Action::$$_request
Default valuenullDetails
Type
\Zend_Controller_Request_Abstract
Inherited_from
\Zend_Controller_Action::$$_request  
>VPropertyprotected\Zend_Controller_Response_Abstract $_response = null
inherited
Zend_Controller_Response_Abstract object wrapping the response
Inherited from: \Zend_Controller_Action::$$_response
>VPropertypublic\Zend_View_Interface $view
inherited
View object
Inherited from: \Zend_Controller_Action::$$view
>VPropertypublicstring $viewSuffix = 'phtml'
inherited
View script suffix; defaults to 'phtml'
Inherited from: \Zend_Controller_Action::$$viewSuffix
Default value'phtml'Details
Type
string
Inherited_from
\Zend_Controller_Action::$$viewSuffix  
See
\{render()}  

Methods

methodpublic__call(string $methodName, array $args) : void
inherited

Proxy for undefined methods.

Inherited from: \Zend_Controller_Action::__call()

Default behavior is to throw an exception on undefined methods, however this function can be overridden to implement magic (dynamic) actions, or provide run-time dispatching.

Parameters
NameTypeDescription
$methodNamestring
$argsarray
Throws
ExceptionDescription
\Zend_Controller_Action_Exception
methodpublic__construct(\Zend_Controller_Request_Abstract $request, \Zend_Controller_Response_Abstract $response, array $invokeArgs = array()) : void
inherited

Class constructor

Inherited from: \Zend_Controller_Action::__construct()

The request and response objects should be registered with the controller, as should be any additional optional arguments; these will be available via getRequest(), getResponse(), and getInvokeArgs(), respectively.

When overriding the constructor, please consider this usage as a best practice and ensure that each is registered appropriately; the easiest way to do so is to simply call parent::__construct($request, $response, $invokeArgs).

After the request, response, and invokeArgs are set, the helper broker is initialized.

Finally, init() is called as the final action of instantiation, and may be safely overridden to perform initialization tasks; as a general rule, override init() instead of the constructor to customize an action controller's instantiation.

Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
$response\Zend_Controller_Response_Abstract
$invokeArgsarray

Any additional invocation arguments

methodprotected_forward(string $action, string $controller = null, string $module = null, array $params = null) : void
finalinherited

Forward to another controller/action.

Inherited from: \Zend_Controller_Action::_forward()

It is important to supply the unformatted names, i.e. "article" rather than "ArticleController". The dispatcher will do the appropriate formatting when the request is received.

If only an action name is provided, forwards to that action in this controller.

If an action and controller are specified, forwards to that action and controller in this module.

Specifying an action, controller, and module is the most specific way to forward.

A fourth argument, $params, will be used to set the request parameters. If either the controller or module are unnecessary for forwarding, simply pass null values for them before specifying the parameters.

Parameters
NameTypeDescription
$actionstring
$controllerstring
$modulestring
$paramsarray
methodprotected_getAllParams() : array
inherited

Return all parameters in the {@link $_request Request object} as an associative array.

Inherited from: \Zend_Controller_Action::_getAllParams()
Returns
TypeDescription
array
methodprotected_getParam(string $paramName, mixed $default = null) : mixed
inherited

Gets a parameter from the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::_getParam()

If the parameter does not exist, NULL will be returned.

If the parameter does not exist and $default is set, then $default will be returned instead of NULL.

Parameters
NameTypeDescription
$paramNamestring
$defaultmixed
Returns
TypeDescription
mixed
methodprotected_hasParam(string $paramName) : boolean
inherited

Determine whether a given parameter exists in the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::_hasParam()
Parameters
NameTypeDescription
$paramNamestring
Returns
TypeDescription
boolean
methodprotected_redirect(string $url, array $options = array()) : void
inherited

Redirect to another URL

Inherited from: \Zend_Controller_Action::_redirect()
Parameters
NameTypeDescription
$urlstring
$optionsarray

Options to be used when redirecting

methodprotected_setInvokeArgs(array $args = array()) : \Zend_Controller_Action
inherited

Set invocation arguments

Inherited from: \Zend_Controller_Action::_setInvokeArgs()
Parameters
NameTypeDescription
$argsarray
Returns
TypeDescription
\Zend_Controller_Action
methodprotected_setParam(string $paramName, mixed $value) : \Zend_Controller_Action
inherited

Set a parameter in the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::_setParam()
Parameters
NameTypeDescription
$paramNamestring
$valuemixed
Returns
TypeDescription
\Zend_Controller_Action
methodpublicdeleteAction() : void
abstract

The delete action handles DELETE requests and receives an 'id' parameter; it should update the server resource state of the resource identified by the 'id' value.

methodpublicdispatch(string $action) : void
inherited

Dispatch the requested action

Inherited from: \Zend_Controller_Action::dispatch()
Parameters
NameTypeDescription
$actionstring

Method name of action

methodpublicforward(string $action, string $controller = null, string $module = null, array $params = null) : void
finalinherited

Forward to another controller/action.

Inherited from: \Zend_Controller_Action::forward()

It is important to supply the unformatted names, i.e. "article" rather than "ArticleController". The dispatcher will do the appropriate formatting when the request is received.

If only an action name is provided, forwards to that action in this controller.

If an action and controller are specified, forwards to that action and controller in this module.

Specifying an action, controller, and module is the most specific way to forward.

A fourth argument, $params, will be used to set the request parameters. If either the controller or module are unnecessary for forwarding, simply pass null values for them before specifying the parameters.

Parameters
NameTypeDescription
$actionstring
$controllerstring
$modulestring
$paramsarray
methodpublicgetAction() : void
abstract

The get action handles GET requests and receives an 'id' parameter; it should respond with the server resource state of the resource identified by the 'id' value.

methodpublicgetAllParams() : array
inherited

Return all parameters in the {@link $_request Request object} as an associative array.

Inherited from: \Zend_Controller_Action::getAllParams()
Returns
TypeDescription
array
methodpublicgetFrontController() : \Zend_Controller_Front
inherited

Retrieve Front Controller

Inherited from: \Zend_Controller_Action::getFrontController()
Returns
TypeDescription
\Zend_Controller_Front
methodpublicgetHelper(string $helperName) : \Zend_Controller_Action_Helper_Abstract
inherited

Get a helper by name

Inherited from: \Zend_Controller_Action::getHelper()
Parameters
NameTypeDescription
$helperNamestring
Returns
TypeDescription
\Zend_Controller_Action_Helper_Abstract
methodpublicgetHelperCopy(string $helperName) : \Zend_Controller_Action_Helper_Abstract
inherited

Get a clone of a helper by name

Inherited from: \Zend_Controller_Action::getHelperCopy()
Parameters
NameTypeDescription
$helperNamestring
Returns
TypeDescription
\Zend_Controller_Action_Helper_Abstract
methodpublicgetInvokeArg(string $key) : mixed
inherited

Return a single invocation argument

Inherited from: \Zend_Controller_Action::getInvokeArg()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetInvokeArgs() : array
inherited

Return the array of constructor arguments (minus the Request object)

Inherited from: \Zend_Controller_Action::getInvokeArgs()
Returns
TypeDescription
array
methodpublicgetParam(string $paramName, mixed $default = null) : mixed
inherited

Gets a parameter from the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::getParam()

If the parameter does not exist, NULL will be returned.

If the parameter does not exist and $default is set, then $default will be returned instead of NULL.

Parameters
NameTypeDescription
$paramNamestring
$defaultmixed
Returns
TypeDescription
mixed
methodpublicgetRequest() : \Zend_Controller_Request_Abstract
inherited

Return the Request object

Inherited from: \Zend_Controller_Action::getRequest()
Returns
TypeDescription
\Zend_Controller_Request_Abstract
methodpublicgetResponse() : \Zend_Controller_Response_Abstract
inherited

Return the Response object

Inherited from: \Zend_Controller_Action::getResponse()
methodpublicgetViewScript(string $action = null, bool $noController = null) : string
inherited

Construct view script path

Inherited from: \Zend_Controller_Action::getViewScript()

Used by render() to determine the path to the view script.

Parameters
NameTypeDescription
$actionstring

Defaults to action registered in request object

$noControllerbool

Defaults to false; i.e. use controller name as subdir in which to search for view script

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Controller_Exceptionwith bad $action
methodpublichasParam(string $paramName) : boolean
inherited

Determine whether a given parameter exists in the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::hasParam()
Parameters
NameTypeDescription
$paramNamestring
Returns
TypeDescription
boolean
methodpublicheadAction() : void
abstract

The head action handles HEAD requests and receives an 'id' parameter; it should respond with the server resource state of the resource identified by the 'id' value.

methodpublicindexAction() : void
abstract

The index action handles index/list requests; it should respond with a list of the requested resources.

methodpublicinit() : void
inherited

Initialize object

Inherited from: \Zend_Controller_Action::init()

Called from __construct() as final step of object instantiation.

methodpublicinitView() : \Zend_View_Interface
inherited

Initialize View object

Inherited from: \Zend_Controller_Action::initView()

Initializes $view if not otherwise a Zend_View_Interface.

If $view is not otherwise set, instantiates a new Zend_View object, using the 'views' subdirectory at the same level as the controller directory for the current module as the base directory. It uses this to set the following: - script path = views/scripts/ - helper path = views/helpers/ - filter path = views/filters/

Returns
TypeDescription
\Zend_View_Interface
Throws
ExceptionDescription
\Zend_Controller_Exceptionif base view directory does not exist
methodpublicpostAction() : void
abstract

The post action handles POST requests; it should accept and digest a POSTed resource representation and persist the resource state.

methodpublicpostDispatch() : void
inherited

Post-dispatch routines

Inherited from: \Zend_Controller_Action::postDispatch()

Called after action method execution. If using class with Zend_Controller_Front, it may modify the Request object and reset its dispatched flag in order to process an additional action.

Common usages for postDispatch() include rendering content in a sitewide template, link url correction, setting headers, etc.

methodpublicpreDispatch() : void
inherited

Pre-dispatch routines

Inherited from: \Zend_Controller_Action::preDispatch()

Called before action method. If using class with Zend_Controller_Front, it may modify the Request object and reset its dispatched flag in order to skip processing the current action.

methodpublicputAction() : void
abstract

The put action handles PUT requests and receives an 'id' parameter; it should update the server resource state of the resource identified by the 'id' value.

methodpublicredirect(string $url, array $options = array()) : void
inherited

Redirect to another URL

Inherited from: \Zend_Controller_Action::redirect()
Parameters
NameTypeDescription
$urlstring
$optionsarray

Options to be used when redirecting

methodpublicrender(string | null $action = null, string | null $name = null, bool $noController = false) : void
inherited

Render a view

Inherited from: \Zend_Controller_Action::render()

Renders a view. By default, views are found in the view script path as /.phtml. You may change the script suffix by resetting $viewSuffix. You may omit the controller directory prefix by specifying boolean true for $noController.

By default, the rendered contents are appended to the response. You may specify the named body content segment to set by specifying a $name.

Parameters
NameTypeDescription
$actionstring | null

Defaults to action registered in request object

$namestring | null

Response object named path segment to use; defaults to null

$noControllerbool

Defaults to false; i.e. use controller name as subdir in which to search for view script

Details
See
\Zend_Controller_Response_Abstract::appendBody()  
methodpublicrenderScript(string $script, string $name = null) : void
inherited

Render a given view script

Inherited from: \Zend_Controller_Action::renderScript()

Similar to render(), this method renders a view script. Unlike render(), however, it does not autodetermine the view script via getViewScript(), but instead renders the script passed to it. Use this if you know the exact view script name and path you wish to use, or if using paths that do not conform to the spec defined with getViewScript().

By default, the rendered contents are appended to the response. You may specify the named body content segment to set by specifying a $name.

Parameters
NameTypeDescription
$scriptstring
$namestring
methodpublicrun(null | \Zend_Controller_Request_Abstract $request = null, null | \Zend_Controller_Response_Abstract $response = null) : \Zend_Controller_Response_Abstract
inherited

Call the action specified in the request object, and return a response

Inherited from: \Zend_Controller_Action::run()

Not used in the Action Controller implementation, but left for usage in Page Controller implementations. Dispatches a method based on the request.

Returns a Zend_Controller_Response_Abstract object, instantiating one prior to execution if none exists in the controller.

preDispatch() is called prior to the action, postDispatch() is called following it.

Parameters
NameTypeDescription
$requestnull | \Zend_Controller_Request_Abstract

Optional request object to use

$responsenull | \Zend_Controller_Response_Abstract

Optional response object to use

Returns
TypeDescription
\Zend_Controller_Response_Abstract
methodpublicsetFrontController(\Zend_Controller_Front $front) : \Zend_Controller_Action
inherited

Set the front controller instance

Inherited from: \Zend_Controller_Action::setFrontController()
Parameters
NameTypeDescription
$front\Zend_Controller_Front
Returns
TypeDescription
\Zend_Controller_Action
methodpublicsetParam(string $paramName, mixed $value) : \Zend_Controller_Action
inherited

Set a parameter in the {@link $_request Request object}.

Inherited from: \Zend_Controller_Action::setParam()
Parameters
NameTypeDescription
$paramNamestring
$valuemixed
Returns
TypeDescription
\Zend_Controller_Action
methodpublicsetRequest(\Zend_Controller_Request_Abstract $request) : \Zend_Controller_Action
inherited

Set the Request object

Inherited from: \Zend_Controller_Action::setRequest()
Parameters
NameTypeDescription
$request\Zend_Controller_Request_Abstract
Returns
TypeDescription
\Zend_Controller_Action
methodpublicsetResponse(\Zend_Controller_Response_Abstract $response) : \Zend_Controller_Action
inherited

Set the Response object

Inherited from: \Zend_Controller_Action::setResponse()
Parameters
NameTypeDescription
$response\Zend_Controller_Response_Abstract
Returns
TypeDescription
\Zend_Controller_Action
Documentation was generated by phpDocumentor 2.0.0a12.