RouterController.php

   1 <?php
   2 /*=====================================================================*
   3 || ###################################################################
   4 || # Blue Static ISSO Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Router Controller (RouterController.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 /**
  29 * Router Controller
  30 *
  31 * This is an abstract class used to dispatch responces from the Router.
  32 *
  33 * @author               Blue Static
  34 * @copyright    Copyright (c)2002 - [#]year[#], Blue Static
  35 * @version              $Revision$
  36 * @package              ISSO
  37 *
  38 */
  39 abstract class BSRouterController
  40 {
  41         /**
  42         * The input variables parsed from the URL string and $_POST
  43         * @var array
  44         */
  45         protected $params;
  46
  47         // ###################################################################
  48         /**
  49         * Constructor
  50         */
  51         public function __construct(BSInput $params)
  52         {
  53                 $this->params = $params;
  54         }
  55
  56         // ###################################################################
  57         /**
  58         * Does nothing if the request was sent via POST, and triggers an
  59         * error if it was not
  60         */
  61         protected function _verifyPostRequest()
  62         {
  63                 if ($this->params->getHttpMethod() != 'post')
  64                 {
  65                         trigger_error('Action is intended to be executed from a POST request');
  66                 }
  67         }
  68
  69         /**
  70         * The default action (index)
  71         */
  72         public abstract function Index();
  73 }
  74
  75 /*=====================================================================*
  76 || ###################################################################
  77 || # $HeadURL$
  78 || # $Id$
  79 || ###################################################################
  80 \*=====================================================================*/
  81 ?>