X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fio%2Fclass_FrameworkFileInputPointer.php;h=172c02f700c366475b4d51eb89a53c1c5ef180aa;hb=c59dccf46c5d0e3b7f2687370b2b15023b1ecdfe;hp=25c77cb838aeebef89e9b665c76b1472e62fbeb3;hpb=e2767d5148436d0c90ed66ed9290416353ae6e60;p=hub.git diff --git a/inc/classes/main/io/class_FrameworkFileInputPointer.php b/inc/classes/main/io/class_FrameworkFileInputPointer.php index 25c77cb83..172c02f70 100644 --- a/inc/classes/main/io/class_FrameworkFileInputPointer.php +++ b/inc/classes/main/io/class_FrameworkFileInputPointer.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -34,23 +34,22 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { /** * Protected constructor + * + * @return void */ protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); - // Set part description - $this->setObjectDescription("Handler for reading from files"); - - // Create unique ID - $this->generateUniqueId(); - // Clean-up a little $this->removeNumberFormaters(); + $this->removeSystemArray(); } /** * Destructor for cleaning purposes, etc + * + * @return void */ public final function __destruct() { // Is there a resource pointer? Then we have to close the file here! @@ -67,26 +66,31 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { * 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 $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 FilePointerNotOpenedException If fopen() returns not a + * file resource * @return void */ public final static function createFrameworkFileInputPointer ($fileName) { // Some pre-sanity checks... - if (is_null($fileName)) { + if ((is_null($fileName)) || (empty($fileName))) { // No filename given 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); + } 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 (($filePointer === null) || ($filePointer === false)) { + if ((is_null($filePointer)) || ($filePointer === false)) { // Something bad happend throw new FilePointerNotOpenedException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID); - } + } // END - if // Create new instance $pointerInstance = new FrameworkFileInputPointer(); @@ -104,7 +108,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { * * @return mixed The result of fread() * @throws NullPointerException If the file pointer instance - * is not set by setPointer() + * is not set by setPointer() * @throws InvalidFileResourceException If there is being set * an invalid file resource */ @@ -126,7 +130,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { * * @return mixed The result of fread() * @throws NullPointerException If the file pointer instance - * is not set by setPointer() + * is not set by setPointer() * @throws InvalidFileResourceException If there is being set * an invalid file resource */ @@ -149,7 +153,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { * * @return void * @throws NullPointerException If the file pointer instance - * is not set by setPointer() + * is not set by setPointer() * @throws InvalidFileResourceException If there is being set */ public function closeFile () { @@ -170,7 +174,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { /** * Setter for the file pointer * - * @param $filePointer File resource + * @param $filePointer File resource * @return void */ public final function setPointer ($filePointer) { @@ -188,7 +192,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { * Getter for the file pointer * * @return $filePointer The file pointer which shall be a valid - * file resource + * file resource */ public final function getPointer () { return $this->filePointer; @@ -197,7 +201,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { /** * Setter for file name * - * @param $fileName The new file name + * @param $fileName The new file name * @return void */ public final function setFileName ($fileName) { @@ -208,7 +212,7 @@ class FrameworkFileInputPointer extends BaseFrameworkSystem { /** * Getter for file name * - * @return $fileName The current file name + * @return $fileName The current file name */ public final function getFileName () { return $this->fileName;