Rewritten:

[core.git] / framework / main / classes / file_directories / input / raw / class_FrameworkRawFileInputPointer.php

diff --git a/framework/main/classes/file_directories/input/raw/class_FrameworkRawFileInputPointer.php b/framework/main/classes/file_directories/input/raw/class_FrameworkRawFileInputPointer.php
index 728160adecbfe97666a815d8b9d3b76844550e81..3e1635e23af1dc49fe9906d8b6e92cdebbf96c96 100644 (file)
--- a/framework/main/classes/file_directories/input/raw/class_FrameworkRawFileInputPointer.php
+++ b/framework/main/classes/file_directories/input/raw/class_FrameworkRawFileInputPointer.php
@@ -12,6 +12,9 @@ use CoreFramework\Generic\NullPointerException;
 use CoreFramework\Generic\UnsupportedOperationException;
 use CoreFramework\Object\BaseFrameworkSystem;
 
 use CoreFramework\Generic\UnsupportedOperationException;
 use CoreFramework\Object\BaseFrameworkSystem;
 

+// Import SPL stuff
+use \SplFileInfo;
+

 /**
  * A class for reading files
  *
 /**
  * A class for reading files
  *


@@ -49,42 +52,37 @@ class FrameworkRawFileInputPointer extends BaseFileIo implements InputPointer {
         * Create a file pointer based on the given file. The file will also
         * be verified here.
         *
         * Create a file pointer based on the given file. The file will also
         * be verified here.
         *

-        * @param       $fileName       The file name we shall pass to fopen()
-        * @throws      FileIsEmptyException            If the provided file name is empty.
+        * @param       $infoInstance   An instance of a SplFileInfo class

         * @throws      FileIoException                         If the file is not reachable
         * @throws      FileReadProtectedException      If the file is not found or cannot be read
         * @throws      FileNotFoundException           If the file does not exist
         * @return      void
         */
         * @throws      FileIoException                         If the file is not reachable
         * @throws      FileReadProtectedException      If the file is not found or cannot be read
         * @throws      FileNotFoundException           If the file does not exist
         * @return      void
         */

-       public static final function createFrameworkRawFileInputPointer ($fileName) {
+       public static final function createFrameworkRawFileInputPointer (SplFileInfo $infoInstance) {

                // Some pre-sanity checks...
                // Some pre-sanity checks...

-               if ((is_null($fileName)) || (empty($fileName))) {
-                       // No filename given
-                       throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif (!FrameworkBootstrap::isReachableFilePath($fileName)) {
+               if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {

                        // File cannot be accessed (due to open_basedir restriction)
                        // File cannot be accessed (due to open_basedir restriction)

-                       throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
-               } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (file_exists($fileName))) {
-                       // File exists but cannot be read from
-                       throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
-               } elseif ((!FrameworkBootstrap::isReadableFile($fileName)) && (!file_exists($fileName))) {
+                       throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
+               } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {

                        // File does not exist
                        // File does not exist

-                       throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
+                       throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_NOT_FOUND);
+               } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
+                       // File exists but cannot be read from
+                       throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);

                }
 
                // Try to open a handler
                }
 
                // Try to open a handler

-               $filePointer = fopen($fileName, 'rb');
-               if ((is_null($filePointer)) || ($filePointer === false)) {
+               $fileObject = $infoInstance->openFile('rb');
+               if ((is_null($fileObject)) || ($fileObject === false)) {

                        // Something bad happend
                        // Something bad happend

-                       throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
+                       throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);

                } // END - if
 
                // Create new instance
                $pointerInstance = new FrameworkRawFileInputPointer();
 
                // Set file pointer and file name
                } // END - if
 
                // Create new instance
                $pointerInstance = new FrameworkRawFileInputPointer();
 
                // Set file pointer and file name

-               $pointerInstance->setPointer($filePointer);
-               $pointerInstance->setFileName($fileName);
+               $pointerInstance->setFileObject($fileObject);

 
                // Return the instance
                return $pointerInstance;
 
                // Return the instance
                return $pointerInstance;


@@ -94,17 +92,16 @@ class FrameworkRawFileInputPointer extends BaseFileIo implements InputPointer {
         * Read data a file pointer
         *
         * @return      mixed   The result of fread()
         * Read data a file pointer
         *
         * @return      mixed   The result of fread()

-        * @throws      NullPointerException    If the file pointer instance
-        *                                                                      is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
+        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
+        * @throws      LogicException  If there is no object being set

         */
        public function readFromFile () {
         */
        public function readFromFile () {

-               if (is_null($this->getPointer())) {
+               if (is_null($this->getFileObject())) {

                        // Pointer not initialized
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                        // Pointer not initialized
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);

-               } elseif (!is_resource($this->getPointer())) {
+               } elseif (!is_object($this->getFileObject())) {

                        // Pointer is not a valid resource!
                        // Pointer is not a valid resource!

-                       throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
+                       throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));

                }
 
                // Read data from the file pointer and return it
                }
 
                // Read data from the file pointer and return it


@@ -133,7 +130,7 @@ class FrameworkRawFileInputPointer extends BaseFileIo implements InputPointer {
                assert(is_int($bytes));
 
                // Try to read given characters
                assert(is_int($bytes));
 
                // Try to read given characters

-               $data = fread($this->getPointer(), $bytes);
+               $data = $this->getFileObject()->fread($bytes);

 
                // Then return it
                return $data;
 
                // Then return it
                return $data;