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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filesystem\File;
   4
   5 // Import framework stuff
   6 use CoreFramework\Generic\UnsupportedOperationException;
   7
   8 /**
   9  * A general text file class
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.ship-simu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class BaseTextFile extends BaseAbstractFile {
  31         /**
  32          * Protected constructor
  33          *
  34          * @param       $className      Name of the class
  35          * @return      void
  36          */
  37         protected function __construct ($className) {
  38                 // Call parent constructor
  39                 parent::__construct($className);
  40         }
  41
  42         /**
  43          * Determines seek position
  44          *
  45          * @return      $seekPosition   Current seek position
  46          */
  47         public function determineSeekPosition () {
  48                 // Not possible in text files
  49                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  50         }
  51
  52         /**
  53          * Seek to given offset (default) or other possibilities as fseek() gives.
  54          *
  55          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
  56          * @param       $whence         Added to offset (default: only use offset to seek to)
  57          * @return      $status         Status of file seek: 0 = success, -1 = failed
  58          */
  59         public function seek ($offset, $whence = SEEK_SET) {
  60                 // Not possible in text files
  61                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] offset=' . $offset . ',whence=' . $whence);
  62                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  63         }
  64
  65         /**
  66          * Reads from a local or remote file
  67          *
  68          * @param       $fqfn   The file's FQFN we shall load
  69          * @return      $array  An array containing all read lines
  70          * @throws      InvalidArrayCountException      If an array has not the expected size
  71          * @throws      InvalidMD5ChecksumException     If two MD5 hashes did not match
  72          */
  73         public function loadFileContents ($fqfn) {
  74                 /*
  75                  * This class (or its implementations) are special file readers/writers.
  76                  * There is no need to read/write the whole file.
  77                  */
  78                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] fqfn=' . $fqfn);
  79                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  80         }
  81
  82 }