3 namespace CoreFramework\Filesystem\Pointer\Text;
5 // Import framework stuff
6 use CoreFramework\Generic\NullPointerException;
9 * A class for writing files
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Create a file pointer based on the given file. The file will also
45 * @param $fileName The file name we shall pass to fopen()
46 * @param $mode The output mode ('w', 'a' are valid)
47 * @throws FileIsEmptyException If the provided file name is empty.
48 * @throws FileIoException If fopen() returns not a file resource
51 public static final function createFrameworkRawFileOutputPointer ($fileName, $mode) {
52 // Some pre-sanity checks...
53 if (is_null($fileName)) {
55 throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
58 // Try to open a handler
59 $filePointer = @fopen($fileName, $mode);
60 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
61 // Something bad happend
62 throw new FileIoException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
65 // Create new instance
66 $pointerInstance = new FrameworkRawFileOutputPointer();
68 // Set file pointer and file name
69 $pointerInstance->setPointer($filePointer);
70 $pointerInstance->setFileName($fileName);
72 // Return the instance
73 return $pointerInstance;
77 * Write data to a file pointer
79 * @param $dataStream The data stream we shall write to the file
80 * @return mixed Number of writes bytes or FALSE on error
81 * @throws NullPointerException If the file pointer instance
82 * is not set by setPointer()
83 * @throws InvalidResourceException If there is being set
84 * an invalid file resource
86 public function writeToFile ($dataStream) {
87 if (is_null($this->getPointer())) {
88 // Pointer not initialized
89 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
90 } elseif (!is_resource($this->getPointer())) {
91 // Pointer is not a valid resource!
92 throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
95 // Write data to the file pointer and return written bytes
96 return fwrite($this->getPointer(), $dataStream);
100 * Analyzes entries in index file. This will count all found (and valid)
101 * entries, mark invalid as damaged and count gaps ("fragmentation"). If
102 * only gaps are found, the file is considered as "virgin" (no entries).
105 * @throws UnsupportedOperationException If this method is called
107 public function analyzeFile () {
108 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
112 * Writes at given position by seeking to it.
114 * @param $seekPosition Seek position in file
115 * @param $data Data to be written
116 * @return mixed Number of writes bytes or FALSE on error
117 * @throws UnsupportedOperationException If this method is called
119 public function writeAtPosition ($seedPosition, $data) {
120 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
124 * Advances to next "block" of bytes
127 * @throws UnsupportedOperationException If this method is called
129 public function next () {
130 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
134 * Checks wether the current entry is valid (not at the end of the file).
135 * This method will return TRUE if an emptied (nulled) entry has been found.
137 * @return $isValid Whether the next entry is valid
138 * @throws UnsupportedOperationException If this method is called
140 public function valid () {
141 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
145 * Gets current seek position ("key").
147 * @return $key Current key in iteration
148 * @throws UnsupportedOperationException If this method is called
150 public function key () {
151 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);