3 * A hub-cruncher class for the 'Cruncher' mode
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class HubMcryptCruncher extends BaseHubCruncher implements CruncherHelper, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this hub-cruncher class
38 * @param $requestInstance An instance of a Requestable class
39 * @return $cruncherInstance An instance of this hub-cruncher class
41 public final static function createHubMcryptCruncher (Requestable $requestInstance) {
43 $cruncherInstance = new HubMcryptCruncher();
45 // Set the request instance
46 $cruncherInstance->setRequestInstance($requestInstance);
48 // Return the instance
49 return $cruncherInstance;
53 * Method to "bootstrap" the cruncher. This step does also apply provided
54 * command-line arguments stored in the request instance. The regular cruncher
55 * should communicate with the bootstrap-crunchers at this point.
58 * @todo Implement this method
60 public function doBootstrapping () {
61 // Call generic (parent) bootstrapping method first
62 parent::doGenericBootstrapping();
63 $this->partialStub('Please implement this method.');
67 * Outputs the console teaser. This should only be executed on startup or
68 * full restarts. This method generates some space around the teaser.
72 public function outputConsoleTeaser () {
73 $this->partialStub('Please implement this method.');
77 * Add some cruncher-specific filters
81 public function addExtraHubFilters () {
82 // Add some filters here