application/hub/main/class_BaseHubSystem.php

   1 <?php
   2 /**
   3  * A general hub system class
   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 BaseHubSystem extends BaseFrameworkSystem {
  25         /**
  26          * An instance of a node
  27          */
  28         private $nodeInstance = null;
  29
  30         /**
  31          * Listener instance
  32          */
  33         private $listenerInstance = null;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Setter for listener instance
  48          *
  49          * @param       $listenerInstance       A Listenable instance
  50          * @return      void
  51          */
  52         protected final function setListenerInstance (Listenable $listenerInstance) {
  53                 $this->listenerInstance = $listenerInstance;
  54         }
  55
  56         /**
  57          * Getter for listener instance
  58          *
  59          * @return      $listenerInstance       A Listenable instance
  60          */
  61         protected final function getListenerInstance () {
  62                 return $this->listenerInstance;
  63         }
  64
  65         /**
  66          * Setter for node instance
  67          *
  68          * @param       $nodeInstance   An instance of a node node
  69          * @return      void
  70          */
  71         protected final function setNodeInstance (NodeHelper $nodeInstance) {
  72                 $this->nodeInstance = $nodeInstance;
  73         }
  74
  75         /**
  76          * Getter for node instance
  77          *
  78          * @return      $nodeInstance   An instance of a node node
  79          */
  80         public final function getNodeInstance () {
  81                 return $this->nodeInstance;
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>