inc/main/classes/handler/class_BaseHandler.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Handler;
   4
   5 // Import framework stuff
   6 use CoreFramework\Object\BaseFrameworkSystem;
   7
   8 /**
   9  * A general Handler
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class BaseHandler extends BaseFrameworkSystem implements HandleableDataSet {
  31         /**
  32          * Handler name
  33          */
  34         private $handlerName = 'invalid';
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @param       $className      Name of the class
  40          * @return      void
  41          */
  42         protected function __construct ($className) {
  43                 // Call parent constructor
  44                 parent::__construct($className);
  45         }
  46
  47         /**
  48          * Getter for handler name
  49          *
  50          * @return      $handlerName    Name of this handler
  51          */
  52         public final function getHandlerName () {
  53                 return $this->handlerName;
  54         }
  55
  56         /**
  57          * Setter for handler name
  58          *
  59          * @param       $handlerName    Name of this handler
  60          * @return      void
  61          */
  62         protected final function setHandlerName ($handlerName) {
  63                 $this->handlerName = $handlerName;
  64         }
  65
  66         /**
  67          * Adds all required elements from given array into data set instance
  68          *
  69          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  70          * @param       $messageData            An array with all message data
  71          * @return      void
  72          * @todo        Rewrite this to use DHT
  73          */
  74         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  75                 // Add some generic data all messageData arrays provide
  76                 /*
  77                 $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]);
  78                 $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_MESSAGE_TYPE , $messageData[NetworkPackage::MESSAGE_ARRAY_TYPE]);
  79                 */
  80         }
  81
  82 }