3 * A database wrapper for node list
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 NodeListDatabaseWrapper extends BaseDatabaseWrapper implements Registerable {
26 const DB_TABLE_NODE_LIST = 'node_list';
28 // Constants for column name
29 const DB_COLUMN_NODE_SESSION_ID = 'node_session_id';
30 const DB_COLUMN_NODE_IP_PORT = 'node_ipport';
33 const INVALID_IP_PORT = 'invalid:invalid';
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this database wrapper by a provided user class
48 * @return $wrapperInstance An instance of the created wrapper class
50 public static final function createNodeListDatabaseWrapper () {
52 $wrapperInstance = new NodeListDatabaseWrapper();
54 // Set (primary!) table name
55 $wrapperInstance->setTableName(self::DB_TABLE_NODE_LIST);
57 // Return the instance
58 return $wrapperInstance;
62 * Getter for index key
64 * @return $indexKey Index key
66 public final function getIndexKey () {
67 return $this->getDatabaseInstance()->getIndexKey();
71 * Resolves a session id into an ip:port combination
73 * @param $sessionId A valid session id
74 * @return $recipient Recipient as ip:port combination
76 public function resolveIpPortBySessionId ($sessionId) {
77 // Set invalid ip:port combination
78 $recipient = self::INVALID_IP_PORT;
80 // Now get a search criteria instance
81 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
83 // Search for the node session id
84 $searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_SESSION_ID, $sessionId);
85 $searchInstance->setLimit(1);
88 $resultInstance = $this->doSelectByCriteria($searchInstance);
91 if ($resultInstance->next()) {
92 // Save the result instance in this class
93 $this->setResultInstance($resultInstance);
95 // Get the node id from result and set it
96 $recipient = $this->getField(NodeListDatabaseWrapper::DB_COLUMN_NODE_IP_PORT);