3 * A FiFo file-based stack
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 FiFoFileStack extends BaseFileStack implements StackableFile, CalculatableBlock, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @param $fileName Absolute Name of stack file
39 * @param $type Type of this stack (e.g. url_source for URL sources)
40 * @return $stackInstance An instance of a Stackable class
42 public final static function createFiFoFileStack ($fileName, $type) {
44 $stackInstance = new FiFoFileStack();
47 $stackInstance->initFileStack($fileName, $type);
49 // Return the prepared instance
50 return $stackInstance;
54 * Pushs a value on a named stacker
56 * @param $stackerName Name of the stack
57 * @param $value Value to push on it
59 * @throws StackerFullException If the stack is full
61 public function pushNamed ($stackerName, $value) {
62 // Call the protected method
63 parent::addValue($stackerName, $value);
67 * 'Pops' a value from a named stacker and returns it's value
69 * @param $stackerName Name of the stack
70 * @return $value Value of the current stack entry
71 * @throws NoStackerException If the named stacker was not found
72 * @throws EmptyStackerException If the named stacker is empty
74 public function popNamed ($stackerName) {
76 $value = $this->getNamed($stackerName);
78 // Call the protected method
79 parent::popFirst($stackerName);
86 * Get value from named stacker
88 * @param $stackerName Name of the stack
89 * @return $value Value of last added value
90 * @throws NoStackerException If the named stacker was not found
91 * @throws EmptyStackerException If the named stacker is empty
93 public function getNamed ($stackerName) {
94 // Call the protected method
95 return parent::getFirstValue($stackerName);
99 * Seeks to given position
101 * @param $seekPosition Seek position in file
102 * @return $status Status of this operation
104 public function seek ($seekPosition) {
105 $this->partialStub('seekPosition=' . $seekPosition);
111 * @return $size Size (in bytes) of file
113 public function size () {
114 // Call the iterator instance
115 return $this->getIteratorInstance()->size();