/**
* A class for writing files
*
- * @author Roland Haeder <webmaster@mxchange.org>
+ * @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
* @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
$this->setObjectDescription("Handler for writing to files");
// Create unique ID
- $this->createUniqueID();
+ $this->generateUniqueId();
// Clean-up a little
$this->removeNumberFormaters();
* 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 $mode The output mode ('w', 'a' are valid)
+ * @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
+ * resource
* @return void
*/
public final static function createFrameworkFileOutputPointer ($fileName, $mode) {
/**
* Write data to a file pointer
*
- * @param $dataStream The data stream we shall write to the file
- * @return mixed The result of fwrite()
+ * @param $dataStream The data stream we shall write to the file
+ * @return mixed The result of fwrite()
* @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
+ * an invalid file resource
*/
public function writeToFile ($dataStream) {
if (is_null($this->getPointer())) {
*
* @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 () {
/**
* Setter for the file pointer
*
- * @param $filePointer File resource
+ * @param $filePointer File resource
* @return void
*/
public final function setPointer ($filePointer) {
* 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;
/**
* Setter for file name
*
- * @param $fileName The new file name
+ * @param $fileName The new file name
* @return void
*/
public final function setFileName ($fileName) {
/**
* Getter for file name
*
- * @return $fileName The current file name
+ * @return $fileName The current file name
*/
public final function getFileName () {
return $this->fileName;