3 namespace CoreFramework\Stacker;
5 // Import framework stuff
6 use CoreFramework\Stacker\BaseStacker;
7 use CoreFramework\Stacker\Stackable;
10 * A FiFo Stacker class
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class FiFoStacker extends BaseStacker implements Stackable {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of the class Stacker and prepares it for usage
45 * @return $stackInstance An instance of FiFoStacker
47 public static final function createFiFoStacker () {
49 $stackInstance = new FiFoStacker();
51 // Init generic stacker
52 $stackInstance->initStack('generic');
54 // Return the prepared instance
55 return $stackInstance;
59 * Pushs a value on a named stacker
61 * @param $stackerName Name of the stack
62 * @param $value Value to push on it
64 * @throws StackerFullException If the stack is full
66 public function pushNamed ($stackerName, $value) {
67 // Call the protected method
68 parent::addValue($stackerName, $value);
72 * 'Pops' a value from a named stacker and returns it's value
74 * @param $stackerName Name of the stack
75 * @return $value Value of the current stack entry
76 * @throws NoStackerException If the named stacker was not found
77 * @throws EmptyStackerException If the named stacker is empty
79 public function popNamed ($stackerName) {
81 $value = $this->getNamed($stackerName);
83 // Call the protected method
84 parent::popFirst($stackerName);
91 * Get value from named stacker
93 * @param $stackerName Name of the stack
94 * @return $value Value of last added value
95 * @throws NoStackerException If the named stacker was not found
96 * @throws EmptyStackerException If the named stacker is empty
98 public function getNamed ($stackerName) {
99 // Call the protected method
100 return parent::getFirstValue($stackerName);