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          * Checks whether the block separator has been found
  27          *
  28          * @param       $str            String to look in
  29          * @return      $isFound        Whether the block separator has been found
  30          */
  31         function isBlockSeparatorFound ($str);
  32
  33         /**
  34          * Reads the file header
  35          *
  36          * @return      void
  37          */
  38         function readFileHeader ();
  39
  40         /**
  41          * Flushes the file header
  42          *
  43          * @return      void
  44          */
  45         function flushFileHeader ();
  46 }
  47
  48 // [EOF]
  49 ?>