5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class FiLoStacker extends BaseStacker implements Stackable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of the class Stacker and prepares it for usage
38 * @return $stackerInstance An instance of FiLoStacker
40 public static final function createFiLoStacker () {
42 $stackerInstance = new FiLoStacker();
44 // Init the generic stacker
45 $stackerInstance->initStack('generic');
47 // Return the prepared instance
48 return $stackerInstance;
52 * Pushs a value on a named stacker
54 * @param $stackerName Name of the stack
55 * @param $value Value to push on it
57 * @throws StackerFullException If the stack is full
59 public function pushNamed ($stackerName, $value) {
60 // Call the protected method
61 parent::addValue($stackerName, $value);
65 * 'Pops' a value from a named stacker and returns it's value
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
72 public function popNamed ($stackerName) {
74 $value = $this->getNamed($stackerName);
76 // Call the protected method
77 parent::popLast($stackerName);
84 * Get value from named stacker
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
91 public function getNamed ($stackerName) {
92 // Call the protected method
93 return parent::getLastValue($stackerName);