application/hub/classes/crawler/class_

   1 <?php
   2 /**
   3  * A node ??? crawler
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014 Crawler 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 Node???Crawler extends BaseNodeCrawler implements Crawler {
  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      $crawlerInstance        An instance of a Crawler class
  39          */
  40         public final static function createNode???Crawler () {
  41                 // Get new instance
  42                 $crawlerInstance = new Node???Crawler();
  43
  44                 // Return the prepared instance
  45                 return $crawlerInstance;
  46         }
  47
  48         /**
  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().
  52          *
  53          * @return      void
  54          */
  55         public function doBootstrapping () {
  56                 $this->partialStub('Please implement this method.');
  57         }
  58
  59         /**
  60          * Outputs the console teaser. This should only be executed on startup or
  61          * full restarts. This method generates some space around the teaser.
  62          *
  63          * @return      void
  64          */
  65         public function outputConsoleTeaser () {
  66                 $this->partialStub('Please implement this method.');
  67         }
  68
  69         /**
  70          * Add some crawler-specific filters
  71          *
  72          * @param       $controllerInstance             An object of a Controller instance
  73          * @param       $responseInstance               An object of a Responseable instance
  74          * @return      void
  75          */
  76         public function addExtraFilters (Controller $controllerInstance, Responseable $responseInstance) {
  77                 $this->partialStub('Please implement this method.');
  78         }
  79 }
  80
  81 // [EOF]
  82 ?>