More renamed
[shipsimu.git] / application / ship-simu / main / wrapper / class_CompanyDatabaseWrapper.php
index 3f2ade62de02f73412f05700eef376130a5a0075..1552e67462bb1e0692d12719c15e391695326bac 100644 (file)
@@ -2,11 +2,11 @@
 /**
  * A wrapper for database access to shipping company data
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -28,8 +28,11 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
        private $companyInstance = null;
 
        // Constants for database tables
-       const DB_TABLE_COMPANY_DATA = "company";
-       const DB_TABLE_COMPANY_USER = "company_user";
+       const DB_TABLE_COMPANY_DATA = 'company';
+       const DB_TABLE_COMPANY_USER = 'company_user';
+
+       // Constants for database columns
+       const DB_COLUMN_PARTICIPANT_ID = 'participant_id';
 
        /**
         * Protected constructor
@@ -39,12 +42,6 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Set part description
-               $this->setObjectDescription("A wrapper for database access to company data");
-
-               // Create unique ID number
-               $this->generateUniqueId();
        }
 
        /**
@@ -54,7 +51,7 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
         * @return      $wrapperInstance        An instance of this wrapper class
         * @todo        Find an interface which is suitable for all companies
         */
-       public final static function createCompanyDatabaseWrapper (ShippingCompany $companyInstance = null) {
+       public static final function createCompanyDatabaseWrapper (ShippingCompany $companyInstance = null) {
                // Create a new instance
                $wrapperInstance = new CompanyDatabaseWrapper();
 
@@ -81,17 +78,17 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
                $participates = false;
 
                // Get a search criteria class
-               $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
 
                // Add the user primary key as a search criteria
-               $criteriaInstance->addCriteria('participant_id', $userInstance->getPrimaryKey());
-               $criteriaInstance->setLimit(1);
+               $searchInstance->addCriteria(self::DB_COLUMN_PARTICIPANT_ID, $userInstance->getPrimaryKey());
+               $searchInstance->setLimit(1);
 
                // Set company->user table
                $this->setTableName(self::DB_TABLE_COMPANY_USER);
 
                // Get the result back
-               $resultInstance = $this->doSelectByCriteria($criteriaInstance);
+               $resultInstance = $this->doSelectByCriteria($searchInstance);
 
                // Is there a result?
                if ($resultInstance->next()) {