application/hub/interfaces/filter/class_FilterablePackage.php

   1 <?php
   2 /**
   3  * A class for package filters
   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 interface FilterablePackage extends Filterable {
  25         /**
  26          * Processes the given raw message content.
  27          *
  28          * @param       $messageData            Raw message data array
  29          * @param       $packageInstance        An instance of a Receivable class
  30          * @return      void
  31          */
  32         function processMessage (array $messageData, Receivable $packageInstance);
  33
  34         /**
  35          * Post-processes the stacked message. Do not call popNamed() as then no
  36          * other class can process the message.
  37          *
  38          * @param       $packageInstance        An instance of a Receivable class
  39          * @return      void
  40          */
  41         function postProcessMessage (Receivable $packageInstance);
  42 }
  43
  44 // [EOF]
  45 ?>