Added abstraction classes for file-based stacks and index files, some setter

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

diff --git a/inc/classes/main/file_directories/class_BaseFileIo.php b/inc/classes/main/file_directories/class_BaseFileIo.php
index cce45b80904c0435854b5ba26d5f4fcd86f5e9ee..cd07f7fbc42123c816b63a7055d2d79b42a95950 100644 (file)
--- a/inc/classes/main/file_directories/class_BaseFileIo.php
+++ b/inc/classes/main/file_directories/class_BaseFileIo.php
@@ -89,7 +89,7 @@ class BaseFileIo extends BaseFrameworkSystem {
         * @param       $filePointer    File resource
         * @return      void
         */
-       public final function setPointer ($filePointer) {
+       protected final function setPointer ($filePointer) {
                $this->filePointer = $filePointer;
        }
 
@@ -109,7 +109,7 @@ class BaseFileIo extends BaseFrameworkSystem {
         * @param       $fileName       The new file name
         * @return      void
         */
-       public final function setFileName ($fileName) {
+       protected final function setFileName ($fileName) {
                $fileName = (string) $fileName;
                $this->fileName = $fileName;
        }
@@ -124,11 +124,11 @@ class BaseFileIo extends BaseFrameworkSystem {
        }
 
        /**
-        * "Getter" for seek position
+        * Determines seek position
         *
         * @return      $seekPosition   Current seek position
         */
-       public final function getSeekPosition () {
+       public final function determineSeekPosition () {
                return ftell($this->getPointer());
        }
 
@@ -144,7 +144,7 @@ class BaseFileIo extends BaseFrameworkSystem {
                $status = fseek($this->getPointer(), $offset, $whence);
 
                // Return status
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] status=%d', __METHOD__, __LINE__, $status));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] status=%d', __METHOD__, __LINE__, $status));
                return $status;
        }
 
@@ -152,25 +152,26 @@ class BaseFileIo extends BaseFrameworkSystem {
         * Size of this file
         *
         * @return      $size   Size (in bytes) of file
+        * @todo        Handle seekStatus
         */
        public function size () {
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
 
                // Get current seek position
-               $seekPosition = $this->getSeekPosition();
+               $seekPosition = $this->determineSeekPosition();
 
                // Seek to end
                $seekStatus = $this->seek(0, SEEK_END);
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
 
                // Get position again  (which is the end of the file)
-               $size = $this->getSeekPosition();
+               $size = $this->determineSeekPosition();
 
                // Reset seek position to old
                $this->seek($seekPosition);
 
                // Return size
-               /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] size=%s - EXIT!', __METHOD__, __LINE__, $size));
+               //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] size=%s - EXIT!', __METHOD__, __LINE__, $size));
                return $size;
        }
 }