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

   1 <?php
   2 /**
   3  * A class for reading text files
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 FrameworkTextFileInputPointer extends BaseFileIo implements InputPointer {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Create a file pointer based on the given file. The file will also
  37          * be verified here.
  38          *
  39          * @param       $fileName       The file name we shall pass to fopen()
  40          * @throws      FileIsEmptyException            If the provided file name is empty.
  41          * @throws      FileIoException                         If the file is not reachable
  42          * @throws      FileReadProtectedException      If the file cannot be read from
  43          * @return      void
  44          */
  45         public static final function createFrameworkTextFileInputPointer ($fileName) {
  46                 // Some pre-sanity checks...
  47                 if ((is_null($fileName)) || (empty($fileName))) {
  48                         // No filename given
  49                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  50                 } elseif (!BaseFrameworkSystem::isReachableFilePath($fileName)) {
  51                         // File cannot be reached
  52                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_REACHABLE);
  53                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (!file_exists($fileName))) {
  54                         // File does not exist!
  55                         throw new FileNotFoundException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  56                 } elseif ((!BaseFrameworkSystem::isReadableFile($fileName)) && (file_exists($fileName))) {
  57                         // File cannot be read from (but exists)
  58                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  59                 }
  60
  61                 // Try to open a handler
  62                 $filePointer = fopen($fileName, 'r');
  63                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
  64                         // Something bad happend
  65                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  66                 } // END - if
  67
  68                 // Create new instance
  69                 $pointerInstance = new FrameworkTextFileInputPointer();
  70
  71                 // Set file pointer and file name
  72                 $pointerInstance->setPointer($filePointer);
  73                 $pointerInstance->setFileName($fileName);
  74
  75                 // Return the instance
  76                 return $pointerInstance;
  77         }
  78
  79         /**
  80          * Read data a file pointer
  81          *
  82          * @return      $data   Read data from file
  83          */
  84         public function readFromFile () {
  85                 // Read 1024 Byte data from the file pointer and return it
  86                 return $this->read(1024);
  87         }
  88
  89         /**
  90          * Reads a line, maximum 4096 Bytes from current file pointer
  91          *
  92          * @return      $data   Read data from file
  93          */
  94         public function readLine () {
  95                 // Read whole line from the file pointer and return it
  96                 return $this->read();
  97         }
  98
  99         /**
 100          * Reads given amount of bytes from file.
 101          *
 102          * @param       $bytes  Amount of bytes to read or whole line (only text files)
 103          * @return      $data   Data read from file
 104          * @throws      NullPointerException    If the file pointer instance
 105          *                                                                      is not set by setPointer()
 106          * @throws      InvalidResourceException        If there is being set
 107          */
 108         public function read ($bytes = NULL) {
 109                 // Some sanity checks
 110                 if (is_null($this->getPointer())) {
 111                         // Pointer not initialized
 112                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 113                 } elseif (!is_resource($this->getPointer())) {
 114                         // Pointer is not a valid resource!
 115                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 116                 }
 117
 118                 // Is $bytes set?
 119                 if (is_int($bytes)) {
 120                         // Try to read given characters
 121                         $data = fgets($this->getPointer(), $bytes);
 122                 } else {
 123                         // Try to read whole line
 124                         $data = fgets($this->getPointer());
 125                 }
 126
 127                 // Then return it
 128                 return $data;
 129         }
 130
 131         /**
 132          * Analyzes entries in index file. This will count all found (and valid)
 133          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
 134          * only gaps are found, the file is considered as "virgin" (no entries).
 135          *
 136          * @return      void
 137          * @throws      UnsupportedOperationException   If this method is called
 138          */
 139         public function analyzeFile () {
 140                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 141         }
 142
 143         /**
 144          * Advances to next "block" of bytes
 145          *
 146          * @return      void
 147          * @throws      UnsupportedOperationException   If this method is called
 148          */
 149         public function next () {
 150                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 151         }
 152
 153         /**
 154          * Checks wether the current entry is valid (not at the end of the file).
 155          * This method will return TRUE if an emptied (nulled) entry has been found.
 156          *
 157          * @return      $isValid        Whether the next entry is valid
 158          * @throws      UnsupportedOperationException   If this method is called
 159          */
 160         public function valid () {
 161                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 162         }
 163
 164         /**
 165          * Gets current seek position ("key").
 166          *
 167          * @return      $key    Current key in iteration
 168          * @throws      UnsupportedOperationException   If this method is called
 169          */
 170         public function key () {
 171                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 172         }
 173 }
 174
 175 // [EOF]
 176 ?>