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

   1 <?php
   2 /**
   3  * A NodeMessageRequestNodeListAnswer handler
   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 NodeMessageRequestNodeListAnswerHandler 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_request_node_list_answer');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  40                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_NODE_LIST,
  41                         BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
  42                 );
  43
  44                 // Init message-data->configuration translation array
  45                 $this->messageToConfig = array(
  46                 /*
  47                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID  => 'your_session_id'
  48                 */
  49                 );
  50
  51                 // Init search data array
  52                 $this->searchData = array(
  53                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  54                 );
  55         }
  56
  57         /**
  58          * Creates an instance of this class
  59          *
  60          * @return      $handlerInstance        An instance of a HandleableMessage class
  61          */
  62         public final static function createNodeMessageRequestNodeListAnswerHandler () {
  63                 // Get new instance
  64                 $handlerInstance = new NodeMessageRequestNodeListAnswerHandler();
  65
  66                 // Return the prepared instance
  67                 return $handlerInstance;
  68         }
  69
  70         /**
  71          * Handles data array of the message
  72          *
  73          * @param       $messageData            An array with message data to handle
  74          * @param       $packageInstance        An instance of a Receivable class
  75          * @return      void
  76          * @throws      NoRequestNodeListAttemptedException     If this node has not attempted to announce itself
  77          */
  78         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  79                 // Get node instance
  80                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  81
  82                 // Has this node attempted to announce itself?
  83                 if (!$nodeInstance->ifNodeHasAnnouncementCompleted()) {
  84                         /*
  85                          * This node has never announced itself, so it doesn't expect
  86                          * request-node-list answer messages.
  87                          */
  88                         throw new NoRequestNodeListAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
  89                 } // END - if
  90
  91                 // Register the announcing node with this node
  92                 $this->registerNodeByMessageData($messageData);
  93
  94                 // Handle the answer status element
  95                 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
  96         }
  97
  98         /**
  99          * Adds all required elements from given array into data set instance
 100          *
 101          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 102          * @param       $messageData            An array with all message data
 103          * @return      void
 104          */
 105         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 106                 // Add generic first
 107                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 108
 109                 // Debug message
 110                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData=' . print_r($messageData, TRUE));
 111
 112                 // Add all ements
 113                 foreach ($this->messageDataElements as $key) {
 114                         // Debug message
 115                         //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('ANSWER-HANDLER[' . __METHOD__ . ':' . __LINE__ . ']: messageData[' . $key . ']=' . $messageData[$key]);
 116
 117                         // Is it there?
 118                         assert(isset($messageData[$key]));
 119
 120                         /*
 121                          * Add it, but remove any 'my-' prefixes as they are not used in
 122                          * database layer.
 123                          */
 124                         $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
 125                 } // END - foreach
 126         }
 127
 128         /**
 129          * Initializes configuration data from given message data array
 130          *
 131          * @param       $messageData    An array with all message data
 132          * @return      void
 133          * @throws      UnsupportedOperationException   If this method is called
 134          */
 135         protected function initMessageConfigurationData (array $messageData) {
 136                 // Please don't call this method
 137                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 138         }
 139
 140         /**
 141          * Removes configuration data with given message data array from global
 142          * configuration
 143          *
 144          * @param       $messageData    An array with all message data
 145          * @return      void
 146          * @throws      UnsupportedOperationException   If this method is called
 147          */
 148         protected function removeMessageConfigurationData (array $messageData) {
 149                 // Please don't call this method
 150                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 151         }
 152 }
 153
 154 // [EOF]
 155 ?>