framework/main/interfaces/stacker/file/class_StackableFile.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Stack;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Stacker\Stackable;
   7
   8 /**
   9  * A Stackable file interface
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/stacker/file/class_StackableFile.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/stacker/file/class_StackableFile.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface StackableFile extends Stackable {
  35         /**
  36          * Seeks to given position
  37          *
  38          * @param       $seekPosition   Seek position in file
  39          * @return      $status                 Status of this operation
  40          */
  41         function seek ($seekPosition);
  42
  43         /**
  44          * Size of file stack
  45          *
  46          * @return      $size   Size (in bytes) of file
  47          */
  48         function size ();
  49
  50 }