3 namespace CoreFramework\Handler\Filesystem;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Generic\FrameworkInterface;
8 use CoreFramework\Middleware\BaseMiddleware;
11 * This is a file IO handler. It handles reading from and writing to files.
12 * Missing paths in writing process will be automatically created.
14 * @author Roland Haeder <webmaster@shipsimu.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.shipsimu.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 FileIoHandler extends BaseMiddleware implements IoHandler {
35 * The *real* file input class we shall use for reading data
37 private $inputStream = NULL;
40 * The *real* file output class we shall use for reading data
42 private $outputStream = NULL;
45 * An instance of this class
47 private static $selfInstance = NULL;
50 * Protected constructor
54 protected function __construct () {
55 // Call parent constructor
56 parent::__construct(__CLASS__);
59 self::$selfInstance = $this;
63 * Creates an instance of this class and prepares the IO system. This is
64 * being done by setting the default file IO class
66 * @return $ioInstance A prepared instance of FilIOHandler
68 public static final function createFileIoHandler () {
70 $ioHandler = new FileIoHandler();
72 // Set the *real* file IO instances (both the same)
73 $ioHandler->setInputStream(ObjectFactory::createObjectByConfiguredName('file_input_class'));
74 $ioHandler->setOutputStream(ObjectFactory::createObjectByConfiguredName('file_output_class'));
81 * Getter for an instance of this class
83 * @return $selfInstance An instance of this class
85 public static final function getSelfInstance () {
86 return self::$selfInstance;
90 * Setter for the *real* file input instance
92 * @param $inputStream The *real* file-input class
95 public final function setInputStream (FileInputStreamer $inputStream) {
96 $this->inputStream = $inputStream;
100 * Getter for the *real* file input instance
102 * @return $inputStream The *real* file-input class
104 public final function getInputStream () {
105 return $this->inputStream;
109 * Setter for the *real* file output instance
111 * @param $outputStream The *real* file-output class
114 public final function setOutputStream (FileOutputStreamer $outputStream) {
115 $this->outputStream = $outputStream;
119 * Getter for the *real* file output instance
121 * @return $outputStream The *real* file-output class
123 public final function getOutputStream () {
124 return $this->outputStream;
127 * Saves streamed (that are mostly serialized objects) data to files or
130 * @param $fileName The local file's name including full path
131 * @param $dataArray Array containing the compressor's extension and streamed data
133 * @throws UnsupportedOperationException If this method is called
135 public function saveFile ($fileName, array $dataArray) {
136 self::createDebugInstance(__CLASS__)->debugOutput('fileName=' . $fileName . ',dataArray()=' . count($dataArray));
137 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
141 * Saves a file with data by using the current output stream
143 * @param $fileName Name of the file
144 * @param $dataStream File data stream
145 * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
148 public function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
149 // Default is this array
150 $className = $this->__toString();
152 // Is the object instance set?
153 if ($objectInstance instanceof FrameworkInterface) {
155 $className = $objectInstance->__toString();
158 // Prepare output array
164 // Send the fileName and dataArray to the output handler
165 $this->getOutputStream()->saveFile($fileName, $dataArray);
168 /** Loads data from a file over the input handler
170 * @param $fqfn Given full-qualified file name (FQFN) to load
171 * @return $array Array with the file contents
173 public function loadFileContents ($fqfn) {
174 // Read from the input handler
175 return $this->getInputStream()->loadFileContents($fqfn);
179 * Determines seek position
181 * @return $seekPosition Current seek position
184 public function determineSeekPosition () {
185 $this->partialStub();
189 * Seek to given offset (default) or other possibilities as fseek() gives.
191 * @param $offset Offset to seek to (or used as "base" for other seeks)
192 * @param $whence Added to offset (default: only use offset to seek to)
193 * @return $status Status of file seek: 0 = success, -1 = failed
195 public function seek ($offset, $whence = SEEK_SET) {
196 $this->partialStub('offset=' . $offset . ',whence=' . $whence);
202 * @return $size Size (in bytes) of file
204 public function size () {
205 $this->partialStub();