]> git.mxchange.org Git - core.git/blobdiff - inc/classes/interfaces/block/class_Block.php
Renamed more and moved code to Block interface.
[core.git] / inc / classes / interfaces / block / class_Block.php
index 88e0e23e696885375fd6377c34c3ee83745005cf..59b9f4fc9c93c44e47ca472a18ad2af57a7dcdff 100644 (file)
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface Block extends FrameworkInterface {
-       /**
-        * Checks whether the block separator has been found
-        *
-        * @param       $str            String to look in
-        * @return      $isFound        Whether the block separator has been found
-        */
-       function isBlockSeparatorFound ($str);
-
        /**
         * Reads the file header
         *
@@ -43,6 +35,30 @@ interface Block extends FrameworkInterface {
         * @return      void
         */
        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
+        *
+        * @return      $isEndOfFileReached             Whether the EOF has been reached
+        */
+       function isEndOfFileReached ();
+
+       /**
+        * Getter for file name
+        *
+        * @return      $fileName       The current file name
+        */
+       function getFileName ();
 }
 
 // [EOF]