application/hub/main/visitor/tasks/class_ActiveTaskVisitor.php

   1 <?php
   2 /**
   3  * An ActiveTask visitor
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub 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 ActiveTaskVisitor extends BaseVisitor implements TaskVisitor, QueryConnectorVisitor, PoolVisitor, ListenerVisitor, DecoratorVisitor {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set visitor mode
  35                 $this->setVisitorMode('task');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @return      $visitorInstance                An instance a Visitorable class
  42          */
  43         public final static function createActiveTaskVisitor () {
  44                 // Get new instance
  45                 $visitorInstance = new ActiveTaskVisitor();
  46
  47                 // Return the prepared instance
  48                 return $visitorInstance;
  49         }
  50
  51         /**
  52          * Visits the given task instance
  53          *
  54          * @param       $taskInstance   A Taskable instance
  55          * @return      void
  56          */
  57         public function visitTask (Taskable $taskInstance) {
  58                 // Execute the task from this visitor
  59                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting task ' . $taskInstance->__toString() . ' - START');
  60                 $taskInstance->executeTask();
  61                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting task ' . $taskInstance->__toString() . ' - FINISHED');
  62         }
  63
  64         /**
  65          * Connector visitor method for active tasks
  66          *
  67          * @param       $connectorInstance      A Connectable instance
  68          * @return      void
  69          */
  70         public function visitQueryConnector (Connectable $connectorInstance) {
  71                 // Process all pending queries
  72                 $connectorInstance->handlePendingQueries();
  73         }
  74
  75         /**
  76          * Pool visitor method for active tasks
  77          *
  78          * @param       $poolInstance   A Poolable instance
  79          * @return      void
  80          */
  81         public function visitPool (Poolable $poolInstance) {
  82                 /**
  83                  * We don't need to visit a pool as an active task because a pool can
  84                  * never become a task. Instead e.g. by a listener pool we should visit
  85                  * all listeners one by one
  86                  */
  87         }
  88
  89         /**
  90          * Query visitor method for active queries
  91          *
  92          * @param       $queryInstance  A Queryable instance
  93          * @return      void
  94          * @todo        Does a query needs to perform some actions as an active task?
  95          */
  96         public function visitQuery (Queryable $queryInstance) {
  97                 // Empty for now...
  98         }
  99
 100         /**
 101          * Visits the given listener instance
 102          *
 103          * @param       $listenerInstance       A Listenable instance
 104          * @return      void
 105          */
 106         public function visitListener (Listenable $listenerInstance) {
 107                 // Do "listen" here
 108                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - START');
 109                 $listenerInstance->doListen();
 110                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
 111         }
 112
 113         /**
 114          * Visits the given decorator instance
 115          *
 116          * @param       $decoratorInstance      A decorator instance
 117          * @return      void
 118          */
 119         public function visitDecorator (BaseDecorator $decoratorInstance) {
 120                 // A decorator itself can never become an active task so this method
 121                 // remains empty.
 122         }
 123 }
 124
 125 // [EOF]
 126 ?>