Copyright year updated, converted double->single quotes

[core.git] / inc / classes / main / io / class_FrameworkFileInputPointer.php

diff --git a/inc/classes/main/io/class_FrameworkFileInputPointer.php b/inc/classes/main/io/class_FrameworkFileInputPointer.php
index 8098d60425e436a6a468e1ad622322a56e00fc28..f46e48aea921e1d7848aec1d93588f25dfcad0c2 100644 (file)
--- a/inc/classes/main/io/class_FrameworkFileInputPointer.php
+++ b/inc/classes/main/io/class_FrameworkFileInputPointer.php
@@ -2,11 +2,11 @@
 /**
  * A class for reading files
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @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
@@ -30,7 +30,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
        /**
         * The file pointer
         */
-       private $filePointer = null;
+       private $filePointer = NULL;
 
        /**
         * Protected constructor
@@ -40,10 +40,6 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Clean-up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
@@ -68,28 +64,27 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         *
         * @param               $fileName       The file name we shall pass to fopen()
         * @throws      FileIsEmptyException    If the provided file name is empty.
-        * @throws      FilePointerNotOpenedException   If fopen() returns not a
-        *                                                                                      file resource
+        * @throws      FileIoException         If fopen() returns not a file resource
         * @return      void
         */
-       public final static function createFrameworkFileInputPointer ($fileName) {
+       public static final function createFrameworkFileInputPointer ($fileName) {
                // Some pre-sanity checks...
                if ((is_null($fileName)) || (empty($fileName))) {
                        // No filename given
-                       throw new FileIsEmptyException(null, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+                       throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
                } elseif (!file_exists($fileName)) {
                        // File does not exist!
-                       throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
+                       throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
                } elseif (!is_readable($fileName)) {
                        // File does not exist!
                        throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
                }
 
                // Try to open a handler
-               $filePointer = @fopen($fileName, 'rb');
-               if ((is_null($filePointer)) || ($filePointer === false)) {
+               $filePointer = fopen($fileName, 'rb');
+               if ((is_null($filePointer)) || ($filePointer === FALSE)) {
                        // Something bad happend
-                       throw new FilePointerNotOpenedException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
+                       throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
                } // END - if
 
                // Create new instance
@@ -109,7 +104,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         * @return      mixed   The result of fread()
         * @throws      NullPointerException    If the file pointer instance
         *                                                                      is not set by setPointer()
-        * @throws      InvalidFileResourceException    If there is being set
+        * @throws      InvalidResourceException        If there is being set
         *                                                                      an invalid file resource
         */
        public function readFromFile () {
@@ -118,35 +113,13 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                } elseif (!is_resource($this->getPointer())) {
                        // Pointer is not a valid resource!
-                       throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
+                       throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
                }
 
                // Read data from the file pointer and return it
                return fread($this->getPointer(), 1024);
        }
 
-       /**
-        * Read lines from a file pointer
-        *
-        * @return      mixed   The result of fread()
-        * @throws      NullPointerException    If the file pointer instance
-        *                                                                      is not set by setPointer()
-        * @throws      InvalidFileResourceException    If there is being set
-        *                                                                      an invalid file resource
-        */
-       public function readLinesFromFile () {
-               if (is_null($this->getPointer())) {
-                       // Pointer not initialized
-                       throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
-               } elseif (!is_resource($this->getPointer())) {
-                       // Pointer is not a valid resource!
-                       throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
-               }
-
-               // Read data from the file pointer and return it
-               return fgets($this->getPointer(), 1024);
-       }
-
        /**
         * Close a file source and set it's instance to null and the file name
         * to empty
@@ -154,7 +127,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
         * @return      void
         * @throws      NullPointerException    If the file pointer instance
         *                                                                      is not set by setPointer()
-        * @throws      InvalidFileResourceException    If there is being set
+        * @throws      InvalidResourceException        If there is being set
         */
        public function closeFile () {
                if (is_null($this->getPointer())) {
@@ -162,12 +135,12 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
                } elseif (!is_resource($this->getPointer())) {
                        // Pointer is not a valid resource!
-                       throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
+                       throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
                }
 
                // Close the file pointer and reset the instance variable
                @fclose($this->getPointer());
-               $this->setPointer(null);
+               $this->setPointer(NULL);
                $this->setFileName('');
        }
 
@@ -184,7 +157,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem {
                        $this->filePointer = $filePointer;
                } else {
                        // Throw exception
-                       throw new InvalidFileResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
+                       throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
                }
        }