application/hub/main/chains/class_PackageFilterChain.php

   1 <?php
   2 /**
   3  * A filter chain for processing network packages (or better messages)
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class PackageFilterChain extends FilterChain {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $chainInstance  An instance of this class
  39          */
  40         public static final function createPackageFilterChain () {
  41                 // Get a new instance
  42                 $chainInstance = new PackageFilterChain();
  43
  44                 // Return the prepared instance
  45                 return $chainInstance;
  46         }
  47
  48         /**
  49          * Processes the given raw message content through all filters
  50          *
  51          * @param       $messageData            Raw message data array
  52          * @param       $packageInstance        An instance of a Receivable class
  53          * @return      void
  54          * @todo        This may be slow if a message with a lot tags arrived
  55          */
  56         public function processMessage (array $messageData, Receivable $packageInstance) {
  57                 // Get all filters and "run" them
  58                 foreach ($this->getFilters() as $filterInstance) {
  59                         // Try to process it
  60                         try {
  61                                 $filterInstance->processMessage($messageData, $packageInstance);
  62                         } catch (FilterChainException $e) {
  63                                 // This exception can be thrown to just skip any further processing
  64                                 self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
  65                                 break;
  66                         }
  67                 } // END - foreach
  68         }
  69
  70         /**
  71          * Post-processes the stacked message. Do not call popNamed() as then no
  72          * other class can process the message.
  73          *
  74          * @param       $packageInstance        An instance of a Receivable class
  75          * @return      void
  76          */
  77         public function postProcessMessage (Receivable $packageInstance) {
  78                 // Get all filters and "run" them
  79                 foreach ($this->getPostFilters() as $filterInstance) {
  80                         // Try to process it
  81                         try {
  82                                 $filterInstance->postProcessMessage($packageInstance);
  83                         } catch (FilterChainException $e) {
  84                                 // This exception can be thrown to just skip any further processing
  85                                 self::createDebugInstance(__CLASS__)->debugOutput('Failed to execute lase filter ' . $filterInstance->__toString() . ': ' . $e->getMessage());
  86                                 break;
  87                         }
  88                 } // END - foreach
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>