popNamed() does also now return the current stacker's value.

[core.git] / inc / classes / interfaces / stacker / class_Stackable.php

diff --git a/inc/classes/interfaces/stacker/class_Stackable.php b/inc/classes/interfaces/stacker/class_Stackable.php
index cef4f4d582041b7595cad01c741b66eccec8bdf9..34b6cf18324e64e9876c54100a9d5abff408b60e 100644 (file)
--- a/inc/classes/interfaces/stacker/class_Stackable.php
+++ b/inc/classes/interfaces/stacker/class_Stackable.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -33,17 +33,17 @@ interface Stackable extends FrameworkInterface {
        function pushNamed ($stackerName, $value);
 
        /**
-        * 'Pops' a value from a named stacker
+        * 'Pops' a value from a named stacker and returns it's value
         *
         * @param       $stackerName    Name of the stacker
-        * @return      void
+        * @return      $value                  Value of the current stack entry
         * @throws      NoStackerException      If the named stacker was not found
         * @throws      EmptyStackerException   If the named stacker is empty
         */
        function popNamed ($stackerName);
 
        /**
-        * Get value from named stacker
+        * Get value from named stacker but don't "pop" it
         *
         * @param       $stackerName    Name of the stacker
         * @return      $value                  Value of last added value
@@ -51,6 +51,23 @@ interface Stackable extends FrameworkInterface {
         * @throws      EmptyStackerException   If the named stacker is empty
         */
        function getNamed ($stackerName);
+
+       /**
+        * Checks wether the given stack is initialized (set in array $stackers)
+        *
+        * @param       $stackerName    Name of the stack
+        * @return      $isInitialized  Wether the stack is initialized
+        */
+       function isStackInitialized ($stackerName);
+
+       /**
+        * Checks wether the given stack is empty
+        *
+        * @param       $stackerName    Name of the stack
+        * @return      $isEmpty                        Wether the stack is empty
+        * @throws      NoStackerException      If given stack is missing
+        */
+       function isStackEmpty ($stackerName);
 }
 
 // [EOF]