Added post-filter support.

[core.git] / inc / classes / main / filter / class_FilterChain.php

diff --git a/inc/classes/main/filter/class_FilterChain.php b/inc/classes/main/filter/class_FilterChain.php
index dcdb882c14cb927d82f285fd2eb6a9944d5bbd46..e80c956d88383d933a7a4da57c28fb2ce478a094 100644 (file)
--- a/inc/classes/main/filter/class_FilterChain.php
+++ b/inc/classes/main/filter/class_FilterChain.php
@@ -2,11 +2,11 @@
 /**
  * A filter chain for pre and post filters
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,12 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class FilterChain extends BaseFrameworkSystem {
-       /**
-        * All filters together
-        */
-       private $filters = array();
-
+class FilterChain extends BaseFrameworkSystem implements Registerable {
        /**
         * Protected constructor
         *
@@ -57,11 +52,60 @@ class FilterChain extends BaseFrameworkSystem {
         * @return      void
         */
        public final function addFilter (Filterable $filterInstance) {
-               $this->filters[] = $filterInstance;
+               $this->pushValueToGenericArrayKey('filters', 'generic', 'dummy', $filterInstance);
+       }
+
+       /**
+        * Add a new post-filter
+        *
+        * @param       $filerInstance  An instance of a post-filter class
+        * @return      void
+        */
+       public final function addPostFilter (Filterable $filterInstance) {
+               $this->pushValueToGenericArrayKey('filters', 'post', 'dummy', $filterInstance);
+       }
+
+       /**
+        * "Getter" for filters array
+        *
+        * @return      $filters        The filters array holding all filter instances
+        */
+       protected function getFilters () {
+               // Default is nothing found
+               $filters = array();
+
+               // Are some filters set?
+               if ($this->isValidGenericArrayKey('filters', 'generic', 'dummy')) {
+                       // Then get them
+                       $filters = $this->getGenericArrayKey('filters', 'generic', 'dummy');
+               } // END - if
+
+               // Return it
+               return $filters;
+       }
+
+       /**
+        * "Getter" for post-filters array
+        *
+        * @return      $filters        The filters array holding all post-filter instances
+        */
+       protected function getPostFilters () {
+               // Default is nothing found
+               $filters = array();
+
+               // Are some filters set?
+               if ($this->isValidGenericArrayKey('filters', 'post', 'dummy')) {
+                       // Then get them
+                       $filters = $this->getGenericArrayKey('filters', 'post', 'dummy');
+               } // END - if
+
+               // Return it
+               return $filters;
        }
 
        /**
-        * Process all added filters
+        * Process all added filters. Please note that filters must throw
+        * FilterChainException if they need to interrupt the filter chain.
         *
         * @param       $requestInstance        An instance of a request class
         * @param       $responseInstance       An instance of a response class
@@ -69,15 +113,19 @@ class FilterChain extends BaseFrameworkSystem {
         */
        public function processFilters (Requestable $requestInstance, Responseable $responseInstance) {
                // Run all filters
-               //* DEBUG */ echo "COUNT=".count($this->filters)."<br />\n";
-               foreach ($this->filters as $filterInstance) {
+               //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('COUNT=' . $this->countGenericArray('filters'));
+               foreach ($this->getFilters() as $filterInstance) {
+                       // Must be an instance of Filterable
+                       assert($filterInstance instanceof Filterable);
+
                        // Try to execute this filter
                        try {
-                               //* DEBUG */ echo "FILTER: ".$filterInstance->__toString().": Processing started.<br />\n";
+                               //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');
                                $filterInstance->execute($requestInstance, $responseInstance);
-                               //* DEBUG */ echo "FILTER: ".$filterInstance->__toString().": Processing ended.<br />\n";
+                               //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing ended.');
                        } catch (FilterChainException $e) {
                                // This exception can be thrown to just skip any further processing
+                               self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
                                break;
                        }
                } // END - foreach