application/hub/main/handler/message-types/self-connect/class_NodeMessageSelfConnectHandler.php

   1 <?php
   2 /**
   3  * A NodeMessageSelfConnect 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 NodeMessageSelfConnectHandler 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_type_self_connect');
  36
  37                 // Init message data array
  38                 $this->messageDataElements = array(
  39                         XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_NODE_ID,
  40                         XmlSelfConnectTemplateEngine::SELF_CONNECT_DATA_SESSION_ID
  41                 );
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @return      $handlerInstance        An instance of a HandleableMessage class
  48          */
  49         public final static function createNodeMessageSelfConnectHandler () {
  50                 // Get new instance
  51                 $handlerInstance = new NodeMessageSelfConnectHandler();
  52
  53                 // Return the prepared instance
  54                 return $handlerInstance;
  55         }
  56
  57         /**
  58          * Handles data array of the message
  59          *
  60          * @param       $messageData            An array with message data to handle
  61          * @param       $packageInstance        An instance of a Receivable class
  62          * @return      void
  63          */
  64         public function handleMessageData (array $messageData, Receivable $packageInstance) {
  65                 // Register the announcing node with this node
  66                 $this->registerNodeByMessageData($messageData);
  67
  68                 // Prepare answer message to be delivered back to the other node
  69                 $this->prepareAnswerMessage($messageData, $packageInstance);
  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          */
  79         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  80                 // Add all ements
  81                 foreach ($this->messageDataElements as $key) {
  82                         // Is it there?
  83                         assert(isset($messageData[$key]));
  84
  85                         // Add it
  86                         $dataSetInstance->addCriteria('node_' . $key, $messageData[$key]);
  87                 } // END - foreach
  88         }
  89 }
  90
  91 // [EOF]
  92 ?>