45dad992f011b1b0e4d8a60c16e19405c1841b21
[core.git] / inc / classes / interfaces / block / class_Block.php
1 <?php
2 /**
3  * A block interface
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 interface Block extends FrameworkInterface {
25         /**
26          * Reads the file header
27          *
28          * @return      void
29          */
30         function readFileHeader ();
31
32         /**
33          * Flushes the file header
34          *
35          * @return      void
36          */
37         function flushFileHeader ();
38
39         /**
40          * Close a file source and set it's instance to null and the file name
41          * to empty.
42          *
43          * @return      void
44          * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
45          * @throws      InvalidResourceException        If there is being set
46          */
47         function closeFile ();
48
49         /**
50          * Determines whether the EOF has been reached
51          *
52          * @return      $isEndOfFileReached             Whether the EOF has been reached
53          */
54         function isEndOfFileReached ();
55
56         /**
57          * Getter for file name
58          *
59          * @return      $fileName       The current file name
60          */
61         function getFileName ();
62
63         /**
64          * Initializes counter for valid entries, arrays for damaged entries and
65          * an array for gap seek positions. If you call this method on your own,
66          * please re-analyze the file structure. So you are better to call
67          * analyzeFile() instead of this method.
68          *
69          * @return      void
70          */
71         function initCountersGapsArray ();
72
73         /**
74          * Getter for header size
75          *
76          * @return      $totalEntries   Size of file header
77          */
78         function getHeaderSize ();
79
80         /**
81          * Setter for header size
82          *
83          * @param       $headerSize             Size of file header
84          * @return      void
85          */
86         function setHeaderSize ($headerSize);
87
88         /**
89          * Getter for header array
90          *
91          * @return      $totalEntries   Size of file header
92          */
93         function getHeader ();
94
95         /**
96          * Setter for header
97          *
98          * @param       $header         Array for a file header
99          * @return      void
100          */
101         function setHeader (array $header);
102
103         /**
104          * Updates seekPosition attribute from file to avoid to much access on file.
105          *
106          * @return      void
107          */
108         function updateSeekPosition ();
109
110         /**
111          * Getter for total entries
112          *
113          * @return      $totalEntries   Total entries in this file
114          */
115         function getCounter ();
116
117         /**
118          * "Getter" for file size
119          *
120          * @return      $fileSize       Size of currently loaded file
121          */
122         function getFileSize ();
123 }
124
125 // [EOF]
126 ?>