inc/classes/main/stacker/fifo/class_FiFoStacker.php

   1 <?php
   2 /**
   3  * A FiFo Stacker class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 class FiFoStacker extends BaseStacker implements Stackable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of the class Stacker and prepares it for usage
  37          *
  38          * @return      $stackerInstance        An instance of FiFoStacker
  39          */
  40         public static final function createFiFoStacker () {
  41                 // Get a new instance
  42                 $stackerInstance = new FiFoStacker();
  43
  44                 // Init generic stacker
  45                 $stackerInstance->initStack('generic');
  46
  47                 // Return the prepared instance
  48                 return $stackerInstance;
  49         }
  50
  51         /**
  52          * Pushs a value on a named stacker
  53          *
  54          * @param       $stackerName    Name of the stack
  55          * @param       $value                  Value to push on it
  56          * @return      void
  57          * @throws      StackerFullException    If the stack is full
  58          */
  59         public function pushNamed ($stackerName, $value) {
  60                 // Call the protected method
  61                 parent::addValue($stackerName, $value);
  62         }
  63
  64         /**
  65          * 'Pops' a value from a named stacker and returns it's value
  66          *
  67          * @param       $stackerName    Name of the stack
  68          * @return      $value                  Value of the current stack entry
  69          * @throws      NoStackerException      If the named stacker was not found
  70          * @throws      EmptyStackerException   If the named stacker is empty
  71          */
  72         public function popNamed ($stackerName) {
  73                 // Get the value
  74                 $value = $this->getNamed($stackerName);
  75
  76                 // Call the protected method
  77                 parent::popFirst($stackerName);
  78
  79                 // Return the value
  80                 return $value;
  81         }
  82
  83         /**
  84          * Get value from named stacker
  85          *
  86          * @param       $stackerName    Name of the stack
  87          * @return      $value                  Value of last added value
  88          * @throws      NoStackerException      If the named stacker was not found
  89          * @throws      EmptyStackerException   If the named stacker is empty
  90          */
  91         public function getNamed ($stackerName) {
  92                 // Call the protected method
  93                 return parent::getFirstValue($stackerName);
  94         }
  95 }
  96
  97 // [EOF]
  98 ?>