inc/classes/main/file_directories/text/class_BaseTextFile.php

   1 <?php
   2 /**
   3  * A general text file class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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 class BaseTextFile extends BaseFile {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Determines seek position
  38          *
  39          * @return      $seekPosition   Current seek position
  40          */
  41         public function determineSeekPosition () {
  42                 // Not possible in text files
  43                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  44         }
  45
  46         /**
  47          * Seek to given offset (default) or other possibilities as fseek() gives.
  48          *
  49          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
  50          * @param       $whence         Added to offset (default: only use offset to seek to)
  51          * @return      $status         Status of file seek: 0 = success, -1 = failed
  52          */
  53         public function seek ($offset, $whence = SEEK_SET) {
  54                 // Not possible in text files
  55                 self::createDebugInstance(__CLASS__)->debugOutput('offset=' . $offset . ',whence=' . $whence);
  56                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  57         }
  58
  59         /**
  60          * Reads from a local or remote file
  61          *
  62          * @param       $fqfn   The file's FQFN we shall load
  63          * @return      $array  An array containing all read lines
  64          * @throws      InvalidArrayCountException      If an array has not the expected size
  65          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  66          */
  67         public function loadFileContents ($fqfn) {
  68                 /*
  69                  * This class (or its implementations) are special file readers/writers.
  70                  * There is no need to read/write the whole file.
  71                  */
  72                 self::createDebugInstance(__CLASS__)->debugOutput('fqfn=' . $fqfn);
  73                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  74         }
  75 }
  76
  77 // [EOF]
  78 ?>