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 - 2011 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                 // Initialize both filter chains
  46                 $this->initFilterChain('pre');
  47                 $this->initFilterChain('post');
  48
  49                 // Add this controller to the registry
  50                 Registry::getRegistry()->addInstance('controller', $this);
  51         }
  52
  53         /**
  54          * Private method to initialize a given filter chain
  55          *
  56          * @param       $filterChain    Name of the filter chain
  57          * @return      void
  58          */
  59         protected function initFilterChain ($filterChain) {
  60                 //* DEBUG: */ $this->debugOutput('CONTROLLER: ' . $filterChain . ' init: START');
  61                 $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
  62                 //* DEBUG: */ $this->debugOutput('CONTROLLER: ' . $filterChain . ' init: FINISHED');
  63         }
  64
  65         /**
  66          * Adds a filter to a given filter chain
  67          *
  68          * @param       $filterChain    Chain of the filter
  69          * @param       $filterInstance         An instance of a filter
  70          * @return      void
  71          * @throws      InvalidFilterChainException     If the filter chain is invalid
  72          */
  73         protected function addFilter ($filterChain, Filterable $filterInstance) {
  74                 //* DEBUG: */ $this->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: START');
  75
  76                 // Test if the filter is there
  77                 if (!isset($this->filterChains[$filterChain])) {
  78                         // Throw an exception here
  79                         throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
  80                 } // END - if
  81
  82                 // Add the filter
  83                 $this->filterChains[$filterChain]->addFilter($filterInstance);
  84                 //* DEBUG: */ $this->debugOutput('CONTROLLER: ' . $filterChain . ',' . $filterInstance->__toString(). ' add: FINISH');
  85         }
  86
  87         /**
  88          * Adds a filter to the pre filter chain
  89          *
  90          * @param       $filterInstance         An instance of a filter
  91          * @return      void
  92          */
  93         public function addPreFilter (Filterable $filterInstance) {
  94                 // Add the pre filter
  95                 $this->addFilter('pre', $filterInstance);
  96         }
  97
  98         /**
  99          * Adds a filter to the post filter chain
 100          *
 101          * @param       $filterInstance         An instance of a filter
 102          * @return      void
 103          */
 104         public function addPostFilter (Filterable $filterInstance) {
 105                 // Add the post filter
 106                 $this->addFilter('post', $filterInstance);
 107         }
 108
 109         /**
 110          * Executes given filter chain chain
 111          *
 112          * @param       $filterChain            Chain of the filter to execute
 113          * @param       $requestInstance        An instance of a request class
 114          * @param       $responseInstance       An instance of a response class
 115          * @return      void
 116          * @throws      InvalidFilterChainException     If the filter chain is invalid
 117          */
 118         protected function executeFilters ($filterChain, Requestable $requestInstance, Responseable $responseInstance) {
 119                 // Test if the filter is there
 120                 if (!isset($this->filterChains[$filterChain])) {
 121                         // Throw an exception here
 122                         throw new InvalidFilterChainException(array($this, $filterChain), self::EXCEPTION_FILTER_CHAIN_INVALID);
 123                 } // END - if
 124
 125                 // Run all filters
 126                 $this->filterChains[$filterChain]->processFilters($requestInstance, $responseInstance);
 127         }
 128
 129         /**
 130          * Executes all pre filters
 131          *
 132          * @param       $requestInstance        An instance of a request class
 133          * @param       $responseInstance       An instance of a response class
 134          * @return      void
 135          */
 136         protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
 137                 // Execute all pre filters
 138                 $this->executeFilters('pre', $requestInstance, $responseInstance);
 139         }
 140
 141         /**
 142          * Executes all post filters
 143          *
 144          * @param       $requestInstance        An instance of a request class
 145          * @param       $responseInstance       An instance of a response class
 146          * @return      void
 147          */
 148         protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
 149                 // Execute all post filters
 150                 $this->executeFilters('post', $requestInstance, $responseInstance);
 151         }
 152 }
 153
 154 // [EOF]
 155 ?>