3 namespace CoreFramework\Handler\Filesystem;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Generic\FrameworkInterface;
8 use CoreFramework\Handler\Stream\IoHandler;
9 use CoreFramework\Middleware\BaseMiddleware;
10 use CoreFramework\Stream\Filesystem\FileInputStreamer;
11 use CoreFramework\Stream\Filesystem\FileOutputStreamer;
14 * This is a file IO handler. It handles reading from and writing to files.
15 * Missing paths in writing process will be automatically created.
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
23 * This program is free software: you can redistribute it and/or modify
24 * it under the terms of the GNU General Public License as published by
25 * the Free Software Foundation, either version 3 of the License, or
26 * (at your option) any later version.
28 * This program is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU General Public License for more details.
33 * You should have received a copy of the GNU General Public License
34 * along with this program. If not, see <http://www.gnu.org/licenses/>.
36 class FileIoHandler extends BaseMiddleware implements IoHandler {
38 * The *real* file input class we shall use for reading data
40 private $inputStream = NULL;
43 * The *real* file output class we shall use for reading data
45 private $outputStream = NULL;
48 * An instance of this class
50 private static $selfInstance = NULL;
53 * Protected constructor
57 protected function __construct () {
58 // Call parent constructor
59 parent::__construct(__CLASS__);
62 self::$selfInstance = $this;
66 * Creates an instance of this class and prepares the IO system. This is
67 * being done by setting the default file IO class
69 * @return $ioInstance A prepared instance of FilIOHandler
71 public static final function createFileIoHandler () {
73 $ioHandler = new FileIoHandler();
75 // Set the *real* file IO instances (both the same)
76 $ioHandler->setInputStream(ObjectFactory::createObjectByConfiguredName('file_input_class'));
77 $ioHandler->setOutputStream(ObjectFactory::createObjectByConfiguredName('file_output_class'));
84 * Getter for an instance of this class
86 * @return $selfInstance An instance of this class
88 public static final function getSelfInstance () {
89 return self::$selfInstance;
93 * Setter for the *real* file input instance
95 * @param $inputStream The *real* file-input class
98 public final function setInputStream (FileInputStreamer $inputStream) {
99 $this->inputStream = $inputStream;
103 * Getter for the *real* file input instance
105 * @return $inputStream The *real* file-input class
107 public final function getInputStream () {
108 return $this->inputStream;
112 * Setter for the *real* file output instance
114 * @param $outputStream The *real* file-output class
117 public final function setOutputStream (FileOutputStreamer $outputStream) {
118 $this->outputStream = $outputStream;
122 * Getter for the *real* file output instance
124 * @return $outputStream The *real* file-output class
126 public final function getOutputStream () {
127 return $this->outputStream;
130 * Saves streamed (that are mostly serialized objects) data to files or
133 * @param $fileName The local file's name including full path
134 * @param $dataArray Array containing the compressor's extension and streamed data
136 * @throws UnsupportedOperationException If this method is called
138 public function saveFile ($fileName, array $dataArray) {
139 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('fileName=' . $fileName . ',dataArray()=' . count($dataArray));
140 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
144 * Saves a file with data by using the current output stream
146 * @param $fileName Name of the file
147 * @param $dataStream File data stream
148 * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
151 public function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
152 // Default is this array
153 $className = $this->__toString();
155 // Is the object instance set?
156 if ($objectInstance instanceof FrameworkInterface) {
158 $className = $objectInstance->__toString();
161 // Prepare output array
167 // Send the fileName and dataArray to the output handler
168 $this->getOutputStream()->saveFile($fileName, $dataArray);
171 /** Loads data from a file over the input handler
173 * @param $fqfn Given full-qualified file name (FQFN) to load
174 * @return $array Array with the file contents
176 public function loadFileContents ($fqfn) {
177 // Read from the input handler
178 return $this->getInputStream()->loadFileContents($fqfn);
182 * Determines seek position
184 * @return $seekPosition Current seek position
187 public function determineSeekPosition () {
188 $this->partialStub();
192 * Seek to given offset (default) or other possibilities as fseek() gives.
194 * @param $offset Offset to seek to (or used as "base" for other seeks)
195 * @param $whence Added to offset (default: only use offset to seek to)
196 * @return $status Status of file seek: 0 = success, -1 = failed
198 public function seek ($offset, $whence = SEEK_SET) {
199 $this->partialStub('offset=' . $offset . ',whence=' . $whence);
205 * @return $size Size (in bytes) of file
207 public function size () {
208 $this->partialStub();