--- /dev/null
+<?php
+/**
+ * This is a file IO handler. It handles reading from and writing to files.
+ * Missing paths in writing process will be automatically created.
+ *
+ * @author Roland Haeder <webmaster@shipsimu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
+ * @license GNU GPL 3.0 or any newer version
+ * @link http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class FileIoHandler extends BaseMiddleware implements IoHandler {
+ /**
+ * The *real* file input class we shall use for reading data
+ */
+ private $inputStream = NULL;
+
+ /**
+ * The *real* file output class we shall use for reading data
+ */
+ private $outputStream = NULL;
+
+ /**
+ * An instance of this class
+ */
+ private static $selfInstance = NULL;
+
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Set own instance
+ self::$selfInstance = $this;
+ }
+
+ /**
+ * Creates an instance of this class and prepares the IO system. This is
+ * being done by setting the default file IO class
+ *
+ * @return $ioInstance A prepared instance of FilIOHandler
+ */
+ public static final function createFileIoHandler () {
+ // Get instance
+ $ioHandler = new FileIoHandler();
+
+ // Set the *real* file IO instances (both the same)
+ $ioHandler->setInputStream(ObjectFactory::createObjectByConfiguredName('file_input_class'));
+ $ioHandler->setOutputStream(ObjectFactory::createObjectByConfiguredName('file_output_class'));
+
+ // Return instance
+ return $ioHandler;
+ }
+
+ /**
+ * Getter for an instance of this class
+ *
+ * @return $selfInstance An instance of this class
+ */
+ public static final function getSelfInstance () {
+ return self::$selfInstance;
+ }
+
+ /**
+ * Setter for the *real* file input instance
+ *
+ * @param $inputStream The *real* file-input class
+ * @return void
+ */
+ public final function setInputStream (FileInputStreamer $inputStream) {
+ $this->inputStream = $inputStream;
+ }
+
+ /**
+ * Getter for the *real* file input instance
+ *
+ * @return $inputStream The *real* file-input class
+ */
+ public final function getInputStream () {
+ return $this->inputStream;
+ }
+
+ /**
+ * Setter for the *real* file output instance
+ *
+ * @param $outputStream The *real* file-output class
+ * @return void
+ */
+ public final function setOutputStream (FileOutputStreamer $outputStream) {
+ $this->outputStream = $outputStream;
+ }
+
+ /**
+ * Getter for the *real* file output instance
+ *
+ * @return $outputStream The *real* file-output class
+ */
+ public final function getOutputStream () {
+ return $this->outputStream;
+ }
+ /**
+ * Saves streamed (that are mostly serialized objects) data to files or
+ * external servers.
+ *
+ * @param $fileName The local file's name including full path
+ * @param $dataArray Array containing the compressor's extension and streamed data
+ * @return void
+ * @throws UnsupportedOperationException If this method is called
+ */
+ public function saveFile ($fileName, array $dataArray) {
+ self::createDebugInstance(__CLASS__)->debugOutput('fileName=' . $fileName . ',dataArray()=' . count($dataArray));
+ throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+ }
+
+ /**
+ * Saves a file with data by using the current output stream
+ *
+ * @param $fileName Name of the file
+ * @param $dataStream File data stream
+ * @param $objectInstance An instance of a FrameworkInterface class (default: NULL)
+ * @return void
+ */
+ public function saveStreamToFile ($fileName, $dataStream, FrameworkInterface $objectInstance = NULL) {
+ // Default is this array
+ $className = $this->__toString();
+
+ // Is the object instance set?
+ if ($objectInstance instanceof FrameworkInterface) {
+ // Then use this
+ $className = $objectInstance->__toString();
+ } // END - if
+
+ // Prepare output array
+ $dataArray = array(
+ 0 => $className,
+ 1 => $dataStream
+ );
+
+ // Send the fileName and dataArray to the output handler
+ $this->getOutputStream()->saveFile($fileName, $dataArray);
+ }
+
+ /** Loads data from a file over the input handler
+ *
+ * @param $fqfn Given full-qualified file name (FQFN) to load
+ * @return $array Array with the file contents
+ */
+ public function loadFileContents ($fqfn) {
+ // Read from the input handler
+ return $this->getInputStream()->loadFileContents($fqfn);
+ }
+
+ /**
+ * Determines seek position
+ *
+ * @return $seekPosition Current seek position
+ * @todo 0% done
+ */
+ public function determineSeekPosition () {
+ $this->partialStub();
+ }
+
+ /**
+ * Seek to given offset (default) or other possibilities as fseek() gives.
+ *
+ * @param $offset Offset to seek to (or used as "base" for other seeks)
+ * @param $whence Added to offset (default: only use offset to seek to)
+ * @return $status Status of file seek: 0 = success, -1 = failed
+ */
+ public function seek ($offset, $whence = SEEK_SET) {
+ $this->partialStub('offset=' . $offset . ',whence=' . $whence);
+ }
+
+ /**
+ * Size of file stack
+ *
+ * @return $size Size (in bytes) of file
+ */
+ public function size () {
+ $this->partialStub();
+ }
+}
+
+// [EOF]
+?>
projects / core.git / blobdiff