git.mxchange.org Git - hub.git/blob

   1 <?php
   2 // Own namespace
   3 namespace Hub\Handler\Node\Answer\Request\NodeList;
   4
   5 // Import application-specific stuff
   6 use Hub\Factory\Node\NodeObjectFactory;
   7 use Hub\Network\Receive\Receivable;
   8 use Hub\Template\Engine\Xml\Network\Answer\BaseXmlAnswerTemplateEngine;
   9
  10 // Import framework stuff
  11 use CoreFramework\Criteria\Storing\StoreableCriteria;
  12 use CoreFramework\Generic\UnsupportedOperationException;
  13 use CoreFramework\Registry\Registerable;
  14
  15 /**
  16  * A NodeMessageRequestNodeListAnswer handler
  17  *
  18  * @author              Roland Haeder <webmaster@shipsimu.org>
  19  * @version             0.0.0
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  24  * This program is free software: you can redistribute it and/or modify
  25  * it under the terms of the GNU General Public License as published by
  26  * the Free Software Foundation, either version 3 of the License, or
  27  * (at your option) any later version.
  28  *
  29  * This program is distributed in the hope that it will be useful,
  30  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32  * GNU General Public License for more details.
  33  *
  34  * You should have received a copy of the GNU General Public License
  35  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  36  */
  37 class NodeMessageRequestNodeListAnswerHandler extends BaseMessageHandler implements HandleableMessage, Registerable {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46
  47                 // Set handler name
  48                 $this->setHandlerName('message_request_node_list_answer');
  49
  50                 // Init message data array
  51                 $this->messageDataElements = array(
  52                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  53                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_NODE_LIST,
  54                         BaseXmlAnswerTemplateEngine::ANSWER_STATUS,
  55                 );
  56
  57                 // Init message-data->configuration translation array
  58                 $this->messageToConfig = array(
  59                 /*
  60                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID  => 'your_session_id'
  61                 */
  62                 );
  63
  64                 // Init search data array
  65                 $this->searchData = array(
  66                         XmlRequestNodeListAnswerTemplateEngine::REQUEST_DATA_SESSION_ID,
  67                 );
  68         }
  69
  70         /**
  71          * Creates an instance of this class
  72          *
  73          * @return      $handlerInstance        An instance of a HandleableMessage class
  74          */
  75         public final static function createNodeMessageRequestNodeListAnswerHandler () {
  76                 // Get new instance
  77                 $handlerInstance = new NodeMessageRequestNodeListAnswerHandler();
  78
  79                 // Return the prepared instance
  80                 return $handlerInstance;
  81         }
  82
  83         /**
  84          * Handles data array of the message
  85          *
  86          * @param       $messageData            An array with message data to handle
  87          * @param       $packageInstance        An instance of a Receivable class
  88          * @return      void
  89          * @throws      NoRequestNodeListAttemptedException     If this node has not attempted to announce itself
  90          */
  91         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  92                 // Get node instance
  93                 $nodeInstance = NodeObjectFactory::createNodeInstance();
  94
  95                 // Has this node attempted to announce itself?
  96                 if (!$nodeInstance->ifNodeHasAnnouncementCompleted()) {
  97                         /*
  98                          * This node has never announced itself, so it doesn't expect
  99                          * request-node-list answer messages.
 100                          */
 101                         throw new NoRequestNodeListAttemptedException(array($this, $nodeInstance, $messageData), self::EXCEPTION_ANNOUNCEMENT_NOT_ATTEMPTED);
 102                 } // END - if
 103
 104                 // Register the announcing node with this node
 105                 $this->registerNodeByMessageData($messageData);
 106
 107                 // Handle the answer status element
 108                 $nodeInstance->handleAnswerStatusByMessageData($messageData, $packageInstance);
 109         }
 110
 111         /**
 112          * Adds all required elements from given array into data set instance
 113          *
 114          * @param       $dataSetInstance        An instance of a StoreableCriteria class
 115          * @param       $messageData            An array with all message data
 116          * @return      void
 117          */
 118         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
 119                 // Add generic first
 120                 parent::addArrayToDataSet($dataSetInstance, $messageData);
 121
 122                 // Debug message
 123                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('ANSWER-HANDLER: messageData=' . print_r($messageData, TRUE));
 124
 125                 // Add all ements
 126                 foreach ($this->messageDataElements as $key) {
 127                         // Debug message
 128                         /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('ANSWER-HANDLER: messageData[' . $key . ']=' . $messageData[$key]);
 129
 130                         // Is it there?
 131                         assert(isset($messageData[$key]));
 132
 133                         /*
 134                          * Add it, but remove any 'my-' prefixes as they are not used in
 135                          * database layer.
 136                          */
 137                         $dataSetInstance->addCriteria(str_replace('my-', '', $key), $messageData[$key]);
 138                 } // END - foreach
 139         }
 140
 141         /**
 142          * Initializes configuration data from given message data array
 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 initMessageConfigurationData (array $messageData) {
 149                 // Please don't call this method
 150                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 151         }
 152
 153         /**
 154          * Removes configuration data with given message data array from global
 155          * configuration
 156          *
 157          * @param       $messageData    An array with all message data
 158          * @return      void
 159          * @throws      UnsupportedOperationException   If this method is called
 160          */
 161         protected function removeMessageConfigurationData (array $messageData) {
 162                 // Please don't call this method
 163                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 164         }
 165
 166 }