framework/main/classes/file_directories/input/text/class_FrameworkTextFileInputPointer.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filesystem\Pointer\Input;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Filesystem\BaseFileIo;
   8 use Org\Mxchange\CoreFramework\Filesystem\FileNotFoundException;
   9 use Org\Mxchange\CoreFramework\Filesystem\FileReadProtectedException;
  10 use Org\Mxchange\CoreFramework\Filesystem\Pointer\InputPointer;
  11 use Org\Mxchange\CoreFramework\Generic\NullPointerException;
  12 use Org\Mxchange\CoreFramework\Generic\UnsupportedOperationException;
  13 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
  14
  15 // Import SPL stuff
  16 use \SplFileInfo;
  17
  18 /**
  19  * A class for reading text files
  20  *
  21  * @author              Roland Haeder <webmaster@shipsimu.org>
  22  * @version             0.0.0
  23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2021 Core Developer Team
  24  * @license             GNU GPL 3.0 or any newer version
  25  * @link                http://www.shipsimu.org
  26  *
  27  * This program is free software: you can redistribute it and/or modify
  28  * it under the terms of the GNU General Public License as published by
  29  * the Free Software Foundation, either version 3 of the License, or
  30  * (at your option) any later version.
  31  *
  32  * This program is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  35  * GNU General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU General Public License
  38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
  41         /**
  42          * Protected constructor
  43          *
  44          * @return      void
  45          */
  46         private function __construct () {
  47                 // Call parent constructor
  48                 parent::__construct(__CLASS__);
  49         }
  50
  51         /**
  52          * Create a file pointer based on the given file. The file will also
  53          * be verified here.
  54          *
  55          * @param       $fileName       The file name we shall pass to fopen()
  56          * @throws      FileIoException                         If the file is not reachable
  57          * @throws      FileReadProtectedException      If the file cannot be read from
  58          * @return      void
  59          */
  60         public static final function createFrameworkTextFileInputPointer (SplFileInfo $infoInstance) {
  61                 // Check parameter
  62                 if (!FrameworkBootstrap::isReachableFilePath($infoInstance)) {
  63                         // File cannot be reached
  64                         throw new FileIoException($infoInstance, self::EXCEPTION_FILE_NOT_REACHABLE);
  65                 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && (!$infoInstance->isFile())) {
  66                         // File does not exist!
  67                         throw new FileNotFoundException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
  68                 } elseif ((!FrameworkBootstrap::isReadableFile($infoInstance)) && ($infoInstance->isFile())) {
  69                         // File cannot be read from (but exists)
  70                         throw new FileReadProtectedException($infoInstance, self::EXCEPTION_FILE_CANNOT_BE_READ);
  71                 }
  72
  73                 // Try to open a handler
  74                 $fileObject = $infoInstance->openFile('r');
  75
  76                 // Debug message
  77                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEXT-FILE-INPUT: fileObject[]=' . gettype($fileObject));
  78
  79                 // Is it valid?
  80                 if ((is_null($fileObject)) || ($fileObject === false)) {
  81                         // Something bad happend
  82                         throw new FileIoException($infoInstance, self::EXCEPTION_FILE_POINTER_INVALID);
  83                 }
  84
  85                 // Create new instance
  86                 $pointerInstance = new FrameworkTextFileInputPointer();
  87
  88                 // Set file pointer and file name
  89                 $pointerInstance->setFileObject($fileObject);
  90
  91                 // Return the instance
  92                 return $pointerInstance;
  93         }
  94
  95         /**
  96          * Read data a file pointer
  97          *
  98          * @return      $data   Read data from file
  99          */
 100         public function readFromFile () {
 101                 // Read 1024 Byte data from the file pointer and return it
 102                 return $this->read(1024);
 103         }
 104
 105         /**
 106          * Reads a line, maximum 4096 Bytes from current file pointer
 107          *
 108          * @return      $data   Read data from file
 109          */
 110         public function readLine () {
 111                 // Read whole line from the file pointer and return it
 112                 return $this->read();
 113         }
 114
 115         /**
 116          * Reads given amount of bytes from file.
 117          *
 118          * @param       $bytes  Amount of bytes to read or whole line (only text files)
 119          * @return      $data   Data read from file
 120          * @throws      OutOfBoundsException    If the position is not seekable
 121          * @throws      NullPointerException    If the file pointer instance is not set by setFileObject()
 122          * @throws      LogicException  If $fileObject is not an object
 123          */
 124         public function read (int $bytes = 0) {
 125                 // Some sanity checks
 126                 if ($bytes < 0) {
 127                         // Cannot be below zero
 128                         throw new OutOfBoundsException(sprintf('bytes=%d is not valid', $bytes));
 129                 } elseif (is_null($this->getFileObject())) {
 130                         // Pointer not initialized
 131                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 132                 } elseif (!is_object($this->getFileObject())) {
 133                         // Pointer is not a valid resource!
 134                         throw new LogicException(sprintf('this->fileObject[]=%s is no object', gettype($this->getFileObject())));
 135                 }
 136
 137                 // Is $bytes set?
 138                 if ($bytes > 0) {
 139                         // Try to read given characters
 140                         $data = $this->getFileObject()->fread($bytes);
 141                 } else {
 142                         // Try to read whole line
 143                         $data = $this->getFileObject()->fgets();
 144                 }
 145
 146                 // Then return it
 147                 return $data;
 148         }
 149
 150         /**
 151          * Analyzes entries in index file. This will count all found (and valid)
 152          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
 153          * only gaps are found, the file is considered as "virgin" (no entries).
 154          *
 155          * @return      void
 156          * @throws      UnsupportedOperationException   If this method is called
 157          */
 158         public function analyzeFileStructure () {
 159                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 160         }
 161
 162         /**
 163          * Advances to next "block" of bytes
 164          *
 165          * @return      void
 166          * @throws      UnsupportedOperationException   If this method is called
 167          */
 168         public function next () {
 169                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 170         }
 171
 172         /**
 173          * Checks wether the current entry is valid (not at the end of the file).
 174          * This method will return true if an emptied (nulled) entry has been found.
 175          *
 176          * @return      $isValid        Whether the next entry is valid
 177          * @throws      UnsupportedOperationException   If this method is called
 178          */
 179         public function valid () {
 180                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 181         }
 182
 183         /**
 184          * Gets current seek position ("key").
 185          *
 186          * @return      $key    Current key in iteration
 187          * @throws      UnsupportedOperationException   If this method is called
 188          */
 189         public function key () {
 190                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 191         }
 192
 193 }