3 namespace CoreFramework\Handler;
5 // Import framework stuff
6 use CoreFramework\Criteria\Storing\StoreableCriteria;
7 use CoreFramework\Object\BaseFrameworkSystem;
12 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
31 class BaseHandler extends BaseFrameworkSystem implements HandleableDataSet {
35 private $handlerName = 'invalid';
38 * Protected constructor
40 * @param $className Name of the class
43 protected function __construct ($className) {
44 // Call parent constructor
45 parent::__construct($className);
49 * Getter for handler name
51 * @return $handlerName Name of this handler
53 public final function getHandlerName () {
54 return $this->handlerName;
58 * Setter for handler name
60 * @param $handlerName Name of this handler
63 protected final function setHandlerName ($handlerName) {
64 $this->handlerName = $handlerName;
68 * Adds all required elements from given array into data set instance
70 * @param $dataSetInstance An instance of a StoreableCriteria class
71 * @param $messageData An array with all message data
73 * @todo Rewrite this to use DHT
75 public function addArrayToDataSet (StoreableCriteria $dataSetInstance, array $messageData) {
76 // Add some generic data all messageData arrays provide
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]);