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

   1 <?php
   2 /**
   3  * A RequestNodeListAnswerTag filter for Package
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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                 );
  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 createPackageRequestNodeListAnswerTagFilter () {
  47                 // Get a new instance
  48                 $filterInstance = new PackageRequestNodeListAnswerTagFilter();
  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, please use processMessage() instead!
  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. The method renderXmlContent
  69          * may throw (not the method itself) several exceptions:
  70          *
  71          * @param       $messageContent         Raw message content
  72          * @param       $packageInstance        An instance of a Receivable class
  73          * @return      void
  74          */
  75         public function processMessage ($messageContent, Receivable $packageInstance) {
  76                 // Process message in generic way
  77                 $this->genericProcessMessage('request_node_list_answer', $messageContent, $packageInstance);
  78         }
  79 }
  80
  81 // [EOF]
  82 ?>