3 * An ActiveTask visitor
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class ActiveTaskVisitor extends BaseVisitor implements TaskVisitor, QueryConnectorVisitor, QueueConnectorVisitor, PoolVisitor, ListenerVisitor, DecoratorVisitor {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setVisitorMode('task');
39 * Creates an instance of this class
41 * @return $visitorInstance An instance a Visitorable class
43 public static final function createActiveTaskVisitor () {
45 $visitorInstance = new ActiveTaskVisitor();
47 // Return the prepared instance
48 return $visitorInstance;
52 * Visits the given task instance
54 * @param $taskInstance A Taskable instance
57 public function visitTask (Taskable $taskInstance) {
58 // Execute the task from this visitor
59 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visiting task ' . $taskInstance->__toString() . ' - START');
60 $taskInstance->executeTask();
61 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visiting task ' . $taskInstance->__toString() . ' - FINISHED');
65 * Connector visitor method for active tasks
67 * @param $connectorInstance A Connectable instance
70 public function visitQueryConnector (Connectable $connectorInstance) {
71 // Process all pending queries
72 $connectorInstance->handlePending();
76 * Connector visitor method for active tasks
78 * @param $connectorInstance A Connectable instance
81 public function visitQueueConnector (Connectable $connectorInstance) {
82 // Process all pending queries
83 $connectorInstance->handlePending();
87 * Pool visitor method for active tasks
89 * @param $poolInstance A Poolable instance
92 public function visitPool (Poolable $poolInstance) {
94 * We don't need to visit a pool as an active task because a pool can
95 * never become a task. Instead e.g. by a listener pool we should visit
96 * all listeners one by one
101 * Query visitor method for active queries
103 * @param $queryInstance A Queryable instance
105 * @todo Does a query needs to perform some actions as an active task?
107 public function visitQuery (Queryable $queryInstance) {
112 * Queue visitor method for active queries
114 * @param $queueInstance A Queueable instance
116 * @todo Does a queue needs to perform some actions as an active task?
118 public function visitQueue (Queueable $queueInstance) {
123 * Visits the given listener instance
125 * @param $listenerInstance A Listenable instance
128 public function visitListener (Listenable $listenerInstance) {
130 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - START');
131 $listenerInstance->doListen();
132 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
136 * Visits the given decorator instance
138 * @param $decoratorInstance A decorator instance
141 public function visitDecorator (BaseDecorator $decoratorInstance) {
142 // A decorator itself can never become an active task so this method