Also getSeekPosition() belongs here ... + TODOs.txt updated (--amend rocks!)

[core.git] / inc / classes / interfaces / iterator / class_SeekableWritableFileIterator.php

diff --git a/inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php b/inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php
index 263bba6887bef605933e8a9fbee5ec1bd5cd59cd..d5f7c19252de07bbe8764cda26b200114dab4019 100644 (file)
--- a/inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php
+++ b/inc/classes/interfaces/iterator/class_SeekableWritableFileIterator.php
@@ -38,15 +38,6 @@ interface SeekableWritableFileIterator extends SeekableIterator {
         */
        function size ();
 
-       /**
-        * Writes at given position by seeking to it.
-        *
-        * @param       $seekPosition   Seek position in file
-        * @param       $data                   Data to be written
-        * @return      void
-        */
-       function writeAtPosition ($seedPosition, $data);
-
        /**
         * Reads given amount of bytes from file.
         *
@@ -63,6 +54,106 @@ interface SeekableWritableFileIterator extends SeekableIterator {
         * @return      void
         */
        function analyzeFile ();
+
+       /**
+        * Checks whether the file header is initialized
+        *
+        * @return      $isInitialized  Whether the file header is initialized
+        */
+       function isFileHeaderInitialized ();
+
+       /**
+        * Creates the assigned file
+        *
+        * @return      void
+        */
+       function createFileHeader ();
+
+       /**
+        * Pre-allocates file (if enabled) with some space for later faster write access.
+        *
+        * @param       $type   Type of the file
+        * @return      void
+        */
+       function preAllocateFile ($type);
+
+       /**
+        * Initializes counter for valid entries, arrays for damaged entries and
+        * an array for gap seek positions. If you call this method on your own,
+        * please re-analyze the file structure. So you are better to call
+        * analyzeFile() instead of this method.
+        *
+        * @return      void
+        */
+       function initCountersGapsArray ();
+
+       /**
+        * Getter for header size
+        *
+        * @return      $totalEntries   Size of file header
+        */
+       function getHeaderSize ();
+
+       /**
+        * Setter for header size
+        *
+        * @param       $headerSize             Size of file header
+        * @return      void
+        */
+       function setHeaderSize ($headerSize);
+
+       /**
+        * Getter for header array
+        *
+        * @return      $totalEntries   Size of file header
+        */
+       function getHeader ();
+
+       /**
+        * Setter for header
+        *
+        * @param       $header         Array for a file header
+        * @return      void
+        */
+       function setHeader (array $header);
+
+       /**
+        * Updates seekPosition attribute from file to avoid to much access on file.
+        *
+        * @return      void
+        */
+       function updateSeekPosition ();
+
+       /**
+        * Getter for total entries
+        *
+        * @return      $totalEntries   Total entries in this file
+        */
+       function getCounter ();
+
+       /**
+        * "Getter" for file size
+        *
+        * @return      $fileSize       Size of currently loaded file
+        */
+       function getFileSize ();
+
+       /**
+        * Writes data at given position
+        *
+        * @param       $seekPosition   Seek position
+        * @param       $data                   Data to be written
+        * @param       $flushHeader    Whether to flush the header (default: flush)
+        * @return      void
+        */
+       function writeData ($seekPosition, $data, $flushHeader = TRUE);
+
+       /**
+        * Getter for seek position
+        *
+        * @return      $seekPosition   Current seek position (stored here in object)
+        */
+       function getSeekPosition ();
 }
 
 // [EOF]