More renamed

[shipsimu.git] / application / ship-simu / main / wrapper / class_CompanyDatabaseWrapper.php

diff --git a/application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php b/application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php
index d403d18b8530d0646719b9a5f2e1d318a2895184..1552e67462bb1e0692d12719c15e391695326bac 100644 (file)
--- a/application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php
+++ b/application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php
@@ -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
@@ -22,8 +22,17 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
+       /**
+        * Company instance
+        */
+       private $companyInstance = null;
+
        // Constants for database tables
-       const DB_TABLE_COMPANY = "company";
+       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
@@ -33,29 +42,87 @@ 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();
        }
 
        /**
         * Creates an instance of this wrapper class
         *
+        * @param       $companyInstance        An instance of a generic company class or null if no specific
         * @return      $wrapperInstance        An instance of this wrapper class
+        * @todo        Find an interface which is suitable for all companies
         */
-       public final static function createCompanyDatabaseWrapper () {
+       public static final function createCompanyDatabaseWrapper (ShippingCompany $companyInstance = null) {
                // Create a new instance
                $wrapperInstance = new CompanyDatabaseWrapper();
 
                // Set (primary!) table name
-               $wrapperInstance->setTableName(self::DB_TABLE_COMPANY);
+               $wrapperInstance->setTableName(self::DB_TABLE_COMPANY_DATA);
+
+               // Set the company instance if not null
+               if (!is_null($companyInstance)) {
+                       $wrapperInstance->setCompanyInstance($companyInstance);
+               } // END - if
 
                // Return the instance
                return $wrapperInstance;
        }
+
+       /**
+        * Checks wether the given user participates in a company
+        *
+        * @param       $userInstance   An instance of a user class
+        * @return      $participates   Wether the user participates at lease in one company
+        */
+       public function ifUserParticipatesInCompany (ManageableAccount $userInstance)  {
+               // By default no user owns any company... ;)
+               $participates = false;
+
+               // Get a search criteria class
+               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+
+               // Add the user primary key as a search criteria
+               $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($searchInstance);
+
+               // Is there a result?
+               if ($resultInstance->next()) {
+                       // Then cache it
+                       $this->setResultInstance($resultInstance);
+
+                       // Entry found for further analysis/processing
+                       $participates = true;
+               } // END - if
+
+               // Return the result
+               return $participates;
+       }
+
+       /**
+        * Setter for company instance
+        *
+        * @param       $companyInstance        An instance of a generic company
+        * @return      void
+        * @todo        Find an interface suitable for all types of companies
+        */
+       protected final function setCompanyInstance (ShippingCompany $companyInstance) {
+               $this->companyInstance = $companyInstance;
+       }
+
+       /**
+        * Getter for company instance
+        *
+        * @return      $companyInstance        An instance of a generic company
+        * @todo        Find an interface suitable for all types of companies
+        */
+       public final function getCompanyInstance () {
+               return $this->companyInstance;
+       }
 }
 
 // [EOF]