Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / inc / main / classes / visitor / tasks / class_ActiveTaskVisitor.php
1 <?php
2 /**
3  * An ActiveTask visitor
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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, 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 static final 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: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting task ' . $taskInstance->__toString() . ' - CALLED!');
60                 $taskInstance->executeTask();
61                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting task ' . $taskInstance->__toString() . ' - EXIT!');
62         }
63
64         /**
65          * Pool visitor method for active tasks
66          *
67          * @param       $poolInstance   A Poolable instance
68          * @return      void
69          */
70         public function visitPool (Poolable $poolInstance) {
71                 /**
72                  * We don't need to visit a pool as an active task because a pool can
73                  * never become a task. Instead e.g. by a listener pool we should visit
74                  * all listeners one by one
75                  */
76         }
77
78         /**
79          * Visits the given listener instance
80          *
81          * @param       $listenerInstance       A Listenable instance
82          * @return      void
83          */
84         public function visitListener (Listenable $listenerInstance) {
85                 // Do "listen" here
86                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - CALLED!');
87                 $listenerInstance->doListen();
88                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ' ]: Visiting ' . $listenerInstance->__toString() . ' - FINISH');
89         }
90
91         /**
92          * Visits the given decorator instance
93          *
94          * @param       $decoratorInstance      A decorator instance
95          * @return      void
96          */
97         public function visitDecorator (BaseDecorator $decoratorInstance) {
98                 // A decorator itself can never become an active task so this method
99                 // remains empty.
100         }
101
102 }