Added new classes + moved some in sub folders:

[core.git] / inc / classes / main / file_directories / class_BaseFile.php

diff --git a/inc/classes/main/file_directories/class_BaseFile.php b/inc/classes/main/file_directories/class_BaseFile.php
index bcc61661bba3d15533f1bbb5c51632daebf1dc7f..0d1bb418ea9be169b0357cf5b607718cbaaa46af 100644 (file)
--- a/inc/classes/main/file_directories/class_BaseFile.php
+++ b/inc/classes/main/file_directories/class_BaseFile.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @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
  *
@@ -22,6 +22,11 @@
  * 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
         */
@@ -52,17 +57,54 @@ class BaseFile extends BaseFrameworkSystem {
        }
 
        /**
-        * Close a file source and set it's instance to null and the file name
-        * to empty
+        * "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
-        * @todo        ~10% done?
         */
-       public function closeFile () {
-               $this->partialStub('Unfinished method.');
+       protected final function setCounter ($counter) {
+               // Set it
+               $this->totalEntries = $counter;
+       }
 
-               // Remove file name
-               $this->setFileName('');
+       /**
+        * 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);
        }
 
        /**
@@ -86,25 +128,17 @@ class BaseFile extends BaseFrameworkSystem {
        }
 
        /**
-        * Determines seek position
+        * Close a file source and set it's instance to null and the file name
+        * to empty
         *
-        * @return      $seekPosition   Current seek position
-        * @todo        0% done
+        * @return      void
+        * @todo        ~10% done?
         */
-       public final function determineSeekPosition () {
+       public function closeFile () {
                $this->partialStub('Unfinished method.');
-       }
 
-       /**
-        * Seek to given offset (default) or other possibilities as fseek() gives.
-        *
-        * @param       $offset         Offset to seek to (or used as "base" for other seeks)
-        * @param       $whence         Added to offset (default: only use offset to seek to)
-        * @return      $status         Status of file seek: 0 = success, -1 = failed
-        * @todo        0% done
-        */
-       public function seek ($offset, $whence = SEEK_SET) {
-               $this->partialStub('Unfinished method.');
+               // Remove file name
+               $this->setFileName('');
        }
 
        /**
@@ -112,10 +146,48 @@ class BaseFile extends BaseFrameworkSystem {
         *
         * @return      $size   Size (in bytes) of file
         * @todo        Handle seekStatus
-        * @todo        0% done
         */
        public function size () {
-               $this->partialStub('Unfinished method.');
+               // 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();
        }
 }