3 * A database wrapper for node list
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 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 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this database wrapper by a provided user class
45 * @return $wrapperInstance An instance of the created wrapper class
47 public static final function createNodeListDatabaseWrapper () {
49 $wrapperInstance = new NodeListDatabaseWrapper();
51 // Set (primary!) table name
52 $wrapperInstance->setTableName(self::DB_TABLE_NODE_LIST);
54 // Return the instance
55 return $wrapperInstance;
59 * Getter for index key
61 * @return $indexKey Index key
63 public final function getIndexKey () {
64 return $this->getDatabaseInstance()->getIndexKey();
68 * Resolves a session id into an ip:port combination
70 * @param $sessionId A valid session id
71 * @return $recipient Recipient as ip:port combination
73 public function resolveIpPortBySessionId ($sessionId) {
74 // Set invalid ip:port combination
75 $recipient = 'invalid:invalid';
77 // Now get a search criteria instance
78 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
80 // Search for the node number zero which is hard-coded the default
81 $searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_SESSION_ID, 1);
82 $searchInstance->setLimit(1);
85 $resultInstance = $this->doSelectByCriteria($searchInstance);
88 if ($resultInstance->next()) {
89 // Save the result instance in this class
90 $this->setResultInstance($resultInstance);
92 // Get the node id from result and set it
93 $recipient = $this->getField(NodeListDatabaseWrapper::DB_COLUMN_NODE_IP_PORT);