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

   1 <?php
   2 /**
   3  * An ShutdownTask 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 ShutdownTaskVisitor extends BaseVisitor implements TaskVisitor, QueryConnectorVisitor, QueueConnectorVisitor, 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 createShutdownTaskVisitor () {
  44                 // Get new instance
  45                 $visitorInstance = new ShutdownTaskVisitor();
  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                 // Shutdown the task instance
  59                 $taskInstance->doShutdown();
  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                 // Shutdown the connector instance
  70                 $connectorInstance->doShutdown();
  71         }
  72
  73         /**
  74          * Connector visitor method for active tasks
  75          *
  76          * @param       $connectorInstance      A Connectable instance
  77          * @return      void
  78          */
  79         public function visitQueueConnector (Connectable $connectorInstance) {
  80                 // Shutdown the connector instance
  81                 $connectorInstance->doShutdown();
  82         }
  83
  84         /**
  85          * Pool visitor method for active tasks
  86          *
  87          * @param       $poolInstance   A Poolable instance
  88          * @return      void
  89          */
  90         public function visitPool (Poolable $poolInstance) {
  91                 // Shutdown the pool instance
  92                 $poolInstance->doShutdown();
  93         }
  94
  95         /**
  96          * Query visitor method for active queries
  97          *
  98          * @param       $queryInstance  A Queryable instance
  99          * @return      void
 100          * @todo        Does a query needs to perform some actions as an active task?
 101          */
 102         public function visitQuery (Queryable $queryInstance) {
 103                 // Shutdown the query instance
 104                 $queryInstance->doShutdown();
 105         }
 106
 107         /**
 108          * Queue visitor method for active queries
 109          *
 110          * @param       $queueInstance  A Queueable instance
 111          * @return      void
 112          * @todo        Does a queue needs to perform some actions as an active task?
 113          */
 114         public function visitQueue (Queueable $queueInstance) {
 115                 // Shutdown the queue instance
 116                 $queueInstance->doShutdown();
 117         }
 118
 119         /**
 120          * Visits the given listener instance
 121          *
 122          * @param       $listenerInstance       A Listenable instance
 123          * @return      void
 124          */
 125         public function visitListener (Listenable $listenerInstance) {
 126                 // Shutdown the listener instance
 127                 $listenerInstance->doShutdown();
 128         }
 129
 130         /**
 131          * Visits the given decorator instance
 132          *
 133          * @param       $decoratorInstance      A decorator instance
 134          * @return      void
 135          */
 136         public function visitDecorator (BaseDecorator $decoratorInstance) {
 137                 // Shutdown the decorator instance
 138                 $decoratorInstance->doShutdown();
 139         }
 140 }
 141
 142 // [EOF]
 143 ?>