inc/classes/main/io/class_FrameworkFileInputPointer.php

   1 <?php
   2 /**
   3  * A class for reading files
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 FrameworkFileInputPointer extends BaseFrameworkSystem {
  25         /**
  26          * The current file we are working in
  27          */
  28         private $fileName = '';
  29
  30         /**
  31          * The file pointer
  32          */
  33         private $filePointer = NULL;
  34
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Destructor for cleaning purposes, etc
  47          *
  48          * @return      void
  49          */
  50         public final function __destruct() {
  51                 // Is there a resource pointer? Then we have to close the file here!
  52                 if (is_resource($this->getPointer())) {
  53                         // Try to close a file
  54                         $this->closeFile();
  55                 }
  56
  57                 // Call the parent destructor
  58                 parent::__destruct();
  59         }
  60
  61         /**
  62          * Create a file pointer based on the given file. The file will also
  63          * be verified here.
  64          *
  65          * @param               $fileName       The file name we shall pass to fopen()
  66          * @throws      FileIsEmptyException    If the provided file name is empty.
  67          * @throws      FileIoException         If fopen() returns not a file resource
  68          * @return      void
  69          */
  70         public static final function createFrameworkFileInputPointer ($fileName) {
  71                 // Some pre-sanity checks...
  72                 if ((is_null($fileName)) || (empty($fileName))) {
  73                         // No filename given
  74                         throw new FileIsEmptyException(null, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  75                 } elseif (!file_exists($fileName)) {
  76                         // File does not exist!
  77                         throw new FileIoException($fileName, self::EXCEPTION_FILE_NOT_FOUND);
  78                 } elseif (!is_readable($fileName)) {
  79                         // File does not exist!
  80                         throw new FileReadProtectedException($fileName, self::EXCEPTION_FILE_CANNOT_BE_READ);
  81                 }
  82
  83                 // Try to open a handler
  84                 $filePointer = @fopen($fileName, 'rb');
  85                 if ((is_null($filePointer)) || ($filePointer === false)) {
  86                         // Something bad happend
  87                         throw new FileIoException($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  88                 } // END - if
  89
  90                 // Create new instance
  91                 $pointerInstance = new FrameworkFileInputPointer();
  92
  93                 // Set file pointer and file name
  94                 $pointerInstance->setPointer($filePointer);
  95                 $pointerInstance->setFileName($fileName);
  96
  97                 // Return the instance
  98                 return $pointerInstance;
  99         }
 100
 101         /**
 102          * Read data a file pointer
 103          *
 104          * @return      mixed   The result of fread()
 105          * @throws      NullPointerException    If the file pointer instance
 106          *                                                                      is not set by setPointer()
 107          * @throws      InvalidResourceException        If there is being set
 108          *                                                                      an invalid file resource
 109          */
 110         public function readFromFile () {
 111                 if (is_null($this->getPointer())) {
 112                         // Pointer not initialized
 113                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 114                 } elseif (!is_resource($this->getPointer())) {
 115                         // Pointer is not a valid resource!
 116                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 117                 }
 118
 119                 // Read data from the file pointer and return it
 120                 return fread($this->getPointer(), 1024);
 121         }
 122
 123         /**
 124          * Read lines from a file pointer
 125          *
 126          * @return      mixed   The result of fread()
 127          * @throws      NullPointerException    If the file pointer instance
 128          *                                                                      is not set by setPointer()
 129          * @throws      InvalidResourceException        If there is being set
 130          *                                                                      an invalid file resource
 131          */
 132         public function readLinesFromFile () {
 133                 if (is_null($this->getPointer())) {
 134                         // Pointer not initialized
 135                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 136                 } elseif (!is_resource($this->getPointer())) {
 137                         // Pointer is not a valid resource!
 138                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_DIRECTORY_POINTER);
 139                 }
 140
 141                 // Read data from the file pointer and return it
 142                 return fgets($this->getPointer(), 1024);
 143         }
 144
 145         /**
 146          * Close a file source and set it's instance to null and the file name
 147          * to empty
 148          *
 149          * @return      void
 150          * @throws      NullPointerException    If the file pointer instance
 151          *                                                                      is not set by setPointer()
 152          * @throws      InvalidResourceException        If there is being set
 153          */
 154         public function closeFile () {
 155                 if (is_null($this->getPointer())) {
 156                         // Pointer not initialized
 157                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 158                 } elseif (!is_resource($this->getPointer())) {
 159                         // Pointer is not a valid resource!
 160                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 161                 }
 162
 163                 // Close the file pointer and reset the instance variable
 164                 @fclose($this->getPointer());
 165                 $this->setPointer(null);
 166                 $this->setFileName('');
 167         }
 168
 169         /**
 170          * Setter for the file pointer
 171          *
 172          * @param       $filePointer    File resource
 173          * @return      void
 174          */
 175         public final function setPointer ($filePointer) {
 176                 // Sanity-check if pointer is a valid file resource
 177                 if (is_resource($filePointer) || is_null($filePointer)) {
 178                         // Is a valid resource
 179                         $this->filePointer = $filePointer;
 180                 } else {
 181                         // Throw exception
 182                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
 183                 }
 184         }
 185
 186         /**
 187          * Getter for the file pointer
 188          *
 189          * @return      $filePointer    The file pointer which shall be a valid
 190          *                                                      file resource
 191          */
 192         public final function getPointer () {
 193                 return $this->filePointer;
 194         }
 195
 196         /**
 197          * Setter for file name
 198          *
 199          * @param       $fileName       The new file name
 200          * @return      void
 201          */
 202         public final function setFileName ($fileName) {
 203                 $fileName = (string) $fileName;
 204                 $this->fileName = $fileName;
 205         }
 206
 207         /**
 208          * Getter for file name
 209          *
 210          * @return      $fileName       The current file name
 211          */
 212         public final function getFileName () {
 213                 return $this->fileName;
 214         }
 215 }
 216
 217 // [EOF]
 218 ?>