application/city/classes/visitor/tasks/class_ActiveTaskVisitor.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Visitor\Task\Active;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\BaseDecorator;
   7 use Org\Mxchange\CoreFramework\Task\Taskable;
   8 use Org\Mxchange\CoreFramework\Visitor\BaseVisitor;
   9 use Org\Mxchange\CoreFramework\Visitor\Decorator\DecoratorVisitor;
  10 use Org\Mxchange\CoreFramework\Visitor\Task\TaskVisitor;
  11
  12 /**
  13  * An ActiveTask visitor
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Hub Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.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 ActiveTaskVisitor extends BaseVisitor implements TaskVisitor, DecoratorVisitor {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43
  44                 // Set visitor mode
  45                 $this->setVisitorMode('task');
  46         }
  47
  48         /**
  49          * Creates an instance of this class
  50          *
  51          * @return      $visitorInstance        An instance a Visitorable class
  52          */
  53         public static final function createActiveTaskVisitor () {
  54                 // Get new instance
  55                 $visitorInstance = new ActiveTaskVisitor();
  56
  57                 // Return the prepared instance
  58                 return $visitorInstance;
  59         }
  60
  61         /**
  62          * Visits the given task instance
  63          *
  64          * @param       $taskInstance   A Taskable instance
  65          * @return      void
  66          */
  67         public function visitTask (Taskable $taskInstance) {
  68                 // Execute the task from this visitor
  69                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('ACTIVE-TASK-VISITOR: Visiting task ' . $taskInstance->__toString() . ' - CALLED!');
  70                 $taskInstance->executeTask();
  71                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('ACTIVE-TASK-VISITOR: Visiting task ' . $taskInstance->__toString() . ' - EXIT!');
  72         }
  73
  74         /**
  75          * Visits the given decorator instance
  76          *
  77          * @param       $decoratorInstance      A decorator instance
  78          * @return      void
  79          */
  80         public function visitDecorator (BaseDecorator $decoratorInstance) {
  81                 /*
  82                  * A decorator itself can never become an active task so this method
  83                  * remains empty.
  84                  */
  85                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('ACTIVE-TASK-VISITOR: decoratorInstance=%s - CALLED!', $decoratorInstance->__toString()));
  86         }
  87
  88 }