inc/classes/main/handler/class_BaseHandler.php

   1 <?php
   2 /**
   3  * A general Handler
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core 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 BaseHandler extends BaseFrameworkSystem implements HandleableDataSet {
  25         /**
  26          * Handler name
  27          */
  28         private $handlerName = 'invalid';
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Getter for handler name
  43          *
  44          * @return      $handlerName    Name of this handler
  45          */
  46         public final function getHandlerName () {
  47                 return $this->handlerName;
  48         }
  49
  50         /**
  51          * Setter for handler name
  52          *
  53          * @param       $handlerName    Name of this handler
  54          * @return      void
  55          */
  56         protected final function setHandlerName ($handlerName) {
  57                 $this->handlerName = $handlerName;
  58         }
  59
  60         /**
  61          * Adds all required elements from given array into data set instance
  62          *
  63          * @param       $dataSetInstance        An instance of a StoreableCriteria class
  64          * @param       $messageData            An array with all message data
  65          * @return      void
  66          * @todo        Rewrite this to use DHT
  67          */
  68         public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
  69                 // Add some generic data all messageData arrays provide
  70                 /*
  71                 $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_ANSWER_STATUS, $messageData[BaseXmlAnswerTemplateEngine::ANSWER_STATUS]);
  72                 $dataSetInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_MESSAGE_TYPE , $messageData[NetworkPackage::MESSAGE_ARRAY_TYPE]);
  73                 */
  74         }
  75 }
  76
  77 // [EOF]
  78 ?>