application/hub/main/tasks/hub/ping/class_HubPingTask.php

   1 <?php
   2 /**
   3  * A HubPing task
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 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 HubPingTask extends BaseTask implements Visitable, Taskable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this class
  37          *
  38          * @param       $listInstance   A Listable instance
  39          * @return      $taskInstance   An instance of a Visitable class
  40          */
  41         public final static function createHubPingTask (Listable $listInstance) {
  42                 // Get new instance
  43                 $taskInstance = new HubPingTask();
  44
  45                 // Se the list instance in this task
  46                 $taskInstance->setListInstance($listInstance);
  47
  48                 // Init ping iterator instance
  49                 $iteratorInstance = ObjectFactory::createObjectByConfiguredName('hub_ping_iterator_class', array($listInstance));
  50
  51                 // Set it as well
  52                 $taskInstance->setIteratorInstance($iteratorInstance);
  53
  54                 // Return the prepared instance
  55                 return $taskInstance;
  56         }
  57
  58         /**
  59          * Accepts the visitor to rpocess the visit "request"
  60          *
  61          * @param       $visitorInstance        An instance of a Visitor class
  62          * @return      void
  63          * @todo        0%
  64          */
  65         public function accept (Visitor $visitorInstance) {
  66                 $this->partialStub('Please implement this method. visitor='.$visitorInstance->__toString());
  67         }
  68
  69         /**
  70          * Executes the task
  71          *
  72          * @return      void
  73          */
  74         public function execute () {
  75                 $this->partialStub('Unimplemented task.');
  76         }
  77 }
  78
  79 // [EOF]
  80 ?>