framework/main/classes/tasks/class_

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