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