application/hub/classes/factories/scanner/class_ScannerObjectFactory.php

   1 <?php
   2 /**
   3  * A factory class for scanners
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 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 ScannerObjectFactory extends ObjectFactory {
  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          * Returns a singleton (registry-based) Scanner instance
  37          *
  38          * @param       $taskInstance           An instance of a class with an Taskable interface
  39          * @return      $sourceInstance         An instance of a Scanner class
  40          */
  41         public static final function createScannerInstance (Taskable $taskInstance) {
  42                 // Get new factory instance
  43                 $factoryInstance = new ScannerObjectFactory();
  44
  45                 // Get task handler instance
  46                 $handlerInstance = Registry::getRegistry()->getInstance('task_handler');
  47
  48                 // Get scanner type for given task instance by searching it in task handler
  49                 $scannerType = $handlerInstance->searchTask($taskInstance);
  50
  51                 // Only let registered tasks pass
  52                 assert(!empty($scannerType));
  53
  54                 // If there is no handler?
  55                 if (Registry::getRegistry()->instanceExists('scanner_' . $scannerType)) {
  56                         // Get handler from registry
  57                         $scannerInstance = Registry::getRegistry()->getInstance('scanner_' . $scannerType);
  58                 } else {
  59                         // Get the scanner instance
  60                         $scannerInstance = ObjectFactory::createObjectByConfiguredName($scannerType);
  61
  62                         // Add it to the registry
  63                         Registry::getRegistry()->addInstance('scanner_' . $scannerType, $scannerInstance);
  64                 }
  65
  66                 // Return the instance
  67                 return $scannerInstance;
  68         }
  69 }
  70
  71 // [EOF]
  72 ?>