application/hub/main/nodes/list/class_HubListNode.php

   1 <?php
   2 /**
   3  * A hub-node class for the 'List' mode
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.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.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 HubListNode extends BaseHubNode implements NodeHelper, Registerable {
  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 hub-node class
  37          *
  38          * @param       $requestInstance        An instance of a Requestable class
  39          * @return      $nodeInstance           An instance of this hub-node class
  40          */
  41         public static final function createHubListNode (Requestable $requestInstance) {
  42                 // Get a new instance
  43                 $nodeInstance = new HubListNode();
  44
  45                 // Set the request instance
  46                 $nodeInstance->setRequestInstance($requestInstance);
  47
  48                 // Return the instance
  49                 return $nodeInstance;
  50         }
  51
  52         /**
  53          * Method to "bootstrap" the node. This step does also apply provided
  54          * command-line arguments stored in the request instance. The regular node
  55          * should communicate with the bootstrap-nodes at this point.
  56          *
  57          * @return      void
  58          * @todo        Implement more bootstrap steps
  59          */
  60         public function doBootstrapping () {
  61                 $this->partialStub();
  62         }
  63
  64         /**
  65          * Add some node-specific filters
  66          *
  67          * @return      void
  68          */
  69         public function addExtraNodeFilters () {
  70                 // Get the application instance from registry
  71                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  72
  73                 // Get the controller from the application
  74                 $controllerInstance = $applicationInstance->getControllerInstance();
  75
  76                 // Self-announcement task
  77                 $controllerInstance->addActivationFilter(ObjectFactory::createObjectByConfiguredName('node_activation_announcement_task_filter'));
  78
  79                 // @TODO Add some filters here
  80                 $this->partialStub('Add some filters here.');
  81         }
  82
  83         /**
  84          * Adds extra tasks to the given handler for this node
  85          *
  86          * @param       $handlerInstance        An instance of a HandleableTask class
  87          * @return      void
  88          * @todo        0% done
  89          */
  90         public function addExtraTasks (HandleableTask $handlerInstance) {
  91                 $this->partialStub('Please add some tasks or empty this method.');
  92         }
  93 }
  94
  95 // [EOF]
  96 ?>