X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ffilter%2Fclass_FilterChain.php;h=632e6745c489a5bc2548a981fee2e74c3fcbc5b9;hp=8b31760dc0d298bb61726a47b33d1ed2a9927b74;hb=1ee35e6d96c456b8e3499bd683f1647aa28bd501;hpb=0d566e56ff27dcbf25a90d513950bbf26fe71422 diff --git a/inc/classes/main/filter/class_FilterChain.php b/inc/classes/main/filter/class_FilterChain.php index 8b31760d..632e6745 100644 --- 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 + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 . */ -class FilterChain extends BaseFrameworkSystem { - /** - * All filters together - */ - private $filters = array(); - +class FilterChain extends BaseFrameworkSystem implements Registerable { /** * Protected constructor * @@ -42,7 +37,7 @@ class FilterChain extends BaseFrameworkSystem { * * @return $chainInstance An instance of this class */ - public final static function createFilterChain () { + public static final function createFilterChain () { // Get a new instance $chainInstance = new FilterChain(); @@ -57,11 +52,21 @@ class FilterChain extends BaseFrameworkSystem { * @return void */ public final function addFilter (Filterable $filterInstance) { - $this->filters[] = $filterInstance; + $this->pushValueToGenericArrayKey('filters', 'generic', 'dummy', $filterInstance); } /** - * Process all added filters + * Getter for filters array + * + * @return $filters The filters array holding all filter instances + */ + protected function getFilters () { + return $this->getGenericArrayKey('filters', 'generic', 'dummy'); + } + + /** + * 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 +74,19 @@ class FilterChain extends BaseFrameworkSystem { */ public function processFilters (Requestable $requestInstance, Responseable $responseInstance) { // Run all filters - //* DEBUG */ echo "COUNT=".count($this->filters)."
\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.
\n"; + //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.'); $filterInstance->execute($requestInstance, $responseInstance); - //* DEBUG */ echo "FILTER: ".$filterInstance->__toString().": Processing ended.
\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