inc/classes/interfaces/block/class_Block.php

   1 <?php
   2 /**
   3  * A block interface
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface Block extends FrameworkInterface {
  25         /**
  26          * Reads the file header
  27          *
  28          * @return      void
  29          */
  30         function readFileHeader ();
  31
  32         /**
  33          * Flushes the file header
  34          *
  35          * @return      void
  36          */
  37         function flushFileHeader ();
  38
  39         /**
  40          * Close a file source and set it's instance to null and the file name
  41          * to empty.
  42          *
  43          * @return      void
  44          * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
  45          * @throws      InvalidResourceException        If there is being set
  46          */
  47         function closeFile ();
  48
  49         /**
  50          * Determines whether the EOF has been reached
  51          *
  52          * @return      $isEndOfFileReached             Whether the EOF has been reached
  53          */
  54         function isEndOfFileReached ();
  55
  56         /**
  57          * Getter for file name
  58          *
  59          * @return      $fileName       The current file name
  60          */
  61         function getFileName ();
  62 }
  63
  64 // [EOF]
  65 ?>