inc/classes/main/controller/class_BaseController.php

   1 <?php
   2 /**
   3  * A generic controller class. You should extend this base class if you want to
   4  * write your own controller. You get the advantage that you can use the pre and
   5  * post filters.
   6  *
   7  * @author              Roland Haeder <webmaster@ship-simu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.ship-simu.org
  12  *
  13  * This program is free software: you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation, either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  25  */
  26 class BaseController extends BaseFrameworkSystem implements Registerable {
  27         /**
  28          * Generic filter chains
  29          */
  30         private $filterChains = array();
  31
  32         // Exception constants
  33         const EXCEPTION_FILTER_CHAIN_INVALID = 0xf10;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  48
  49                 // Initialize both filter chains
  50                 $this->initFilterChain('pre');
  51                 $this->initFilterChain('post');
  52
  53                 // Add this controller to the registry
  54                 Registry::getRegistry()->addInstance('controller', $this);
  55         }
  56
  57         /**
  58          * Private method to initialize a given filter chain
  59          *
  60          * @param       $filterChain    Name of the filter chain
  61          * @return      void
  62          */
  63         protected function initFilterChain ($filterChain) {
  64                 $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
  65         }
  66
  67         /**
  68          * Adds a filter to a given filter group
  69          *
  70          * @param       $filterGroup    Group of the filter
  71          * @param       $filterInstance         An instance of a filter
  72          * @return      void
  73          * @throws      InvalidFilterChainException     If the filter chain is invalid
  74          */
  75         protected function addFilter ($filterGroup, Filterable $filterInstance) {
  76                 // Test if the filter is there
  77                 if (!isset($this->filterChains[$filterGroup])) {
  78                         // Throw an exception here
  79                         throw new InvalidFilterChainException(array($this, $filterGroup), self::EXCEPTION_FILTER_CHAIN_INVALID);
  80                 } // END - if
  81
  82                 // Add the filter
  83                 $this->filterChains[$filterGroup]->addFilter($filterInstance);
  84         }
  85
  86         /**
  87          * Adds a filter to the pre filter chain
  88          *
  89          * @param       $filterInstance         An instance of a filter
  90          * @return      void
  91          */
  92         public function addPreFilter (Filterable $filterInstance) {
  93                 // Add the pre filter
  94                 $this->addFilter('pre', $filterInstance);
  95         }
  96
  97         /**
  98          * Adds a filter to the post filter chain
  99          *
 100          * @param       $filterInstance         An instance of a filter
 101          * @return      void
 102          */
 103         public function addPostFilter (Filterable $filterInstance) {
 104                 // Add the post filter
 105                 $this->addFilter('post', $filterInstance);
 106         }
 107
 108         /**
 109          * Executes given filter chain group
 110          *
 111          * @param       $filterGroup    Group of the filter to execute
 112          * @param       $requestInstance        An instance of a request class
 113          * @param       $responseInstance       An instance of a response class
 114          * @return      void
 115          * @throws      InvalidFilterChainException     If the filter chain is invalid
 116          */
 117         protected function executeFilters ($filterGroup, Requestable $requestInstance, Responseable $responseInstance) {
 118                 // Test if the filter is there
 119                 if (!isset($this->filterChains[$filterGroup])) {
 120                         // Throw an exception here
 121                         throw new InvalidFilterChainException(array($this, $filterGroup), self::EXCEPTION_FILTER_CHAIN_INVALID);
 122                 } // END - if
 123
 124                 // Run all filters
 125                 $this->filterChains[$filterGroup]->processFilters($requestInstance, $responseInstance);
 126         }
 127
 128         /**
 129          * Executes all pre filters
 130          *
 131          * @param       $requestInstance        An instance of a request class
 132          * @param       $responseInstance       An instance of a response class
 133          * @return      void
 134          */
 135         protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
 136                 // Execute all pre filters
 137                 $this->executeFilters('pre', $requestInstance, $responseInstance);
 138         }
 139
 140         /**
 141          * Executes all post filters
 142          *
 143          * @param       $requestInstance        An instance of a request class
 144          * @param       $responseInstance       An instance of a response class
 145          * @return      void
 146          */
 147         protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
 148                 // Execute all post filters
 149                 $this->executeFilters('post', $requestInstance, $responseInstance);
 150         }
 151 }
 152
 153 // [EOF]
 154 ?>