3 * A database wrapper for node informations
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class NodeInformationDatabaseWrapper extends BaseDatabaseWrapper {
25 // Constants for database table names
26 const DB_TABLE_NODE_INFORMATION = 'node_data';
28 // Constants for database column names
29 const DB_COLUMN_NODE_NR = 'node_nr';
30 const DB_COLUMN_NODE_ID = 'node_id';
31 const DB_COLUMN_SESSION_ID = 'session_id';
32 const DB_COLUMN_NODE_TYPE = 'node_type';
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this database wrapper by a provided user class
47 * @return $wrapperInstance An instance of the created wrapper class
49 public static final function createNodeInformationDatabaseWrapper () {
51 $wrapperInstance = new NodeInformationDatabaseWrapper();
53 // Set (primary!) table name
54 $wrapperInstance->setTableName(self::DB_TABLE_NODE_INFORMATION);
56 // Return the instance
57 return $wrapperInstance;
61 * Getter for index key
63 * @return $indexKey Index key
65 public final function getIndexKey () {
66 return $this->getDatabaseInstance()->getIndexKey();
70 * 'Registers' a new node id along with data provided in the node instance.
71 * This may sound confusing but avoids double code very nicely...
73 * @param $nodeInstance A node instance
74 * @param $requestInstance An instance of a Requestable class
77 public function registerNodeId (BaseHubNode $nodeInstance, Requestable $requestInstance) {
78 // Get a dataset instance
79 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_INFORMATION));
81 // Set the primary key
82 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
84 // Add registration elements to the dataset
85 $nodeInstance->addElementsToDataSet($dataSetInstance, $requestInstance);
87 // "Insert" this request instance completely into the database
88 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
92 * 'Registers' a new session id along with data provided in the node instance.
93 * This may sound confusing but avoids double code very nicely...
95 * @param $nodeInstance A node instance
96 * @param $requestInstance An instance of a Requestable class
99 public function registerSessionId (BaseHubNode $nodeInstance, Requestable $requestInstance) {
100 // Get a dataset instance
101 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_NODE_INFORMATION));
103 // Set the primary key
104 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
106 // Add registration elements to the dataset
107 $nodeInstance->addElementsToDataSet($dataSetInstance, $requestInstance);
109 // "Insert" this request instance completely into the database
110 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);