X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fio%2Fclass_FrameworkFileOutputPointer.php;h=8d80e71593d9382f3b1c2e01eb582617652fd0ea;hp=bc69bea5ea240eb053a29c4ae0b60666cfdb2414;hb=3823de7144fa4f53fd520520f1ce51f1d12c2af8;hpb=2c0148a84570f1a8343fa6b98a279e903b3e4fa2

diff --git a/inc/classes/main/io/class_FrameworkFileOutputPointer.php b/inc/classes/main/io/class_FrameworkFileOutputPointer.php
index bc69bea5..8d80e715 100644
--- a/inc/classes/main/io/class_FrameworkFileOutputPointer.php
+++ b/inc/classes/main/io/class_FrameworkFileOutputPointer.php
@@ -2,11 +2,11 @@
 /**
  * A class for writing files
  *
- * @author		Roland Haeder <webmaster@ship-simu.org>
+ * @author		Roland Haeder <webmaster@shipsimu.org>
  * @version		0.0.0
- * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @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 FrameworkFileOutputPointer extends BaseFrameworkSystem {
 	/**
 	 * The file pointer
 	 */
-	private $filePointer = null;
+	private $filePointer = NULL;
 
 	/**
 	 * Protected constructor
@@ -61,23 +61,22 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
 	 * @param	$fileName	The file name we shall pass to fopen()
 	 * @param	$mode		The output mode ('w', 'a' are valid)
 	 * @throws	FileIsEmptyException	If the provided file name is empty.
-	 * @throws	FilePointerNotOpened	If fopen() returns not a file
-	 *									resource
+	 * @throws	FileIoException		If fopen() returns not a file resource
 	 * @return	void
 	 */
-	public final static function createFrameworkFileOutputPointer ($fileName, $mode) {
+	public static final function createFrameworkFileOutputPointer ($fileName, $mode) {
 		// Some pre-sanity checks...
 		if (is_null($fileName)) {
 			// No filename given
-			throw new FileIsEmptyException(null, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-		}
+			throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
+		} // END - if
 
 		// Try to open a handler
 		$filePointer = @fopen($fileName, $mode);
-		if (($filePointer === null) || ($filePointer === false)) {
+		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
 		$pointerInstance = new FrameworkFileOutputPointer();
@@ -94,7 +93,7 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
 	 * Write data to a file pointer
 	 *
 	 * @param	$dataStream		The data stream we shall write to the file
-	 * @return	mixed			The result of fwrite()
+	 * @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
@@ -109,7 +108,7 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
 			throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 		}
 
-		// Read data from the file pointer and return it
+		// Write data to the file pointer and return written bytes
 		return fwrite($this->getPointer(), $dataStream);
 	}
 
@@ -133,7 +132,7 @@ class FrameworkFileOutputPointer extends BaseFrameworkSystem {
 
 		// Close the file pointer and reset the instance variable
 		@fclose($this->getPointer());
-		$this->setPointer(null);
+		$this->setPointer(NULL);
 		$this->setFileName('');
 	}