3 * A node console crawler
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2014 Crawler Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 NodeConsoleCrawler extends BaseNodeCrawler implements Crawler, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $crawlerInstance An instance of a Crawler class
40 public final static function createNodeConsoleCrawler () {
42 $crawlerInstance = new NodeConsoleCrawler();
44 // Return the prepared instance
45 return $crawlerInstance;
49 * Method to "bootstrap" the crawler. This step does also apply provided
50 * command-line arguments stored in the request instance. You should now
51 * get it from calling $this->getRequestInstance().
55 public function doBootstrapping () {
56 $this->partialStub('Please implement this method.');
60 * Outputs the console teaser. This should only be executed on startup or
61 * full restarts. This method generates some space around the teaser.
65 public function outputConsoleTeaser () {
66 // Get the app instance (for shortening our code)
67 $app = $this->getApplicationInstance();
70 self::createDebugInstance(__CLASS__)->debugOutput(' ');
71 self::createDebugInstance(__CLASS__)->debugOutput('Distributed Crawler v' . $app->getAppVersion());
72 self::createDebugInstance(__CLASS__)->debugOutput('Copyright (c) 2014 Crawler Developer Team');
73 self::createDebugInstance(__CLASS__)->debugOutput(' ');
74 self::createDebugInstance(__CLASS__)->debugOutput('This program comes with ABSOLUTELY NO WARRANTY; for details see docs/COPYING.');
75 self::createDebugInstance(__CLASS__)->debugOutput('This is free software, and you are welcome to redistribute it under certain');
76 self::createDebugInstance(__CLASS__)->debugOutput('conditions; see docs/COPYING for details.');
77 self::createDebugInstance(__CLASS__)->debugOutput(' ');
81 * Add some crawler-specific filters
83 * @param $controllerInstance An object of a Controller instance
84 * @param $responseInstance An object of a Responseable instance
87 public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
88 $this->partialStub('Please implement this method.');