application/hub/main/visitor/pool/shutdown/class_ShutdownListenerPoolVisitor.php

   1 <?php
   2 /**
   3  * A ListenerPool shutdown visitor
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub 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 ShutdownListenerPoolVisitor extends BaseVisitor implements PoolVisitor {
  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('shutdown');
  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 createShutdownListenerPoolVisitor () {
  44                 // Get new instance
  45                 $visitorInstance = new ShutdownListenerPoolVisitor();
  46
  47                 // Return the prepared instance
  48                 return $visitorInstance;
  49         }
  50
  51         /**
  52          * Visits the given pool instance
  53          *
  54          * @param       $poolInstance   A Poolable instance
  55          * @return      void
  56          */
  57         public function visitPool (Poolable $poolInstance) {
  58                 // Debug message
  59                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $poolInstance->__toString() . ' - START');
  60
  61                 // Pre-shutdown the pool
  62                 $poolInstance->preShutdown();
  63
  64                 // Debug message
  65                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $poolInstance->__toString() . ' - FINISHED');
  66         }
  67
  68         /**
  69          * Visits the given decorator instance
  70          *
  71          * @param       $decoratorInstance      A Listenable decorator instance
  72          * @return      void
  73          */
  74         public function visitDecorator (Listenable $decoratorInstance) {
  75                 // Debug message
  76                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $decoratorInstance->__toString() . ' - START');
  77
  78                 // Pre-shutdown the pool
  79                 $decoratorInstance->doShutdown();
  80
  81                 // Debug message
  82                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $decoratorInstance->__toString() . ' - FINISHED');
  83         }
  84
  85         /**
  86          * Visits the given listener instance
  87          *
  88          * @param       $listenerInstance       A Listenable class instance
  89          * @return      void
  90          */
  91         public function visitListener (Listenable $listenerInstance) {
  92                 // Debug message
  93                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $listenerInstance->__toString() . ' - START');
  94
  95                 // Pre-shutdown the pool
  96                 $listenerInstance->doShutdown();
  97
  98                 // Debug message
  99                 self::createDebugInstance(__CLASS__)->debugOutput('VISITOR: Visit of ' . $listenerInstance->__toString() . ' - FINISHED');
 100         }
 101 }
 102
 103 //
 104 ?>