framework/main/classes/handler/class_BaseHandler.php

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