application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A wrapper for database access to shipping company data
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   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 CompanyDatabaseWrapper extends BaseDatabaseWrapper {
  25         // Constants for database tables
  26         const DB_TABLE_COMPANY = "company";
  27
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36
  37                 // Set part description
  38                 $this->setObjectDescription("A wrapper for database access to company data");
  39
  40                 // Create unique ID number
  41                 $this->generateUniqueId();
  42         }
  43
  44         /**
  45          * Creates an instance of this wrapper class
  46          *
  47          * @return      $wrapperInstance        An instance of this wrapper class
  48          */
  49         public final static function createCompanyDatabaseWrapper () {
  50                 // Create a new instance
  51                 $wrapperInstance = new CompanyDatabaseWrapper();
  52
  53                 // Set (primary!) table name
  54                 $wrapperInstance->setTableName(self::DB_TABLE_COMPANY);
  55
  56                 // Return the instance
  57                 return $wrapperInstance;
  58         }
  59 }
  60
  61 // [EOF]
  62 ?>