application/hub/main/database/wrapper/node/class_NodeListDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for node list
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class NodeListDatabaseWrapper extends BaseDatabaseWrapper implements Registerable {
  25         // Table names
  26         const DB_TABLE_NODE_LIST = 'node_list';
  27
  28         // Constants for column name
  29         const DB_COLUMN_NODE_SESSION_ID = 'node_session_id';
  30         const DB_COLUMN_NODE_IP_PORT    = 'node_ipport';
  31
  32         // Other constants
  33         const INVALID_IP_PORT = 'invalid:invalid';
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this database wrapper by a provided user class
  47          *
  48          * @return      $wrapperInstance        An instance of the created wrapper class
  49          */
  50         public static final function createNodeListDatabaseWrapper () {
  51                 // Get a new instance
  52                 $wrapperInstance = new NodeListDatabaseWrapper();
  53
  54                 // Set (primary!) table name
  55                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_LIST);
  56
  57                 // Return the instance
  58                 return $wrapperInstance;
  59         }
  60
  61         /**
  62          * Getter for index key
  63          *
  64          * @return      $indexKey       Index key
  65          */
  66         public final function getIndexKey () {
  67                 return $this->getDatabaseInstance()->getIndexKey();
  68         }
  69
  70         /**
  71          * Resolves a session id into an ip:port combination
  72          *
  73          * @param       $sessionId      A valid session id
  74          * @return      $recipient      Recipient as ip:port combination
  75          */
  76         public function resolveIpPortBySessionId ($sessionId) {
  77                 // Set invalid ip:port combination
  78                 $recipient = self::INVALID_IP_PORT;
  79
  80                 // Now get a search criteria instance
  81                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  82
  83                 // Search for the node number zero which is hard-coded the default
  84                 $searchInstance->addCriteria(NodeListDatabaseWrapper::DB_COLUMN_NODE_SESSION_ID, 1);
  85                 $searchInstance->setLimit(1);
  86
  87                 // Get a result back
  88                 $resultInstance = $this->doSelectByCriteria($searchInstance);
  89
  90                 // Is it valid?
  91                 if ($resultInstance->next()) {
  92                         // Save the result instance in this class
  93                         $this->setResultInstance($resultInstance);
  94
  95                         // Get the node id from result and set it
  96                         $recipient = $this->getField(NodeListDatabaseWrapper::DB_COLUMN_NODE_IP_PORT);
  97                 } // END - if
  98
  99                 // Return result
 100                 return $recipient;
 101         }
 102 }
 103
 104 // [EOF]
 105 ?>