3 * A ??? file-based stack
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2023 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 ???FileStack extends BaseFileStack implements StackableFile, Registerable {
26 * Protected constructor
30 private 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 * @return $stackInstance An instance of a StackableFile class
41 public final static function create???FileStack ($fileName) {
43 $stackInstance = new ???FileStack();
46 $stackInstance->initStack($fileName);
48 // Return the prepared instance
49 return $stackInstance;
53 * Pushs a value on a named stacker
55 * @param $stackerName Name of the stack
56 * @param $value Value to push on it
58 * @throws StackerFullException If the stack is full
60 public function pushNamed ($stackerName, $value) {
61 $this->partialStub('stackerName=' . $stackerName . ',value[' . gettype($value) . ']=' . $value);
65 * 'Pops' a value from a named stacker
67 * @param $stackerName Name of the stack
69 * @throws NoStackerException If the named stacker was not found
70 * @throws EmptyStackerException If the named stacker is empty
72 public function popNamed ($stackerName) {
73 $this->partialStub('stackerName=' . $stackerName);
77 * Get value from named stacker
79 * @param $stackerName Name of the stack
80 * @return $value Value of last added value
81 * @throws NoStackerException If the named stacker was not found
82 * @throws EmptyStackerException If the named stacker is empty
84 public function getNamed ($stackerName) {
85 $this->partialStub('stackerName=' . $stackerName);
89 * Seeks to given position
91 * @param $seekPosition Seek position in file
94 public function seek ($seekPosition) {
95 $this->partialStub('seekPosition=' . $seekPosition);
101 * @return $size Size (in bytes) of file
103 public function size () {
104 $this->partialStub();