application/hub/main/database/wrapper/class_NodeInformationDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for node informations
   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 NodeInformationDatabaseWrapper extends BaseDatabaseWrapper {
  25         // Constants for database table names
  26         const DB_TABLE_NODE_INFORMATION = 'node_data';
  27
  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';
  33
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Creates an instance of this database wrapper by a provided user class
  46          *
  47          * @return      $wrapperInstance        An instance of the created wrapper class
  48          */
  49         public static final function createNodeInformationDatabaseWrapper () {
  50                 // Get a new instance
  51                 $wrapperInstance = new NodeInformationDatabaseWrapper();
  52
  53                 // Set (primary!) table name
  54                 $wrapperInstance->setTableName(self::DB_TABLE_NODE_INFORMATION);
  55
  56                 // Return the instance
  57                 return $wrapperInstance;
  58         }
  59
  60         /**
  61          * Getter for index key
  62          *
  63          * @return      $indexKey       Index key
  64          */
  65         public final function getIndexKey () {
  66                 return $this->getDatabaseInstance()->getIndexKey();
  67         }
  68
  69         /**
  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...
  72          *
  73          * @param       $nodeInstance           A node instance
  74          * @param       $requestInstance        An instance of a Requestable class
  75          * @return      void
  76          */
  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));
  80
  81                 // Set the primary key
  82                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
  83
  84                 // Add registration elements to the dataset
  85                 $nodeInstance->addElementsToDataSet($dataSetInstance, $requestInstance);
  86
  87                 // "Insert" this request instance completely into the database
  88                 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
  89         }
  90
  91         /**
  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...
  94          *
  95          * @param       $nodeInstance           A node instance
  96          * @param       $requestInstance        An instance of a Requestable class
  97          * @return      void
  98          */
  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));
 102
 103                 // Set the primary key
 104                 $dataSetInstance->setUniqueKey(self::DB_COLUMN_NODE_ID);
 105
 106                 // Add registration elements to the dataset
 107                 $nodeInstance->addElementsToDataSet($dataSetInstance, $requestInstance);
 108
 109                 // "Insert" this request instance completely into the database
 110                 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
 111         }
 112 }
 113
 114 // [EOF]
 115 ?>