application/hub/main/handler/message-types/answer/class_NodeMessageAnnouncementAnswerHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageAnnouncementAnswer handler
   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 NodeMessageAnnouncementAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set handler name
  35                 $this->setHandlerName('message_announcement');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                 );
  40
  41                 // Init message-data->configuration translation array
  42                 $this->messageToConfig = array(
  43                 );
  44         }
  45
  46         /**
  47          * Creates an instance of this class
  48          *
  49          * @return      $handlerInstance        An instance of a HandleableMessage class
  50          */
  51         public final static function createNodeMessageAnnouncementAnswerHandler () {
  52                 // Get new instance
  53                 $handlerInstance = new NodeMessageAnnouncementAnswerHandler();
  54
  55                 // Return the prepared instance
  56                 return $handlerInstance;
  57         }
  58
  59         /**
  60          * Handles data array of the message
  61          *
  62          * @param       $messageData            An array with message data to handle
  63          * @param       $packageInstance        An instance of a Receivable class
  64          * @return      void
  65          */
  66         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  67                 die('messageData=' . print_r($messageData, true));
  68                 // Register the announcing node with this node
  69                 $this->registerNodeByMessageData($messageData);
  70         }
  71
  72         /**
  73          * Adds all required elements from given array into data set instance
  74          *
  75          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  76          * @param       $messageData            An array with all message data
  77          * @return      void
  78          * @throws      UnsupportedOperationException   If this method is called
  79          */
  80         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  81                 // Please don't call this method
  82                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  83         }
  84
  85         /**
  86          * Initializes configuration data from given message data array
  87          *
  88          * @param       $messageData    An array with all message data
  89          * @return      void
  90          * @throws      UnsupportedOperationException   If this method is called
  91          */
  92         protected function initMessageConfigurationData (array $messageData) {
  93                 // Please don't call this method
  94                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  95         }
  96
  97         /**
  98          * Removes configuration data with given message data array from global
  99          * configuration
 100          *
 101          * @param       $messageData    An array with all message data
 102          * @return      void
 103          * @throws      UnsupportedOperationException   If this method is called
 104          */
 105         protected function removeMessageConfigurationData (array $messageData) {
 106                 // Please don't call this method
 107                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 108         }
 109 }
 110
 111 // [EOF]
 112 ?>