application/hub/classes/filter/tags/class_PackageAnnouncementTagFilter.php

   1 <?php
   2 /**
   3  * A AnnouncementTag filter for packages
   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 PackageAnnouncementTagFilter extends BaseNodeFilter implements FilterablePackage {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Init array
  35                 $this->dataXmlNodes = array(
  36                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS => '',
  37                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS => '',
  38                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_STATUS      => '',
  39                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_MODE        => '',
  40                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_NODE_ID          => '',
  41                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_SESSION_ID       => '',
  42                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => '',
  43                 );
  44         }
  45
  46         /**
  47          * Creates an instance of this filter class
  48          *
  49          * @return      $filterInstance         An instance of this filter class
  50          */
  51         public final static function createPackageAnnouncementTagFilter () {
  52                 // Get a new instance
  53                 $filterInstance = new PackageAnnouncementTagFilter();
  54
  55                 // Return the instance
  56                 return $filterInstance;
  57         }
  58
  59         /**
  60          * Executes the filter with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          * @throws      UnsupportedOperationException   If this method is called, please use processMessage() instead!
  66          */
  67         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  68                 // Please don't call this method
  69                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  70         }
  71
  72         /**
  73          * Processes the given raw message content. The method renderXmlContent
  74          * may throw (not the method itself) several exceptions:
  75          *
  76          * InvalidXmlNodeException  - If an invalid XML node has been found (e.g.
  77          *                            wrong/out-dated template used)
  78          * XmlNodeMismatchException - Again might be caused by invalid XML node
  79          *                            usage
  80          * XmlParserException       - If the XML message is damaged or not
  81          *                            well-formed
  82          *
  83          * @param       $messageData            Raw message data array
  84          * @param       $packageInstance        An instance of a Receivable class
  85          * @return      void
  86          */
  87         public function processMessage (array $messageData, Receivable $packageInstance) {
  88                 // Process message generic
  89                 $this->genericProcessMessage('announcement', $messageData, $packageInstance);
  90         }
  91
  92         /**
  93          * Post-processes the stacked message. Do not call popNamed() as then no
  94          * other class can process the message.
  95          *
  96          * @param       $packageInstance        An instance of a Receivable class
  97          * @return      void
  98          * @throws      UnsupportedOperationException   If this method is called, please use processMessage() instead!
  99          */
 100         public function postProcessMessage (Receivable $packageInstance) {
 101                 // Please don't call this method
 102                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 103         }
 104 }
 105
 106 // [EOF]
 107 ?>