framework/main/classes/tasks/class_

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