a12d74279e2ba11d8023d83b0a08d94b97aec1d2
[core.git] / inc / classes / interfaces / io / class_FilePointer.php
1 <?php
2 /**
3  * An interface for file pointers
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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 FilePointer extends FrameworkInterface {
25         /**
26          * Close a file source and set it's instance to null and the file name
27          * to empty.
28          *
29          * @return      void
30          * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
31          * @throws      InvalidResourceException        If there is being set
32          */
33         function closeFile ();
34
35         /**
36          * Getter for the file pointer
37          *
38          * @return      $filePointer    The file pointer which shall be a valid file resource
39          */
40         function getPointer ();
41
42         /**
43          * Getter for file name
44          *
45          * @return      $fileName       The current file name
46          */
47         function getFileName ();
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 // [EOF]
58 ?>