API Documentation

Zend/Controller/Action/Interface.php

Show: inherited
    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_Controller  
    Subpackage
    Zend_Controller_Action  
    Version
    $Id: Interface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Controller_Action_Interface

    Package: Zend\Controller\Zend\Controller\Action

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublic__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.

    Parameters
    Name Type Description
    $request \Zend_Controller_Request_Abstract
    $response \Zend_Controller_Response_Abstract
    $invokeArgs array

    Any additional invocation arguments

    methodpublicdispatch( string $action ) : void

    Dispatch the requested action

    Parameters
    Name Type Description
    $action string

    Method name of action

    Documentation was generated by DocBlox 0.15.1.