application/hub/main/helper/work_units/cruncher/class_CruncherTestUnitHelper.php

   1 <?php
   2 /**
   3  * A test unit helper for cruncher
   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 CruncherTestUnitHelper extends BaseWorkUnitHelper implements UnitHelper {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @return      $unitInstance   An instance of a UnitHelper class
  39          */
  40         public final static function createCruncherTestUnitHelper () {
  41                 // Get new instance
  42                 $unitInstance = new CruncherTestUnitHelper();
  43
  44                 // Return the prepared instance
  45                 return $unitInstance;
  46         }
  47
  48         /**
  49          * Initializes this WU helper. This method satisfies the abstract
  50          * BaseWorkUnitHelper class.
  51          *
  52          * @return      void
  53          * @todo        0% done
  54          */
  55         protected function initializeUnitHelper () {
  56                 $this->partialStub('Please implement this method.');
  57         }
  58
  59         /**
  60          * Generates a work/test/foo unit instance. This method satifies the
  61          * UnitHelper interface.
  62          *
  63          * @return      $unitInstance   A work unit instance
  64          * @todo        0% done
  65          */
  66         public function generateNextUnitInstance () {
  67                 $this->partialStub('Please implement this method.');
  68         }
  69 }
  70
  71 // [EOF]
  72 ?>