http/action.php

   1 <?php
   2 // Hoplite
   3 // Copyright (c) 2011 Blue Static
   4 //
   5 // This program is free software: you can redistribute it and/or modify it
   6 // under the terms of the GNU General Public License as published by the Free
   7 // Software Foundation, either version 3 of the License, or any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful, but WITHOUT
  10 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 // more details.
  13 //
  14 // You should have received a copy of the GNU General Public License along with
  15 // this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 namespace hoplite\http;
  18
  19 /*!
  20   This abstract class is the base for handling all requests and filling out
  21   response objects.
  22 */
  23 abstract class Action
  24 {
  25   /*! \var FrontController */
  26   private $controller;
  27
  28   /*!
  29     Creates a new action with a reference to the FrontController.
  30     @param FrontController
  31   */
  32   public function __construct($controller)
  33   {
  34     $this->controller = $controller;
  35   }
  36
  37   /*! Accesses the FrontController */
  38   public function controller() { return $this->controller; }
  39
  40   /*!
  41     Performs the action and fills out the response's data model.
  42   */
  43   public abstract function Invoke(Request $request, Response $response);
  44 }