<?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 Plugins

 * @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: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @category   Zend

 * @package    Zend_Controller

 * @subpackage Plugins

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

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

 */

abstract class Zend_Controller_Plugin_Abstract

{

    /**

     * @var Zend_Controller_Request_Abstract

     */

    protected $_request;

    /**

     * @var Zend_Controller_Response_Abstract

     */

    protected $_response;

    /**

     * Set request object

     *

     * @param Zend_Controller_Request_Abstract $request

     * @return Zend_Controller_Plugin_Abstract

     */

    public function setRequest(Zend_Controller_Request_Abstract $request)

    {

        $this->_request = $request;

        return $this;

    }

    /**

     * Get request object

     *

     * @return Zend_Controller_Request_Abstract $request

     */

    public function getRequest()

    {

        return $this->_request;

    }

    /**

     * Set response object

     *

     * @param Zend_Controller_Response_Abstract $response

     * @return Zend_Controller_Plugin_Abstract

     */

    public function setResponse(Zend_Controller_Response_Abstract $response)

    {

        $this->_response = $response;

        return $this;

    }

    /**

     * Get response object

     *

     * @return Zend_Controller_Response_Abstract $response

     */

    public function getResponse()

    {

        return $this->_response;

    }

    /**

     * Called before Zend_Controller_Front begins evaluating the

     * request against its routes.

     *

     * @param Zend_Controller_Request_Abstract $request

     * @return void

     */

    public function routeStartup(Zend_Controller_Request_Abstract $request)

    {}

    /**

     * Called after Zend_Controller_Router exits.

     *

     * Called after Zend_Controller_Front exits from the router.

     *

     * @param  Zend_Controller_Request_Abstract $request

     * @return void

     */

    public function routeShutdown(Zend_Controller_Request_Abstract $request)

    {}

    /**

     * Called before Zend_Controller_Front enters its dispatch loop.

     *

     * @param  Zend_Controller_Request_Abstract $request

     * @return void

     */

    public function dispatchLoopStartup(Zend_Controller_Request_Abstract $request)

    {}

    /**

     * Called before an action is dispatched by Zend_Controller_Dispatcher.

     *

     * This callback allows for proxy or filter behavior.  By altering the

     * request and resetting its dispatched flag (via

     * {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}),

     * the current action may be skipped.

     *

     * @param  Zend_Controller_Request_Abstract $request

     * @return void

     */

    public function preDispatch(Zend_Controller_Request_Abstract $request)

    {}

    /**

     * Called after an action is dispatched by Zend_Controller_Dispatcher.

     *

     * This callback allows for proxy or filter behavior. By altering the

     * request and resetting its dispatched flag (via

     * {@link Zend_Controller_Request_Abstract::setDispatched() setDispatched(false)}),

     * a new action may be specified for dispatching.

     *

     * @param  Zend_Controller_Request_Abstract $request

     * @return void

     */

    public function postDispatch(Zend_Controller_Request_Abstract $request)

    {}

    /**

     * Called before Zend_Controller_Front exits its dispatch loop.

     *

     * @return void

     */

    public function dispatchLoopShutdown()

    {}

}