3 namespace CoreFramework\Filesystem;
5 // Import framework stuff
6 use CoreFramework\Generic\FrameworkInterface;
11 * @author Roland Haeder <webmaster@ship-simu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.ship-simu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface Block extends FrameworkInterface {
32 * Reads the file header
36 function readFileHeader ();
39 * Flushes the file header
43 function flushFileHeader ();
46 * Determines whether the EOF has been reached
48 * @return $isEndOfFileReached Whether the EOF has been reached
50 function isEndOfFileReached ();
53 * Getter for file name
55 * @return $fileName The current file name
57 function getFileName ();
60 * Initializes counter for valid entries, arrays for damaged entries and
61 * an array for gap seek positions. If you call this method on your own,
62 * please re-analyze the file structure. So you are better to call
63 * analyzeFile() instead of this method.
67 function initCountersGapsArray ();
70 * Getter for header size
72 * @return $totalEntries Size of file header
74 function getHeaderSize ();
77 * Setter for header size
79 * @param $headerSize Size of file header
82 function setHeaderSize ($headerSize);
85 * Getter for header array
87 * @return $totalEntries Size of file header
89 function getHeader ();
94 * @param $header Array for a file header
97 function setHeader (array $header);
100 * Updates seekPosition attribute from file to avoid to much access on file.
104 function updateSeekPosition ();
107 * Getter for total entries
109 * @return $totalEntries Total entries in this file
111 function getCounter ();
114 * "Getter" for file size
116 * @return $fileSize Size of currently loaded file
118 function getFileSize ();
121 * Writes given value to the file and returns a hash and gap position for it
123 * @param $groupId Group identifier
124 * @param $value Value to be added to the stack
125 * @return $data Hash and gap position
127 function writeValueToFile ($groupId, $rawData);
130 * Writes given raw data to the file and returns a gap position and length
132 * @param $groupId Group identifier
133 * @param $hash Hash from encoded value
134 * @param $encoded Encoded value to be written to the file
135 * @return $data Gap position and length of the raw data
137 function writeDataToFreeGap ($groupId, $hash, $encoded);
140 * Writes data at given position
142 * @param $seekPosition Seek position
143 * @param $data Data to be written
144 * @param $flushHeader Whether to flush the header (default: flush)
147 function writeData ($seekPosition, $data, $flushHeader = true);
150 * Searches for next suitable gap the given length of data can fit in
151 * including padding bytes.
153 * @param $length Length of raw data
154 * @return $seekPosition Found next gap's seek position
156 function searchNextGap ($length);