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

[core.git] / inc / classes / main / stacker / class_BaseStacker.php

diff --git a/inc/classes/main/stacker/class_BaseStacker.php b/inc/classes/main/stacker/class_BaseStacker.php
index 4225cb731b57e7ee7c895ae056c70613a8111441..1bfd88063616920d943e4430c44d2c9798af975e 100644 (file)
--- a/inc/classes/main/stacker/class_BaseStacker.php
+++ b/inc/classes/main/stacker/class_BaseStacker.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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
  *
@@ -48,12 +48,13 @@ class BaseStacker extends BaseFrameworkSystem {
         * Initializes given stacker
         *
         * @param       $stackerName    Name of the stack
+        * @param       $forceReInit    Force re-initialization
         * @return      void
         * @throws      AlreadyInitializedStackerException      If the stack is already initialized
         */
-       protected final function initStacker ($stackerName) {
+       public final function initStacker ($stackerName, $forceReInit = false) {
                // Is the stack already initialized?
-               if ($this->isStackInitialized($stackerName)) {
+               if (($forceReInit === false) && ($this->isStackInitialized($stackerName))) {
                        // Then throw the exception
                        throw new AlreadyInitializedStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_ALREADY_INITIALIZED);
                } // END - if
@@ -71,7 +72,7 @@ class BaseStacker extends BaseFrameworkSystem {
         * @param       $stackerName    Name of the stack
         * @return      $isInitialized  Wether the stack is initialized
         */
-       protected final function isStackInitialized ($stackerName) {
+       public final function isStackInitialized ($stackerName) {
                // Is is there?
                $isInitialized = ((isset($this->stacks[$stackerName])) && (is_array($this->stacks[$stackerName])));
 
@@ -86,7 +87,7 @@ class BaseStacker extends BaseFrameworkSystem {
         * @return      $isFull                 Wether the stack is full
         * @throws      NoStackerException      If given stack is missing
         */
-       protected final function isStackFull($stackerName) {
+       protected final function isStackFull ($stackerName) {
                // Is the stack not yet initialized?
                if (!$this->isStackInitialized($stackerName)) {
                        // Throw an exception
@@ -107,14 +108,14 @@ class BaseStacker extends BaseFrameworkSystem {
         * @return      $isEmpty                        Wether the stack is empty
         * @throws      NoStackerException      If given stack is missing
         */
-       protected final function isStackEmpty($stackerName) {
+       public final function isStackEmpty ($stackerName) {
                // Is the stack not yet initialized?
                if (!$this->isStackInitialized($stackerName)) {
                        // Throw an exception
                        throw new NoStackerException(array($this, $stackerName), self::EXCEPTION_NO_STACKER_FOUND);
                } // END - if
 
-               // So, is the stack full?
+               // So, is the stack empty?
                $isFull = (($this->getStackCount($stackerName)) == 0);
 
                // Return result
@@ -128,7 +129,7 @@ class BaseStacker extends BaseFrameworkSystem {
         * @return      $count                  Size of stack (array count)
         * @throws      NoStackerException      If given stack is missing
         */
-       protected final function getStackCount ($stackerName) {
+       public final function getStackCount ($stackerName) {
                // Is the stack not yet initialized?
                if (!$this->isStackInitialized($stackerName)) {
                        // Throw an exception
@@ -189,6 +190,31 @@ class BaseStacker extends BaseFrameworkSystem {
                return $value;
        }
 
+       /**
+        * Get first value from named stacker
+        *
+        * @param       $stackerName    Name of the stack
+        * @return      $value                  Value of last added value
+        * @throws      NoStackerException      If the named stacker was not found
+        * @throws      EmptyStackerException   If the named stacker is empty
+        */
+       protected final function getFirstValue ($stackerName) {
+               // Is the stack not yet initialized or full?
+               if (!$this->isStackInitialized($stackerName)) {
+                       // Throw an exception
+                       throw new NoStackerException(array($this, $stackerName), self::EXCEPTION_NO_STACKER_FOUND);
+               } elseif ($this->isStackEmpty($stackerName)) {
+                       //Throw an exception
+                       throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
+               }
+
+               // Now get the last value
+               $value = $this->stacks[$stackerName]['entries'][0];
+
+               // Return it
+               return $value;
+       }
+
        /**
         * "Pops" last entry from stack
         *
@@ -210,6 +236,28 @@ class BaseStacker extends BaseFrameworkSystem {
                // Now, remove the last entry, we don't care about the return value here, see elseif() block above
                array_pop($this->stacks[$stackerName]['entries']);
        }
+
+       /**
+        * "Pops" first entry from stack
+        *
+        * @param       $stackerName    Name of the stack
+        * @return      void
+        * @throws      NoStackerException      If the named stacker was not found
+        * @throws      EmptyStackerException   If the named stacker is empty
+        */
+       protected final function popFirst ($stackerName) {
+               // Is the stack not yet initialized or full?
+               if (!$this->isStackInitialized($stackerName)) {
+                       // Throw an exception
+                       throw new NoStackerException(array($this, $stackerName), self::EXCEPTION_NO_STACKER_FOUND);
+               } elseif ($this->isStackEmpty($stackerName)) {
+                       //Throw an exception
+                       throw new EmptyStackerException(array($this, $stackerName), self::EXCEPTION_STACKER_IS_EMPTY);
+               }
+
+               // Now, remove the last entry, we don't care about the return value here, see elseif() block above
+               array_shift($this->stacks[$stackerName]['entries']);
+       }
 }
 
 // [EOF]