application/hub/main/producer/cruncher/work_units/class_CruncherTestUnitProducer.php

   1 <?php
   2 /**
   3  * A CruncherTestUnit producer class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 CruncherTestUnitProducer extends BaseProducer implements UnitProducer, Registerable {
  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      $producerInstance       An instance of a Producer class
  39          */
  40         public final static function createCruncherTestUnitProducer () {
  41                 // Get new instance
  42                 $producerInstance = new CruncherTestUnitProducer();
  43
  44                 // Return the prepared instance
  45                 return $producerInstance;
  46         }
  47
  48         /**
  49          * Initializes the producer. This method satisfies the abstract BaseProducer
  50          * class.
  51          *
  52          * @return      void
  53          */
  54         protected function initProducer () {
  55                 // Get a XML template instance
  56                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('cruncher_test_unit_producer_template_class');
  57
  58                 // Load the template
  59                 $templateInstance->loadCruncherTestUnitTemplate('test_unit');
  60
  61                 // Render the XML content
  62                 $templateInstance->renderXmlContent();
  63
  64                 // And set it in this cruncher
  65                 $this->setTemplateInstance($templateInstance);
  66         }
  67
  68         /**
  69          * Produces some work/test units and pushes them onto the queue
  70          *
  71          * @return      void
  72          * @todo        0% done
  73          */
  74         public function produceUnits () {
  75                 $this->partialStub('Please implement this method.');
  76         }
  77 }
  78
  79 // [EOF]
  80 ?>