3 namespace CoreFramework\Filesystem\File;
5 // Import framework stuff
6 use CoreFramework\Filesystem\CloseableFile;
7 use CoreFramework\Filesystem\FilePointer;
8 use CoreFramework\Generic\UnsupportedOperationException;
9 use CoreFramework\Object\BaseFrameworkSystem;
12 * An abstract file class
14 * @author Roland Haeder <webmaster@ship-simu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.ship-simu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class BaseAbstractFile extends BaseFrameworkSystem implements FilePointer, CloseableFile {
35 * Counter for total entries
37 private $totalEntries = 0;
40 * The current file we are working in
42 private $fileName = '';
45 * Protected constructor
47 * @param $className Name of the class
50 protected function __construct ($className) {
51 // Call parent constructor
52 parent::__construct($className);
56 * Destructor for cleaning purposes, etc
60 public final function __destruct() {
61 // Try to close a file
64 // Call the parent destructor
69 * "Getter" for abstracted file size
71 * @return $fileSize Size of abstracted file
73 public function getFileSize () {
74 // Call pointer instanze
75 return $this->getPointerInstance()->getFileSize();
79 * Getter for total entries
81 * @return $totalEntries Total entries in this file
83 public final function getCounter () {
85 return $this->totalEntries;
89 * Setter for total entries
91 * @param $totalEntries Total entries in this file
94 protected final function setCounter ($counter) {
96 $this->totalEntries = $counter;
104 protected final function incrementCounter () {
106 $this->totalEntries++;
110 * Getter for the file pointer
112 * @return $filePointer The file pointer which shall be a valid file resource
113 * @throws UnsupportedOperationException If this method is called
115 public final function getPointer () {
116 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
120 * Setter for file name
122 * @param $fileName The new file name
125 protected final function setFileName ($fileName) {
126 $fileName = (string) $fileName;
127 $this->fileName = $fileName;
131 * Getter for file name
133 * @return $fileName The current file name
135 public final function getFileName () {
136 return $this->fileName;
140 * Close a file source and set it's instance to null and the file name
145 public function closeFile () {
147 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
149 // Close down pointer instance as well by unsetting it
150 $this->unsetPointerInstance();
153 $this->setFileName('');
156 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
162 * @return $size Size (in bytes) of file
163 * @todo Handle seekStatus
165 public function size () {
166 // Call pointer instance
167 return $this->getPointerInstance()->size();
171 * Read data a file pointer
173 * @return mixed The result of fread()
174 * @throws NullPointerException If the file pointer instance
175 * is not set by setPointer()
176 * @throws InvalidResourceException If there is being set
178 public function readFromFile () {
179 // Call pointer instance
180 return $this->getPointerInstance()->readFromFile();
184 * Write data to a file pointer
186 * @param $dataStream The data stream we shall write to the file
187 * @return mixed Number of writes bytes or false on error
188 * @throws NullPointerException If the file pointer instance
189 * is not set by setPointer()
190 * @throws InvalidResourceException If there is being set
191 * an invalid file resource
193 public function writeToFile ($dataStream) {
194 // Call pointer instance
195 return $this->getPointerInstance()->writeToFile($dataStream);
199 * Determines whether the EOF has been reached
201 * @return $isEndOfFileReached Whether the EOF has been reached
203 public final function isEndOfFileReached () {
204 // Call pointer instance
205 return $this->getPointerInstance()->isEndOfFileReached();