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