Controller/Action/Interface.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Controller
0017  * @subpackage Zend_Controller_Action
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023 /**
0024  * @category   Zend
0025  * @package    Zend_Controller
0026  * @subpackage Zend_Controller_Action
0027  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0028  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0029  */
0030 interface Zend_Controller_Action_Interface
0031 {
0032     /**
0033      * Class constructor
0034      *
0035      * The request and response objects should be registered with the
0036      * controller, as should be any additional optional arguments; these will be
0037      * available via {@link getRequest()}, {@link getResponse()}, and
0038      * {@link getInvokeArgs()}, respectively.
0039      *
0040      * When overriding the constructor, please consider this usage as a best
0041      * practice and ensure that each is registered appropriately; the easiest
0042      * way to do so is to simply call parent::__construct($request, $response,
0043      * $invokeArgs).
0044      *
0045      * After the request, response, and invokeArgs are set, the
0046      * {@link $_helper helper broker} is initialized.
0047      *
0048      * Finally, {@link init()} is called as the final action of
0049      * instantiation, and may be safely overridden to perform initialization
0050      * tasks; as a general rule, override {@link init()} instead of the
0051      * constructor to customize an action controller's instantiation.
0052      *
0053      * @param Zend_Controller_Request_Abstract $request
0054      * @param Zend_Controller_Response_Abstract $response
0055      * @param array $invokeArgs Any additional invocation arguments
0056      * @return void
0057      */
0058     public function __construct(Zend_Controller_Request_Abstract $request,
0059                                 Zend_Controller_Response_Abstract $response,
0060                                 array $invokeArgs = array());
0061
0062     /**
0063      * Dispatch the requested action
0064      *
0065      * @param string $action Method name of action
0066      * @return void
0067      */
0068     public function dispatch($action);
0069 }