application/hub/main/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_SESSION_ID       => ''
  41                         XmlAnnouncementTemplateEngine::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH => ''
  42                 );
  43         }
  44
  45         /**
  46          * Creates an instance of this filter class
  47          *
  48          * @return      $filterInstance         An instance of this filter class
  49          */
  50         public final static function createPackageAnnouncementTagFilter () {
  51                 // Get a new instance
  52                 $filterInstance = new PackageAnnouncementTagFilter();
  53
  54                 // Return the instance
  55                 return $filterInstance;
  56         }
  57
  58         /**
  59          * Executes the filter with given request and response objects
  60          *
  61          * @param       $requestInstance        An instance of a class with an Requestable interface
  62          * @param       $responseInstance       An instance of a class with an Responseable interface
  63          * @return      void
  64          * @throws      UnsupportedOperationException   If this method is called, please use processMessage() instead!
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Please don't call this method
  68                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  69         }
  70
  71         /**
  72          * Processes the given raw message content. The method renderXmlContent
  73          * may throw (not the method itself) several exceptions:
  74          *
  75          * InvalidXmlNodeException  - If an invalid XML node has been found (e.g.
  76          *                            wrong/out-dated template used)
  77          * XmlNodeMismatchException - Again might be caused by invalid XML node
  78          *                            usage
  79          * XmlParserException       - If the XML message is damaged or not
  80          *                            well-formed
  81          *
  82          * @param       $messageData            Raw message data array
  83          * @param       $packageInstance        An instance of a Receivable class
  84          * @return      void
  85          */
  86         public function processMessage (array $messageData, Receivable $packageInstance) {
  87                 // Process message generic
  88                 $this->genericProcessMessage('announcement', $messageData, $packageInstance);
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>