Rewritten:

[core.git] / framework / main / classes / file_directories / output / raw / class_FrameworkRawFileOutputPointer.php

diff --git a/framework/main/classes/file_directories/output/raw/class_FrameworkRawFileOutputPointer.php b/framework/main/classes/file_directories/output/raw/class_FrameworkRawFileOutputPointer.php
index d54966d83ca4beebd26ed5d012ac14d9e7ead30f..a63535c69616164b422eb34c3f927c540f98b705 100644 (file)
--- a/framework/main/classes/file_directories/output/raw/class_FrameworkRawFileOutputPointer.php
+++ b/framework/main/classes/file_directories/output/raw/class_FrameworkRawFileOutputPointer.php
@@ -1,12 +1,15 @@
 <?php
 // Own namespace
-namespace CoreFramework\Filesystem\Pointer\Raw;
+namespace CoreFramework\Filesystem\Pointer\Output;
 
 // Import framework stuff
 use CoreFramework\FileSystem\BaseFileIo;
 use CoreFramework\Filesystem\Pointer\OutputPointer;
 use CoreFramework\Generic\NullPointerException;
 
+// Import SPL stuff
+use \SplFileInfo;
+
 /**
  * A class for writing files
  *
@@ -44,32 +47,31 @@ class FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer
         * 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()
+        * @param       $infoInstance   An instance of a SplFileInfo class
         * @param       $mode           The output mode ('w', 'a' are valid)
         * @throws      FileIsEmptyException    If the provided file name is empty.
         * @throws      FileIoException                 If fopen() returns not a file resource
         * @return      void
         */
-       public static final function createFrameworkRawFileOutputPointer ($fileName, $mode) {
+       public static final function createFrameworkRawFileOutputPointer (SplFileInfo $infoInstance, $mode) {
                // Some pre-sanity checks...
-               if (is_null($fileName)) {
-                       // No filename given
+               if (is_null($infoInstance)) {
+                       // No infoInstance given
                        throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } // END - if
 
                // Try to open a handler
-               $filePointer = @fopen($fileName, $mode);
-               if ((is_null($filePointer)) || ($filePointer === FALSE)) {
+               $fileObject = $infoInstance->openFile($mode);
+               if ((is_null($fileObject)) || ($fileObject === false)) {
                        // 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 FrameworkRawFileOutputPointer();
 
                // Set file pointer and file name
-               $pointerInstance->setPointer($filePointer);
-               $pointerInstance->setFileName($fileName);
+               $pointerInstance->setFileObject($fileObject);
 
                // Return the instance
                return $pointerInstance;
@@ -79,23 +81,21 @@ class FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer
         * Write data to a file pointer
         *
         * @param       $dataStream             The data stream we shall write to the file
-        * @return      mixed                   Number of writes bytes or FALSE on error
-        * @throws      NullPointerException    If the file pointer instance
-        *                                                                      is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
-        *                                                                                      an invalid file resource
+        * @return      mixed                   Number of writes bytes or false on error
+        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
+        * @throws      LogicException  If there is no object being set
         */
        public function writeToFile ($dataStream) {
-               if (is_null($this->getPointer())) {
+               if (is_null($this->getFileObject())) {
                        // 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!
-                       throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
+                       throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
                }
 
                // Write data to the file pointer and return written bytes
-               return fwrite($this->getPointer(), $dataStream);
+               return $this->getFileObject()->fwrite($dataStream);
        }
 
        /**
@@ -115,7 +115,7 @@ class FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer
         *
         * @param       $seekPosition   Seek position in file
         * @param       $data                   Data to be written
-        * @return      mixed                   Number of writes bytes or FALSE on error
+        * @return      mixed                   Number of writes bytes or false on error
         * @throws      UnsupportedOperationException   If this method is called
         */
        public function writeAtPosition ($seedPosition, $data) {
@@ -134,7 +134,7 @@ class FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer
 
        /**
         * Checks wether the current entry is valid (not at the end of the file).
-        * This method will return TRUE if an emptied (nulled) entry has been found.
+        * This method will return true if an emptied (nulled) entry has been found.
         *
         * @return      $isValid        Whether the next entry is valid
         * @throws      UnsupportedOperationException   If this method is called