Renamed BaseFile to BaseAbstractFile to make it more clear that this class is
authorRoland Haeder <roland@mxchange.org>
Tue, 10 Mar 2015 00:40:30 +0000 (01:40 +0100)
committerRoland Haeder <roland@mxchange.org>
Tue, 10 Mar 2015 00:40:30 +0000 (01:40 +0100)
an abstracted file and is not responsible for the actual I/O (which is done by
the linked pointer instance).

Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/main/file_directories/binary/class_BaseBinaryFile.php
inc/classes/main/file_directories/class_BaseAbstractFile.php [new file with mode: 0644]
inc/classes/main/file_directories/class_BaseFile.php [deleted file]
inc/classes/main/file_directories/class_BaseFileIo.php
inc/classes/main/file_directories/text/class_BaseTextFile.php
inc/classes/main/file_directories/text/output/class_BaseOutputTextFile.php

index 207f797..678bf45 100644 (file)
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class BaseBinaryFile extends BaseFile {
+class BaseBinaryFile extends BaseAbstractFile {
        /**
         * Separator for header data
         */
diff --git a/inc/classes/main/file_directories/class_BaseAbstractFile.php b/inc/classes/main/file_directories/class_BaseAbstractFile.php
new file mode 100644 (file)
index 0000000..ee91ef1
--- /dev/null
@@ -0,0 +1,198 @@
+<?php
+/**
+ * An abstract file class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+class BaseAbstractFile extends BaseFrameworkSystem {
+       /**
+        * Counter for total entries
+        */
+       private $totalEntries = 0;
+
+       /**
+        * The current file we are working in
+        */
+       private $fileName = '';
+
+       /**
+        * Protected constructor
+        *
+        * @param       $className      Name of the class
+        * @return      void
+        */
+       protected function __construct ($className) {
+               // Call parent constructor
+               parent::__construct($className);
+       }
+
+       /**
+        * Destructor for cleaning purposes, etc
+        *
+        * @return      void
+        */
+       public final function __destruct() {
+               // Try to close a file
+               $this->closeFile();
+
+               // Call the parent destructor
+               parent::__destruct();
+       }
+
+       /**
+        * "Getter" for abstracted file size
+        *
+        * @return      $fileSize       Size of abstracted file
+        */
+       public function getFileSize () {
+               // Call pointer instanze
+               return $this->getPointerInstance()->getFileSize();
+       }
+
+       /**
+        * Getter for total entries
+        *
+        * @return      $totalEntries   Total entries in this file
+        */
+       public final function getCounter () {
+               // Get it
+               return $this->totalEntries;
+       }
+
+       /**
+        * Setter for total entries
+        *
+        * @param       $totalEntries   Total entries in this file
+        * @return      void
+        */
+       protected final function setCounter ($counter) {
+               // Set it
+               $this->totalEntries = $counter;
+       }
+
+       /**
+        * Increment counter
+        *
+        * @return      void
+        */
+       protected final function incrementCounter () {
+               // Get it
+               $this->totalEntries++;
+       }
+
+       /**
+        * Getter for the file pointer
+        *
+        * @return      $filePointer    The file pointer which shall be a valid file resource
+        * @throws      UnsupportedOperationException   If this method is called
+        */
+       public final function getPointer () {
+               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
+       }
+
+       /**
+        * Setter for file name
+        *
+        * @param       $fileName       The new file name
+        * @return      void
+        */
+       protected final function setFileName ($fileName) {
+               $fileName = (string) $fileName;
+               $this->fileName = $fileName;
+       }
+
+       /**
+        * Getter for file name
+        *
+        * @return      $fileName       The current file name
+        */
+       public final function getFileName () {
+               return $this->fileName;
+       }
+
+       /**
+        * Close a file source and set it's instance to null and the file name
+        * to empty
+        *
+        * @return      void
+        */
+       public function closeFile () {
+               // Debug message
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
+
+               // Remove file name
+               $this->setFileName('');
+
+               // Debug message
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
+       }
+
+       /**
+        * Size of this file
+        *
+        * @return      $size   Size (in bytes) of file
+        * @todo        Handle seekStatus
+        */
+       public function size () {
+               // Call pointer instance
+               return $this->getPointerInstance()->size();
+       }
+
+       /**
+        * Read data a file pointer
+        *
+        * @return      mixed   The result of fread()
+        * @throws      NullPointerException    If the file pointer instance
+        *                                                                      is not set by setPointer()
+        * @throws      InvalidResourceException        If there is being set
+        */
+       public function readFromFile () {
+               // Call pointer instance
+               return $this->getPointerInstance()->readFromFile();
+       }
+
+       /**
+        * 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
+        */
+       public function writeToFile ($dataStream) {
+               // Call pointer instance
+               return $this->getPointerInstance()->writeToFile($dataStream);
+       }
+
+       /**
+        * Determines whether the EOF has been reached
+        *
+        * @return      $isEndOfFileReached             Whether the EOF has been reached
+        */
+       public final function isEndOfFileReached () {
+               // Call pointer instance
+               return $this->getPointerInstance()->isEndOfFileReached();
+       }
+}
+
+// [EOF]
+?>
diff --git a/inc/classes/main/file_directories/class_BaseFile.php b/inc/classes/main/file_directories/class_BaseFile.php
deleted file mode 100644 (file)
index 0d1bb41..0000000
+++ /dev/null
@@ -1,195 +0,0 @@
-<?php
-/**
- * A general file class
- *
- * @author             Roland Haeder <webmaster@ship-simu.org>
- * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
- * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.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
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-class BaseFile extends BaseFrameworkSystem {
-       /**
-        * Counter for total entries
-        */
-       private $totalEntries = 0;
-
-       /**
-        * The current file we are working in
-        */
-       private $fileName = '';
-
-       /**
-        * Protected constructor
-        *
-        * @param       $className      Name of the class
-        * @return      void
-        */
-       protected function __construct ($className) {
-               // Call parent constructor
-               parent::__construct($className);
-       }
-
-       /**
-        * Destructor for cleaning purposes, etc
-        *
-        * @return      void
-        */
-       public final function __destruct() {
-               // Try to close a file
-               $this->closeFile();
-
-               // Call the parent destructor
-               parent::__destruct();
-       }
-
-       /**
-        * "Getter" for abstracted file size
-        *
-        * @return      $fileSize       Size of abstracted file
-        */
-       public function getFileSize () {
-               // Call pointer instanze
-               return $this->getPointerInstance()->getFileSize();
-       }
-
-       /**
-        * Getter for total entries
-        *
-        * @return      $totalEntries   Total entries in this file
-        */
-       public final function getCounter () {
-               // Get it
-               return $this->totalEntries;
-       }
-
-       /**
-        * Setter for total entries
-        *
-        * @param       $totalEntries   Total entries in this file
-        * @return      void
-        */
-       protected final function setCounter ($counter) {
-               // Set it
-               $this->totalEntries = $counter;
-       }
-
-       /**
-        * Increment counter
-        *
-        * @return      void
-        */
-       protected final function incrementCounter () {
-               // Get it
-               $this->totalEntries++;
-       }
-
-       /**
-        * Getter for the file pointer
-        *
-        * @return      $filePointer    The file pointer which shall be a valid file resource
-        * @throws      UnsupportedOperationException   If this method is called
-        */
-       public final function getPointer () {
-               throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
-       }
-
-       /**
-        * Setter for file name
-        *
-        * @param       $fileName       The new file name
-        * @return      void
-        */
-       protected final function setFileName ($fileName) {
-               $fileName = (string) $fileName;
-               $this->fileName = $fileName;
-       }
-
-       /**
-        * Getter for file name
-        *
-        * @return      $fileName       The current file name
-        */
-       public final function getFileName () {
-               return $this->fileName;
-       }
-
-       /**
-        * Close a file source and set it's instance to null and the file name
-        * to empty
-        *
-        * @return      void
-        * @todo        ~10% done?
-        */
-       public function closeFile () {
-               $this->partialStub('Unfinished method.');
-
-               // Remove file name
-               $this->setFileName('');
-       }
-
-       /**
-        * Size of this file
-        *
-        * @return      $size   Size (in bytes) of file
-        * @todo        Handle seekStatus
-        */
-       public function size () {
-               // Call pointer instance
-               return $this->getPointerInstance()->size();
-       }
-
-       /**
-        * Read data a file pointer
-        *
-        * @return      mixed   The result of fread()
-        * @throws      NullPointerException    If the file pointer instance
-        *                                                                      is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
-        */
-       public function readFromFile () {
-               // Call pointer instance
-               return $this->getPointerInstance()->readFromFile();
-       }
-
-       /**
-        * 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
-        */
-       public function writeToFile ($dataStream) {
-               // Call pointer instance
-               return $this->getPointerInstance()->writeToFile($dataStream);
-       }
-
-       /**
-        * Determines whether the EOF has been reached
-        *
-        * @return      $isEndOfFileReached             Whether the EOF has been reached
-        */
-       public final function isEndOfFileReached () {
-               // Call pointer instance
-               return $this->getPointerInstance()->isEndOfFileReached();
-       }
-}
-
-// [EOF]
-?>
index f449f11..e1b7c50 100644 (file)
@@ -68,6 +68,9 @@ class BaseFileIo extends BaseFrameworkSystem {
         * @throws      InvalidResourceException        If there is being set
         */
        public function closeFile () {
+               // Debug message
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
+
                if (is_null($this->getPointer())) {
                        // Pointer not initialized
                        throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
@@ -80,6 +83,9 @@ class BaseFileIo extends BaseFrameworkSystem {
                @fclose($this->getPointer());
                $this->setPointer(NULL);
                $this->setFileName('');
+
+               // Debug message
+               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
        }
 
        /**
index 1c15afa..1d30673 100644 (file)
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class BaseTextFile extends BaseFile {
+class BaseTextFile extends BaseAbstractFile {
        /**
         * Protected constructor
         *
index 63052f0..1a5bbaf 100644 (file)
@@ -21,7 +21,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-class BaseOutputTextFile extends BaseFile {
+class BaseOutputTextFile extends BaseAbstractFile {
        /**
         * Protected constructor
         *