Added abstraction classes for file-based stacks and index files, some setter
[core.git] / inc / classes / main / file_directories / class_BaseFile.php
1 <?php
2 /**
3  * A general file class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 class BaseFile extends BaseFrameworkSystem {
25         /**
26          * The current file we are working in
27          */
28         private $fileName = '';
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      Name of the class
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Destructor for cleaning purposes, etc
43          *
44          * @return      void
45          */
46         public final function __destruct() {
47                 // Try to close a file
48                 $this->closeFile();
49
50                 // Call the parent destructor
51                 parent::__destruct();
52         }
53
54         /**
55          * Close a file source and set it's instance to null and the file name
56          * to empty
57          *
58          * @return      void
59          * @todo        ~10% done?
60          */
61         public function closeFile () {
62                 $this->partialStub('Unfinished method.');
63
64                 // Remove file name
65                 $this->setFileName('');
66         }
67
68         /**
69          * Setter for file name
70          *
71          * @param       $fileName       The new file name
72          * @return      void
73          */
74         protected final function setFileName ($fileName) {
75                 $fileName = (string) $fileName;
76                 $this->fileName = $fileName;
77         }
78
79         /**
80          * Getter for file name
81          *
82          * @return      $fileName       The current file name
83          */
84         public final function getFileName () {
85                 return $this->fileName;
86         }
87
88         /**
89          * Determines seek position
90          *
91          * @return      $seekPosition   Current seek position
92          * @todo        0% done
93          */
94         public final function determineSeekPosition () {
95                 $this->partialStub('Unfinished method.');
96         }
97
98         /**
99          * Seek to given offset (default) or other possibilities as fseek() gives.
100          *
101          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
102          * @param       $whence         Added to offset (default: only use offset to seek to)
103          * @return      $status         Status of file seek: 0 = success, -1 = failed
104          * @todo        0% done
105          */
106         public function seek ($offset, $whence = SEEK_SET) {
107                 $this->partialStub('Unfinished method.');
108         }
109
110         /**
111          * Size of this file
112          *
113          * @return      $size   Size (in bytes) of file
114          * @todo        Handle seekStatus
115          * @todo        0% done
116          */
117         public function size () {
118                 $this->partialStub('Unfinished method.');
119         }
120 }
121
122 // [EOF]
123 ?>