inc/classes/main/registry/class_BaseRegistry.php

   1 <?php
   2 /**
   3  * A general Registry
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core 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 BaseRegistry extends BaseFrameworkSystem implements Registerable {
  25         /**
  26          * Instance of this class
  27          */
  28         private static $registryInstance = null;
  29
  30         /**
  31          * Instance registry
  32          */
  33         private $instanceRegistry = array();
  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          * Checks wether an instance key was found
  48          *
  49          * @param       $instanceKey    The key holding an instance in registry
  50          * @return      $exists                 Wether the key exists in registry
  51          */
  52         public function instanceExists ($instanceKey) {
  53                 // Does this key exists?
  54                 $exists = (isset($this->instanceRegistry[$instanceKey]));
  55
  56                 // Return the result
  57                 return $exists;
  58         }
  59
  60         /**
  61          * Adds/overwrites a new instance to the registry at the given key
  62          *
  63          * @param       $instanceKey            The key to identify the instance
  64          * @param       $objectInstance         An instance we shall store
  65          * @return      void
  66          */
  67         public function addInstance ($instanceKey, Registerable $objectInstance) {
  68                 $this->instanceRegistry[$instanceKey] = $objectInstance;
  69         }
  70
  71         /**
  72          * Gets a registered instance or null if not found
  73          *
  74          * @param       $instanceKey            The key to identify the instance
  75          * @return      $objectInstance         An instance we shall store
  76          * @throws      NullPointerException    If the requested key is not found
  77          */
  78         public function getInstance ($instanceKey) {
  79                 // By default the instance is not in registry
  80                 $objectInstance = null;
  81
  82                 // Is the instance there?
  83                 if ($this->instanceExists($instanceKey)) {
  84                         $objectInstance = $this->instanceRegistry[$instanceKey];
  85                 } // END - if
  86
  87                 // Still not fetched?
  88                 if (is_null($objectInstance)) {
  89                         // This might happen if a non-registered key was requested
  90                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  91                 } // END - if
  92
  93                 // Return the result
  94                 return $objectInstance;
  95         }
  96 }
  97
  98 // [EOF]
  99 ?>