1 <?php

     2 /**

     3  * Zend Framework

     4  *

     5  * LICENSE

     6  *

     7  * This source file is subject to the new BSD license that is bundled

     8  * with this package in the file LICENSE.txt.

     9  * It is also available through the world-wide-web at this URL:

    10  * http://framework.zend.com/license/new-bsd

    11  * If you did not receive a copy of the license and are unable to

    12  * obtain it through the world-wide-web, please send an email

    13  * to license@zend.com so we can send you a copy immediately.

    14  *

    15  * @category   Zend

    16  * @package    Zend_Controller

    17  * @subpackage Plugins

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

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

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

    21  */

    22 

    23 /**

    24  * @category   Zend

    25  * @package    Zend_Controller

    26  * @subpackage Plugins

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

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

    29  */

    30 abstract class Zend_Controller_Plugin_Abstract

    31 {

    32     /**

    33      * @var Zend_Controller_Request_Abstract

    34      */

    35     protected $_request;

    36 

    37     /**

    38      * @var Zend_Controller_Response_Abstract

    39      */

    40     protected $_response;

    41 

    42     /**

    43      * Set request object

    44      *

    45      * @param Zend_Controller_Request_Abstract $request

    46      * @return Zend_Controller_Plugin_Abstract

    47      */

    48     public function setRequest(Zend_Controller_Request_Abstract $request)

    49     {

    50         $this->_request = $request;

    51         return $this;

    52     }

    53 

    54     /**

    55      * Get request object

    56      *

    57      * @return Zend_Controller_Request_Abstract $request

    58      */

    59     public function getRequest()

    60     {

    61         return $this->_request;

    62     }

    63 

    64     /**

    65      * Set response object

    66      *

    67      * @param Zend_Controller_Response_Abstract $response

    68      * @return Zend_Controller_Plugin_Abstract

    69      */

    70     public function setResponse(Zend_Controller_Response_Abstract $response)

    71     {

    72         $this->_response = $response;

    73         return $this;

    74     }

    75 

    76     /**

    77      * Get response object

    78      *

    79      * @return Zend_Controller_Response_Abstract $response

    80      */

    81     public function getResponse()

    82     {

    83         return $this->_response;

    84     }

    85 

    86     /**

    87      * Called before Zend_Controller_Front begins evaluating the

    88      * request against its routes.

    89      *

    90      * @param Zend_Controller_Request_Abstract $request

    91      * @return void

    92      */

    93     public function routeStartup(Zend_Controller_Request_Abstract $request)

    94     {}

    95 

    96     /**

    97      * Called after Zend_Controller_Router exits.

    98      *

    99      * Called after Zend_Controller_Front exits from the router.

   100      *

   101      * @param  Zend_Controller_Request_Abstract $request

   102      * @return void

   103      */

   104     public function routeShutdown(Zend_Controller_Request_Abstract $request)

   105     {}

   106 

   107     /**

   108      * Called before Zend_Controller_Front enters its dispatch loop.

   109      *

   110      * @param  Zend_Controller_Request_Abstract $request

   111      * @return void

   112      */

   113     public function dispatchLoopStartup(Zend_Controller_Request_Abstract $request)

   114     {}

   115 

   116     /**

   117      * Called before an action is dispatched by Zend_Controller_Dispatcher.

   118      *

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

   120      * request and resetting its dispatched flag (via

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

   122      * the current action may be skipped.

   123      *

   124      * @param  Zend_Controller_Request_Abstract $request

   125      * @return void

   126      */

   127     public function preDispatch(Zend_Controller_Request_Abstract $request)

   128     {}

   129 

   130     /**

   131      * Called after an action is dispatched by Zend_Controller_Dispatcher.

   132      *

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

   134      * request and resetting its dispatched flag (via

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

   136      * a new action may be specified for dispatching.

   137      *

   138      * @param  Zend_Controller_Request_Abstract $request

   139      * @return void

   140      */

   141     public function postDispatch(Zend_Controller_Request_Abstract $request)

   142     {}

   143 

   144     /**

   145      * Called before Zend_Controller_Front exits its dispatch loop.

   146      *

   147      * @return void

   148      */

   149     public function dispatchLoopShutdown()

   150     {}

   151 }