API Documentation

Controller/Action/Interface.php

Interfaces
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
Zend_Controller_Action
version
$Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Controller_Action_Interface

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_Action_Interface

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
Zend_Controller_Action
Methods
__construct
dispatch

Description

Methods

__construct

__construct( Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, array $invokeArgs = array ) : void

Class constructor

The request and response objects should be registered with the controller, as should be any additional optional arguments; these will be available via {@link getRequest()}, {@link getResponse()}, and {@link 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 {@link $_helper helper broker} is initialized.

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

Arguments
$request
Zend_Controller_Request_Abstract
$response
Zend_Controller_Response_Abstract
$invokeArgs
array
Any additional invocation arguments
Details
visibility
public
final
false
static
false

dispatch

dispatch( string $action ) : void

Dispatch the requested action

Arguments
$action
string
Method name of action
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.