Moved stuff to 'core'.

[hub.git] / application / hub / interfaces / lists / class_Listable.php

diff --git a/application/hub/interfaces/lists/class_Listable.php b/application/hub/interfaces/lists/class_Listable.php
index 2bc636a7961ef0f5221659774473b34782dce89b..dff1b93bce2b08b8f3f444fd72c17387a1d7a132 100644 (file)
--- a/application/hub/interfaces/lists/class_Listable.php
+++ b/application/hub/interfaces/lists/class_Listable.php
@@ -2,11 +2,11 @@
 /**
  * An interface for lists
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,10 +23,10 @@
  */
 interface Listable extends FrameworkInterface, IteratorAggregate {
        /**
-        * Checks wether the given group is set
+        * Checks whether the given group is set
         *
         * @param       $groupName      Group to check if found in list
-        * @return      $isset          Wether the group is valid
+        * @return      $isset          Whether the group is valid
         */
        function isGroupSet ($groupName);
 
@@ -42,13 +42,13 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
        /**
         * Adds the given instance to list group and sub group
         *
-        * @param       $groupName      Group to add instance to
-        * @param       $subGroup       Sub group to add instance to
-        * @param       $instance       An instance of Visitable
+        * @param       $groupName                      Group to add instance to
+        * @param       $subGroup                       Sub group to add instance to
+        * @param       $visitableInstance      An instance of Visitable
         * @return      void
         * @throws      NoListGroupException    If the given group is not found
         */
-       function addInstance ($groupName, $subGroup, Visitable $instance);
+       function addInstance ($groupName, $subGroup, Visitable $visitableInstance);
 
        /**
         * Adds the given entry to list group
@@ -69,6 +69,20 @@ interface Listable extends FrameworkInterface, IteratorAggregate {
         * @throws      InvalidListHashException        If the solved hash index is invalid
         */
        function updateCurrentEntryByHash ($hash, array $entryArray);
+
+       /**
+        * "Getter" for an iterator instance of this list
+        *
+        * @return      $iteratorInstance       An instance of a Iterator class
+        */
+       function getListIterator ();
+
+       /**
+        * Clears this list (mostly by clearing all groups together)
+        *
+        * @return      void
+        */
+       function clearList ();
 }
 
 // [EOF]