X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Ffilter%2Fclass_FilterChain.php;h=e80c956d88383d933a7a4da57c28fb2ce478a094;hp=c192bf3f3909fdb0055f84cdfc8a06c52d9c9974;hb=ba3dac8b2dac48e02d7ac0297e3515275c3a83d1;hpb=ac948286448f4e0d4ef71d2dc8daaac53e8c902b diff --git a/inc/classes/main/filter/class_FilterChain.php b/inc/classes/main/filter/class_FilterChain.php index c192bf3f..e80c956d 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 - 2012 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 @@ -22,11 +22,6 @@ * along with this program. If not, see . */ class FilterChain extends BaseFrameworkSystem implements Registerable { - /** - * All filters together - */ - private $filters = array(); - /** * Protected constructor * @@ -57,20 +52,60 @@ class FilterChain extends BaseFrameworkSystem implements Registerable { * @return void */ public final function addFilter (Filterable $filterInstance) { - array_push($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 + * "Getter" for filters array * * @return $filters The filters array holding all filter instances */ protected function getFilters () { - return $this->filters; + // 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; } /** - * Process all added 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. 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 @@ -78,8 +113,11 @@ class FilterChain extends BaseFrameworkSystem implements Registerable { */ public function processFilters (Requestable $requestInstance, Responseable $responseInstance) { // Run all filters - //* DEBUG */ self::createDebugInstance(__CLASS__)->debugOutput('COUNT=' . count($this->filters)); + //* 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 */ self::createDebugInstance(__CLASS__)->debugOutput('FILTER: ' . $filterInstance->__toString() . ': Processing started.');