git.mxchange.org Git - hub.git/blob

   1 <?php
   2 // Own namespace
   3 namespace Org\Shipsimu\Hub\Crawler\Task\Scanner\UploadedList;
   4
   5 // Import application-specific stuff
   6 use Org\Shipsimu\Hub\Factory\Scanner\ScannerObjectFactory;
   7
   8 // Import framework stuff
   9 use Org\Mxchange\CoreFramework\Task\BaseTask;
  10 use Org\Mxchange\CoreFramework\Task\Taskable;
  11 use Org\Mxchange\CoreFramework\Visitor\Visitable;
  12 use Org\Mxchange\CoreFramework\Visitor\Visitor;
  13
  14 /**
  15  * A UploadedList scanner task for crawlers
  16  *
  17  * @author              Roland Haeder <webmaster@ship-simu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2014 Crawler Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.ship-simu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class CrawlerUploadedListScannerTask extends BaseTask implements Taskable, Visitable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this class
  49          *
  50          * @return      $taskInstance   An instance of a Visitable class
  51          */
  52         public final static function createCrawlerUploadedListScannerTask () {
  53                 // Get new instance
  54                 $taskInstance = new CrawlerUploadedListScannerTask();
  55
  56                 // Return the prepared instance
  57                 return $taskInstance;
  58         }
  59
  60         /**
  61          * Accepts the visitor to process the visitor
  62          *
  63          * @param       $visitorInstance        An instance of a Visitor class
  64          * @return      void
  65          * @todo        Maybe visit some sub-objects
  66          */
  67         public function accept (Visitor $visitorInstance) {
  68                 // Visit this task
  69                 $visitorInstance->visitTask($this);
  70         }
  71
  72         /**
  73          * Executes the task
  74          *
  75          * @return      void
  76          */
  77         public function executeTask () {
  78                 // Call factory for a scanner instance and execute it
  79                 ScannerObjectFactory::createScannerInstance($this)->execute();
  80         }
  81
  82         /**
  83          * Shuts down the task
  84          *
  85          * @return      void
  86          * @todo        0% done
  87          */
  88         public function doShutdown () {
  89                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('CRAWLER-UPLOADED-LIST-SCANNER-TASK: Shutting down...');
  90         }
  91
  92 }