application/hub/main/pools/class_BasePool.php

   1 <?php
   2 /**
   3  * A general pool 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 BasePool extends BaseHubSystem {
  25         /**
  26          * A list of pool entries
  27          */
  28         private $poolEntries = array();
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Adds an instance to a pool segment
  43          *
  44          * @param       $group                  Name of the pool group
  45          * @param       $poolSegment    Name of the pool segment
  46          * @param       $instance               An instance of a class we should add to the pool
  47          * @return      void
  48          * @todo        Can we use Listenable instead of FrameworkInterface ?
  49          */
  50         protected final function addInstance($group, $poolName, FrameworkInterface $instance) {
  51                 $this->poolEntries[$group][$poolName][] = $instance;
  52         }
  53
  54         /**
  55          * Adds an entry to the pool
  56          *
  57          * @param       $poolEntry      The new pool entry we should add
  58          * @return      void
  59          */
  60         protected final function addPoolEntry ($poolEntry) {
  61                 $this->poolEntries[] = $poolEntry;
  62         }
  63 }
  64
  65 // [EOF]
  66 ?>