application/hub/classes/database/frontend/cruncher/class_CruncherUnitDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for cruncher work/test units
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2011 - 2014 Cruncher Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 CruncherUnitDatabaseWrapper extends BaseDatabaseWrapper implements UnitDatabaseWrapper, Registerable {
  25         // Constants for database table names
  26         const DB_TABLE_CRUNCHER_UNITS = 'cruncher_units';
  27
  28         // Constants for database column names
  29         const DB_COLUMN_UNIT_TYPE   = 'unit_type';
  30         const DB_COLUMN_UNIT_STATUS = 'unit_status';
  31
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this database wrapper by a provided user class
  44          *
  45          * @return      $wrapperInstance        An instance of the created wrapper class
  46          */
  47         public static final function createCruncherUnitDatabaseWrapper () {
  48                 // Get a new instance
  49                 $wrapperInstance = new CruncherUnitDatabaseWrapper();
  50
  51                 // Set (primary!) table name
  52                 $wrapperInstance->setTableName(self::DB_TABLE_CRUNCHER_UNITS);
  53
  54                 // Return the instance
  55                 return $wrapperInstance;
  56         }
  57
  58         /**
  59          * Checks whether a test unit has been produced
  60          *
  61          * @return      $isProduced             Whether a test unit has already been produced
  62          */
  63         public function isTestUnitProduced () {
  64                 // Now get a search instance
  65                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  66
  67                 // Add criteria for looking up already created and available test units
  68                 $searchInstance->addCriteria(self::DB_COLUMN_UNIT_TYPE  , BaseUnitProducer::UNIT_TYPE_TEST_UNIT);
  69                 $searchInstance->addCriteria(self::DB_COLUMN_UNIT_STATUS, BaseUnitProducer::UNIT_STATUS_AVAILABLE);
  70                 $searchInstance->setConfiguredLimit('cruncher_test_unit_max_count');
  71
  72                 // Search for our units
  73                 $resultInstance = $this->doSelectByCriteria($searchInstance);
  74
  75                 // Do we have some entries?
  76                 $isProduced = $resultInstance->next();
  77
  78                 // Return it
  79                 return $isProduced;
  80         }
  81 }
  82
  83 // [EOF]
  84 ?>