More cleanups of public closeFile() method as it is private now and shall only

[core.git] / inc / classes / interfaces / block / class_Block.php

diff --git a/inc/classes/interfaces/block/class_Block.php b/inc/classes/interfaces/block/class_Block.php
index 59b9f4fc9c93c44e47ca472a18ad2af57a7dcdff..32cad9101d7714c66024516efa622dccb615b8da 100644 (file)
--- a/inc/classes/interfaces/block/class_Block.php
+++ b/inc/classes/interfaces/block/class_Block.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 - 2015 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -36,16 +36,6 @@ interface Block extends FrameworkInterface {
         */
        function flushFileHeader ();
 
-       /**
-        * Close a file source and set it's instance to null and the file name
-        * to empty.
-        *
-        * @return      void
-        * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
-        * @throws      InvalidResourceException        If there is being set
-        */
-       function closeFile ();
-
        /**
         * Determines whether the EOF has been reached
         *
@@ -59,6 +49,67 @@ interface Block extends FrameworkInterface {
         * @return      $fileName       The current file name
         */
        function getFileName ();
+
+       /**
+        * 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 ();
 }
 
 // [EOF]