application/hub/main/handler/tasks/class_TaskHandler.php

   1 <?php
   2 /**
   3  * A Task handler
   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 TaskHandler extends BaseHandler implements Registerable, HandleableTask {
  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          * @return      $handlerInstance        An instance of a HandleableTask class
  39          */
  40         public final static function createTaskHandler () {
  41                 // Get new instance
  42                 $handlerInstance = new TaskHandler();
  43
  44                 // Output debug message
  45                 $handlerInstance->debugOutput('TASK-HANDLER: Task handler initialized.');
  46
  47                 // Return the prepared instance
  48                 return $handlerInstance;
  49         }
  50
  51         /**
  52          * Registers a task with a task handler. This method throws a
  53          * TaskAlreadyRegisteredException if the task has already been registered
  54          *
  55          * @param       $taskName               A task name to register the task on
  56          * @param       $taskInstance   The instance we should register as a task
  57          * @return      void
  58          * @throws      TaskAlreadyRegisteredException  If the task is already registered
  59          */
  60         public function registerTask ($taskName, Visitable $taskInstance) {
  61                 $this->partialStub('taskName=' . $taskName . '/' . $taskInstance->__toString());
  62         }
  63 }
  64
  65 // [EOF]
  66 ?>