a2a3432aa6b3f83f1d729d27bd409b72aaea7ed6
[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          * Initializes this file class
56          *
57          * @param       $fileName       Name of this abstract file
58          * @return      void
59          */
60         protected function initFile ($fileName) {
61                 // Get a file i/o pointer instance
62                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName));
63
64                 // ... and set it here
65                 $this->setPointerInstance($pointerInstance);
66         }
67
68         /**
69          * Close a file source and set it's instance to null and the file name
70          * to empty
71          *
72          * @return      void
73          * @todo        ~10% done?
74          */
75         public function closeFile () {
76                 $this->partialStub('Unfinished method.');
77
78                 // Remove file name
79                 $this->setFileName('');
80         }
81
82         /**
83          * Setter for file name
84          *
85          * @param       $fileName       The new file name
86          * @return      void
87          */
88         protected final function setFileName ($fileName) {
89                 $fileName = (string) $fileName;
90                 $this->fileName = $fileName;
91         }
92
93         /**
94          * Getter for file name
95          *
96          * @return      $fileName       The current file name
97          */
98         public final function getFileName () {
99                 return $this->fileName;
100         }
101 }
102
103 // [EOF]
104 ?>