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

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