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         /**
  33          * Getter for whole generic registry
  34          *
  35          * @return      $instanceRegistry       The whole generic registry array
  36          */
  37         function getGenericRegistry ();
  38
  39         /**
  40          * Adds a new entry to the given list name. If you want to add objects
  41          * please use addInstance() and getInstance() instead.
  42          *
  43          * @param       $key    The key to identify the whole list
  44          * @param       $value  The value to be stored
  45          * @return      void
  46          */
  47         function addEntry (string $key, $value);
  48
  49         /**
  50          * Getter for entries or "sub entries"
  51          *
  52          * @return      $entries        An array with entries from this registry
  53          */
  54         function getEntries (string $key = NULL);
  55
  56         /**
  57          * "Getter" for an array of all entries for given key
  58          *
  59          * @param       $arrayKey       The array (key) to look in
  60          * @param       $lookFor        The key to look for
  61          * @return      $entry          An array with all keys
  62          */
  63         function getArrayFromKey (string $arrayKey, string $lookFor);
  64
  65 }