Moved more methods to 'core' as they are now more generalized.

[hub.git] / application / hub / main / handler / class_BaseHandler.php

diff --git a/application/hub/main/handler/class_BaseHandler.php b/application/hub/main/handler/class_BaseHandler.php
index 7c02b75e59aebeb8735f2724032a3073303fb2ad..5a8c828e19f11283e6725af8157a159be841bfb7 100644 (file)
--- a/application/hub/main/handler/class_BaseHandler.php
+++ b/application/hub/main/handler/class_BaseHandler.php
@@ -2,11 +2,11 @@
 /**
  * A general Handler
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -21,7 +21,12 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class BaseHandler extends BaseHubSystem {
+class BaseHandler extends BaseHubSystem implements HandleableDataSet {
+       /**
+        * Handler name
+        */
+       private $handlerName = 'invalid';
+
        /**
         * Protected constructor
         *
@@ -32,6 +37,41 @@ class BaseHandler extends BaseHubSystem {
                // Call parent constructor
                parent::__construct($className);
        }
+
+       /**
+        * Getter for handler name
+        *
+        * @return      $handlerName    Name of this handler
+        */
+       public final function getHandlerName () {
+               return $this->handlerName;
+       }
+
+       /**
+        * Setter for handler name
+        *
+        * @param       $handlerName    Name of this handler
+        * @return      void
+        */
+       protected final function setHandlerName ($handlerName) {
+               $this->handlerName = $handlerName;
+       }
+
+       /**
+        * Adds all required elements from given array into data set instance
+        *
+        * @param       $dataSetInstance        An instance of a StoreableCriteria class
+        * @param       $messageData            An array with all message data
+        * @return      void
+        * @todo        Rewrite this to use DHT
+        */
+       public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
+               // Add some generic data all messageData arrays provide
+               /*
+               $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]);
+               $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_MESSAGE_TYPE , $messageData[NetworkPackage::MESSAGE_ARRAY_TYPE]);
+               */
+       }
 }
 
 // [EOF]