application/hub/main/filter/tags/answer/class_PackageRequestNodeListAnswerTagFilter.php

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