framework/main/interfaces/registry/class_Register.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Registry;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for registries
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/registry/class_Register.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/registry/class_Register.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface Register extends FrameworkInterface {
  35         /**
  36          * Checks whether an instance key was found
  37          *
  38          * @param       $instanceKey    The key holding an instance in registry
  39          * @return      $exists                 Whether the key exists in registry
  40          */
  41         function instanceExists ($instanceKey);
  42
  43         /**
  44          * Adds/overwrites a new instance to the registry at the given key
  45          *
  46          * @param       $instanceKey            The key to identify the instance
  47          * @param       $objectInstance         An instance we shall store
  48          * @return      void
  49          */
  50         function addInstance ($instanceKey, Registerable $objectInstance);
  51
  52         /**
  53          * Getter for whole generic registry
  54          *
  55          * @return      $instanceRegistry       The whole generic registry array
  56          */
  57         function getGenericRegistry ();
  58
  59         /**
  60          * Getter for whole instance registry
  61          *
  62          * @return      $instanceRegistry       The whole instance registry array
  63          */
  64         function getInstanceRegistry ();
  65
  66         /**
  67          * Adds a new entry to the given list name. If you want to add objects
  68          * please use addInstance() and getInstance() instead.
  69          *
  70          * @param       $key    The key to identify the whole list
  71          * @param       $value  The value to be stored
  72          * @return      void
  73          */
  74         function addEntry ($key, $value);
  75
  76         /**
  77          * Getter for entries or "sub entries"
  78          *
  79          * @return      $entries        An array with entries from this registry
  80          */
  81         function getEntries ($key = NULL);
  82
  83         /**
  84          * "Getter" for an array of all entries for given key
  85          *
  86          * @param       $arrayKey       The array (key) to look in
  87          * @param       $lookFor        The key to look for
  88          * @return      $entry          An array with all keys
  89          */
  90         function getArrayFromKey ($arrayKey, $lookFor);
  91
  92         /**
  93          * Gets a registered instance or null if not found
  94          *
  95          * @param       $instanceKey            The key to identify the instance
  96          * @return      $objectInstance         An instance we shall store
  97          * @throws      NullPointerException    If the requested key is not found
  98          */
  99         function getInstance ($instanceKey);
 100
 101 }