inc/main/interfaces/lists/class_Listable.php

   1 <?php
   2 /**
   3  * An interface for lists
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 interface Listable extends FrameworkInterface, IteratorAggregate {
  25         /**
  26          * Checks whether the given group is set
  27          *
  28          * @param       $groupName      Group to check if found in list
  29          * @return      $isset          Whether the group is valid
  30          */
  31         function isGroupSet ($groupName);
  32
  33         /**
  34          * Adds the given group or if already added issues a ListGroupAlreadyAddedException
  35          *
  36          * @param       $groupName      Group to add
  37          * @return      void
  38          * @throws      ListGroupAlreadyAddedException  If the given group is already added
  39          */
  40         function addGroup ($groupName);
  41
  42         /**
  43          * Adds the given instance to list group and sub group
  44          *
  45          * @param       $groupName                      Group to add instance to
  46          * @param       $subGroup                       Sub group to add instance to
  47          * @param       $visitableInstance      An instance of Visitable
  48          * @return      void
  49          * @throws      NoListGroupException    If the given group is not found
  50          */
  51         function addInstance ($groupName, $subGroup, Visitable $visitableInstance);
  52
  53         /**
  54          * Adds the given entry to list group
  55          *
  56          * @param       $groupName      Group to add instance to
  57          * @param       $entry          An entry of any type
  58          * @return      void
  59          * @throws      NoListGroupException    If the given group is not found
  60          */
  61         function addEntry ($groupName, $entry);
  62
  63         /**
  64          * Updates the given entry by hash with given array
  65          *
  66          * @param       $hash           Hash for this entry
  67          * @param       $entryArray     Array with entry we should update
  68          * @return      void
  69          * @throws      InvalidListHashException        If the solved hash index is invalid
  70          */
  71         function updateCurrentEntryByHash ($hash, array $entryArray);
  72
  73         /**
  74          * "Getter" for an iterator instance of this list
  75          *
  76          * @return      $iteratorInstance       An instance of a Iterator class
  77          */
  78         function getListIterator ();
  79
  80         /**
  81          * Clears this list (mostly by clearing all groups together)
  82          *
  83          * @return      void
  84          */
  85         function clearList ();
  86 }
  87
  88 // [EOF]
  89 ?>