application/hub/classes/cruncher/class_

   1 <?php
   2 /**
   3  * A hub-cruncher class for the '???' mode
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2011 - 2012 Cruncher 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 Hub???Cruncher extends BaseHubCruncher implements CruncherHelper, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set version number
  35                 $this->setVersion('x.x');
  36         }
  37
  38         /**
  39          * Creates an instance of this hub-cruncher class
  40          *
  41          * @param       $requestInstance        An instance of a Requestable class
  42          * @return      $cruncherInstance               An instance of this hub-cruncher class
  43          */
  44         public final static function createHub???Cruncher (Requestable $requestInstance) {
  45                 // Get a new instance
  46                 $cruncherInstance = new Hub???Cruncher();
  47
  48                 // Set the request instance
  49                 $cruncherInstance->setRequestInstance($requestInstance);
  50
  51                 // Return the instance
  52                 return $cruncherInstance;
  53         }
  54
  55         /**
  56          * Method to "bootstrap" the cruncher. This step does also apply provided
  57          * command-line arguments stored in the request instance. The regular cruncher
  58          * should communicate with the bootstrap-crunchers at this point.
  59          *
  60          * @return      void
  61          * @todo        Implement this method
  62          */
  63         public function doBootstrapping () {
  64                 // Call generic (parent) bootstrapping method first
  65                 parent::doGenericBootstrapping();
  66                 $this->partialStub('Please implement this method.');
  67         }
  68
  69         /**
  70          * Outputs the console teaser. This should only be executed on startup or
  71          * full restarts. This method generates some space around the teaser.
  72          *
  73          * @return      void
  74          */
  75         public function outputConsoleTeaser () {
  76                 $this->partialStub('Please implement this method.');
  77         }
  78
  79         /**
  80          * Add some cruncher-specific filters
  81          *
  82          * @return      void
  83          */
  84         public function addExtraHubFilters () {
  85                 // Add some filters here
  86         }
  87 }
  88
  89 // [EOF]
  90 ?>