inc/main/classes/file_directories/class_BaseFileIo.php

   1 <?php
   2 /**
   3  * A general FileIo class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 BaseFileIo extends BaseFrameworkSystem implements FilePointer, CloseableFile {
  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          * @param       $className      Name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44         }
  45
  46         /**
  47          * Destructor for cleaning purposes, etc
  48          *
  49          * @return      void
  50          */
  51         public final function __destruct() {
  52                 // Is there a resource pointer? Then we have to close the file here!
  53                 if (is_resource($this->getPointer())) {
  54                         // Try to close a file
  55                         $this->closeFile();
  56                 } // END - if
  57
  58                 // Call the parent destructor
  59                 parent::__destruct();
  60         }
  61
  62         /**
  63          * Close a file source and set it's instance to null and the file name
  64          * to empty.
  65          *
  66          * @return      void
  67          * @throws      NullPointerException    If the file pointer instance is not set by setPointer()
  68          * @throws      InvalidResourceException        If there is being set
  69          */
  70         public function closeFile () {
  71                 // Debug message
  72                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: fileName=%s - CALLED!', __METHOD__, __LINE__, $this->getFileName()));
  73
  74                 if (is_null($this->getPointer())) {
  75                         // Pointer not initialized
  76                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  77                 } elseif (!is_resource($this->getPointer())) {
  78                         // Pointer is not a valid resource!
  79                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
  80                 }
  81
  82                 // Debug message
  83                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: Closing file %s ...', __METHOD__, __LINE__, $this->getFileName()));
  84
  85                 // Close the file pointer and reset the instance variable
  86                 @fclose($this->getPointer());
  87                 $this->setPointer(NULL);
  88                 $this->setFileName('');
  89
  90                 // Debug message
  91                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d]: EXIT!', __METHOD__, __LINE__));
  92         }
  93
  94         /**
  95          * Setter for the file pointer
  96          *
  97          * @param       $filePointer    File resource
  98          * @return      void
  99          */
 100         protected final function setPointer ($filePointer) {
 101                 $this->filePointer = $filePointer;
 102         }
 103
 104         /**
 105          * Getter for the file pointer
 106          *
 107          * @return      $filePointer    The file pointer which shall be a valid file resource
 108          */
 109         public final function getPointer () {
 110                 return $this->filePointer;
 111         }
 112
 113         /**
 114          * Setter for file name
 115          *
 116          * @param       $fileName       The new file name
 117          * @return      void
 118          */
 119         protected final function setFileName ($fileName) {
 120                 $fileName = (string) $fileName;
 121                 $this->fileName = $fileName;
 122         }
 123
 124         /**
 125          * Getter for file name
 126          *
 127          * @return      $fileName       The current file name
 128          */
 129         public final function getFileName () {
 130                 return $this->fileName;
 131         }
 132
 133         /**
 134          * Determines seek position
 135          *
 136          * @return      $seekPosition   Current seek position
 137          */
 138         public final function determineSeekPosition () {
 139                 return ftell($this->getPointer());
 140         }
 141
 142         /**
 143          * Determines whether the EOF has been reached
 144          *
 145          * @return      $isEndOfFileReached             Whether the EOF has been reached
 146          */
 147         public final function isEndOfFileReached () {
 148                 return feof($this->getPointer());
 149         }
 150
 151         /**
 152          * Seek to given offset (default) or other possibilities as fseek() gives.
 153          *
 154          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
 155          * @param       $whence         Added to offset (default: only use offset to seek to)
 156          * @return      $status         Status of file seek: 0 = success, -1 = failed
 157          */
 158         public function seek ($offset, $whence = SEEK_SET) {
 159                 // Seek to position
 160                 $status = fseek($this->getPointer(), $offset, $whence);
 161
 162                 // Return status
 163                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] status=%d', __METHOD__, __LINE__, $status));
 164                 return $status;
 165         }
 166
 167         /**
 168          * Size of this file
 169          *
 170          * @return      $size   Size (in bytes) of file
 171          * @todo        Handle seekStatus
 172          */
 173         public function size () {
 174                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
 175
 176                 // Get current seek position
 177                 $seekPosition = $this->determineSeekPosition();
 178
 179                 // Seek to end
 180                 $seekStatus = $this->seek(0, SEEK_END);
 181                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
 182
 183                 // Get position again  (which is the end of the file)
 184                 $size = $this->determineSeekPosition();
 185
 186                 // Reset seek position to old
 187                 $this->seek($seekPosition);
 188
 189                 // Return size
 190                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] size=%s - EXIT!', __METHOD__, __LINE__, $size));
 191                 return $size;
 192         }
 193 }
 194
 195 // [EOF]
 196 ?>