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\Generic\NullPointerException;
   7 use CoreFramework\Object\BaseFrameworkSystem;
   8
   9 /**
  10  * A class for reading text files
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Create a file pointer based on the given file. The file will also
  44          * be verified here.
  45          *
  46          * @param       $fileName       The file name we shall pass to fopen()
  47          * @throws      FileIsEmptyException            If the provided file name is empty.
  48          * @throws      FileIoException                         If the file is not reachable
  49          * @throws      FileReadProtectedException      If the file cannot be read from
  50          * @return      void
  51          */
  52         public static final function createFrameworkTextFileInputPointer ($fileName) {
  53                 // Some pre-sanity checks...
  54                 if ((is_null($fileName)) || (empty($fileName))) {
  55                         // No filename given
  56                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  57                 } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
  58                         // File cannot be reached
  59                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
  60                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (!file_exists($fileName))) {
  61                         // File does not exist!
  62                         throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  63                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (file_exists($fileName))) {
  64                         // File cannot be read from (but exists)
  65                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  66                 }
  67
  68                 // Try to open a handler
  69                 $filePointer = fopen($fileName, 'r');
  70                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
  71                         // Something bad happend
  72                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  73                 } // END - if
  74
  75                 // Create new instance
  76                 $pointerInstance = new FrameworkTextFileInputPointer();
  77
  78                 // Set file pointer and file name
  79                 $pointerInstance->setPointer($filePointer);
  80                 $pointerInstance->setFileName($fileName);
  81
  82                 // Return the instance
  83                 return $pointerInstance;
  84         }
  85
  86         /**
  87          * Read data a file pointer
  88          *
  89          * @return      $data   Read data from file
  90          */
  91         public function readFromFile () {
  92                 // Read 1024 Byte data from the file pointer and return it
  93                 return $this->read(1024);
  94         }
  95
  96         /**
  97          * Reads a line, maximum 4096 Bytes from current file pointer
  98          *
  99          * @return      $data   Read data from file
 100          */
 101         public function readLine () {
 102                 // Read whole line from the file pointer and return it
 103                 return $this->read();
 104         }
 105
 106         /**
 107          * Reads given amount of bytes from file.
 108          *
 109          * @param       $bytes  Amount of bytes to read or whole line (only text files)
 110          * @return      $data   Data read from file
 111          * @throws      NullPointerException    If the file pointer instance
 112          *                                                                      is not set by setPointer()
 113          * @throws      InvalidResourceException        If there is being set
 114          */
 115         public function read ($bytes = NULL) {
 116                 // Some sanity checks
 117                 if (is_null($this->getPointer())) {
 118                         // Pointer not initialized
 119                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 120                 } elseif (!is_resource($this->getPointer())) {
 121                         // Pointer is not a valid resource!
 122                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 123                 }
 124
 125                 // Is $bytes set?
 126                 if (is_int($bytes)) {
 127                         // Try to read given characters
 128                         $data = fgets($this->getPointer(), $bytes);
 129                 } else {
 130                         // Try to read whole line
 131                         $data = fgets($this->getPointer());
 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 }