<?php

/**

 * 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

 * @package    Zend_Controller

 * @subpackage Zend_Controller_Action

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @category   Zend

 * @package    Zend_Controller

 * @subpackage Zend_Controller_Action

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

interface Zend_Controller_Action_Interface

{

    /**

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

     *

     * @param Zend_Controller_Request_Abstract $request

     * @param Zend_Controller_Response_Abstract $response

     * @param array $invokeArgs Any additional invocation arguments

     * @return void

     */

    public function __construct(Zend_Controller_Request_Abstract $request,

                                Zend_Controller_Response_Abstract $response,

                                array $invokeArgs = array());

    /**

     * Dispatch the requested action

     *

     * @param string $action Method name of action

     * @return void

     */

    public function dispatch($action);

}