Before a filter chain is executed we check if it is there
[core.git] / inc / classes / main / controller / class_BaseController.php
index 1f35cb0..2a1c50f 100644 (file)
@@ -6,7 +6,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -29,6 +29,9 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         */
        private $filterChains = array();
 
         */
        private $filterChains = array();
 
+       // Exception constants
+       const EXCEPTION_FILTER_CHAIN_INVALID = 0xf10;
+
        /**
         * Protected constructor
         *
        /**
         * Protected constructor
         *
@@ -57,10 +60,21 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         * @param       $filterChain    Name of the filter chain
         * @return      void
         */
         * @param       $filterChain    Name of the filter chain
         * @return      void
         */
-       private function initFilterChain ($filterChain) {
+       protected function initFilterChain ($filterChain) {
                $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
        }
 
                $this->filterChains[$filterChain] = ObjectFactory::createObjectByConfiguredName('filter_chain_class');
        }
 
+       /**
+        * Adds a filter to a given filter group
+        *
+        * @param       $filterGroup    Group of the filter
+        * @param       $filterInstance         An instance of a filter
+        * @return      void
+        */
+       protected function addFilter ($filterGroup, Filterable $filterInstance) {
+               $this->filterChains[$filterGroup]->addFilter($filterInstance);
+       }
+
        /**
         * Adds a filter to the pre filter chain
         *
        /**
         * Adds a filter to the pre filter chain
         *
@@ -69,7 +83,7 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         */
        public function addPreFilter (Filterable $filterInstance) {
                // Add the pre filter
         */
        public function addPreFilter (Filterable $filterInstance) {
                // Add the pre filter
-               $this->filterChains['pre']->addFilter($filterInstance);
+               $this->addFilter('pre', $filterInstance);
        }
 
        /**
        }
 
        /**
@@ -80,7 +94,27 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         */
        public function addPostFilter (Filterable $filterInstance) {
                // Add the post filter
         */
        public function addPostFilter (Filterable $filterInstance) {
                // Add the post filter
-               $this->filterChains['post']->addFilter($filterInstance);
+               $this->addFilter('post', $filterInstance);
+       }
+
+       /**
+        * Executes given filter chain group
+        *
+        * @param       $filterGroup    Group of the filter to execute
+        * @param       $requestInstance        An instance of a request class
+        * @param       $responseInstance       An instance of a response class
+        * @return      void
+        * @throws      InvalidFilterChainException     If the filter chain is invalid
+        */
+       protected function executeFilters ($filterGroup, Requestable $requestInstance, Responseable $responseInstance) {
+               // Test if the filter is there
+               if (!isset($this->filterChains[$filterGroup])) {
+                       // Throw an exception here
+                       throw new InvalidFilterChainException(array($this, $filterGroup), self::EXCEPTION_FILTER_CHAIN_INVALID);
+               } // END - if
+
+               // Run all filters
+               $this->filterChains[$filterGroup]->processFilters($requestInstance, $responseInstance);
        }
 
        /**
        }
 
        /**
@@ -92,7 +126,7 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         */
        protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
                // Execute all pre filters
         */
        protected function executePreFilters (Requestable $requestInstance, Responseable $responseInstance) {
                // Execute all pre filters
-               $this->filterChains['pre']->processFilters($requestInstance, $responseInstance);
+               $this->executeFilters('pre', $requestInstance, $responseInstance);
        }
 
        /**
        }
 
        /**
@@ -104,7 +138,7 @@ class BaseController extends BaseFrameworkSystem implements Registerable {
         */
        protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
                // Execute all post filters
         */
        protected function executePostFilters (Requestable $requestInstance, Responseable $responseInstance) {
                // Execute all post filters
-               $this->filterChains['post']->processFilters($requestInstance, $responseInstance);
+               $this->executeFilters('post', $requestInstance, $responseInstance);
        }
 }
 
        }
 }