More game classes added:
[shipsimu.git] / application / ship-simu / main / wrapper / class_CompanyDatabaseWrapper.php
index b49b1d050c4a56c4038baac528721ec8d7127803..3f2ade62de02f73412f05700eef376130a5a0075 100644 (file)
  * 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_DATA = "company";
        const DB_TABLE_COMPANY_USER = "company_user";
@@ -45,15 +50,22 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
        /**
         * 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 final static function createCompanyDatabaseWrapper (ShippingCompany $companyInstance = null) {
                // Create a new instance
                $wrapperInstance = new CompanyDatabaseWrapper();
 
                // Set (primary!) table name
                $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;
        }
@@ -64,7 +76,7 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
         * @param       $userInstance   An instance of a user class
         * @return      $participates   Wether the user participates at lease in one company
         */
-       public function ifUserParticipatesInCompany (BaseUser $userInstance)  {
+       public function ifUserParticipatesInCompany (ManageableAccount $userInstance)  {
                // By default no user owns any company... ;)
                $participates = false;
 
@@ -93,6 +105,27 @@ class CompanyDatabaseWrapper extends BaseDatabaseWrapper {
                // 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]