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

   1 <?php
   2 /**
   3  * A RequestNodeListTag 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 PackageRequestNodeListTagFilter 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 XML nodes array which contains the required data
  35                 $this->dataXmlNodes = array(
  36                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES => '',
  37                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID            => '',
  38                 );
  39         }
  40
  41         /**
  42          * Creates an instance of this filter class
  43          *
  44          * @return      $filterInstance         An instance of this filter class
  45          */
  46         public final static function createPackageRequestNodeListTagFilter () {
  47                 // Get a new instance
  48                 $filterInstance = new PackageRequestNodeListTagFilter();
  49
  50                 // Return the instance
  51                 return $filterInstance;
  52         }
  53
  54         /**
  55          * Executes the filter with given request and response objects
  56          *
  57          * @param       $requestInstance        An instance of a class with an Requestable interface
  58          * @param       $responseInstance       An instance of a class with an Responseable interface
  59          * @return      void
  60          * @throws      UnsupportedOperationException   If this method is called
  61          */
  62         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  63                 // Please don't call this method
  64                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  65         }
  66
  67         /**
  68          * Processes the given raw message content.
  69          *
  70          * @param       $messageData            Raw message data array
  71          * @param       $packageInstance        An instance of a Receivable class
  72          * @return      void
  73          */
  74         public function processMessage (array $messageData, Receivable $packageInstance) {
  75                 // Process messasge generic
  76                 $this->genericProcessMessage('request_node_list', $messageData, $packageInstance);
  77         }
  78
  79         /**
  80          * Post-processes the stacked message. Do not call popNamed() as then no
  81          * other class can process the message.
  82          *
  83          * @param       $packageInstance        An instance of a Receivable class
  84          * @return      void
  85          * @throws      UnsupportedOperationException   If this method is called
  86          */
  87         public function postProcessMessage (Receivable $packageInstance) {
  88                 // Please don't call this method
  89                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  90         }
  91 }
  92
  93 // [EOF]
  94 ?>