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                 $taskInstance->execute();
  60         }
  61
  62         /**
  63          * Connector visitor method for active tasks
  64          *
  65          * @param       $connectorInstance      A Connectable instance
  66          * @return      void
  67          */
  68         public function visitQueryConnector (Connectable $connectorInstance) {
  69                 // Process all pending queries
  70                 $connectorInstance->handlePendingQueries();
  71         }
  72
  73         /**
  74          * Pool visitor method for active tasks
  75          *
  76          * @param       $poolInstance   A Poolable instance
  77          * @return      void
  78          */
  79         public function visitPool (Poolable $poolInstance) {
  80                 /**
  81                  * We don't need to visit a pool as an active task because a pool can
  82                  * never become a task. Instead e.g. by a listener pool we should visit
  83                  * all listeners one by one
  84                  */
  85         }
  86
  87         /**
  88          * Query visitor method for active queries
  89          *
  90          * @param       $queryInstance  A Queryable instance
  91          * @return      void
  92          * @todo        Does a query needs to perform some actions as an active task?
  93          */
  94         public function visitQuery (Queryable $queryInstance) {
  95                 // Empty for now...
  96         }
  97
  98         /**
  99          * Visits the given listener instance
 100          *
 101          * @param       $listenerInstance       A Listenable instance
 102          * @return      void
 103          */
 104         public function visitListener (Listenable $listenerInstance) {
 105                 // Do "listen" here
 106                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - START');
 107                 $listenerInstance->doListen();
 108                 //* DEBUG: */ $this->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
 109         }
 110
 111         /**
 112          * Visits the given decorator instance
 113          *
 114          * @param       $decoratorInstance      A decorator instance
 115          * @return      void
 116          */
 117         public function visitDecorator (BaseDecorator $decoratorInstance) {
 118                 // A decorator itself can never bevome an active task so this method
 119                 // remains empty.
 120         }
 121 }
 122
 123 // [EOF]
 124 ?>