inc/classes/main/file_directories/class_BaseFile.php

   1 <?php
   2 /**
   3  * A general file class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 BaseFile extends BaseFrameworkSystem {
  25         /**
  26          * The current file we are working in
  27          */
  28         private $fileName = '';
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className) {
  37                 // Call parent constructor
  38                 parent::__construct($className);
  39         }
  40
  41         /**
  42          * Destructor for cleaning purposes, etc
  43          *
  44          * @return      void
  45          */
  46         public final function __destruct() {
  47                 // Try to close a file
  48                 $this->closeFile();
  49
  50                 // Call the parent destructor
  51                 parent::__destruct();
  52         }
  53
  54         /**
  55          * Getter for the file pointer
  56          *
  57          * @return      $filePointer    The file pointer which shall be a valid file resource
  58          * @throws      UnsupportedOperationException   If this method is called
  59          */
  60         public final function getPointer () {
  61                 self::createDebugInstance(__CLASS__)->debugOutput('Unhandled ' . strlen($data) . ' bytes in this stream.');
  62                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
  63         }
  64
  65         /**
  66          * Setter for file name
  67          *
  68          * @param       $fileName       The new file name
  69          * @return      void
  70          */
  71         protected final function setFileName ($fileName) {
  72                 $fileName = (string) $fileName;
  73                 $this->fileName = $fileName;
  74         }
  75
  76         /**
  77          * Getter for file name
  78          *
  79          * @return      $fileName       The current file name
  80          */
  81         public final function getFileName () {
  82                 return $this->fileName;
  83         }
  84
  85         /**
  86          * Initializes this file class
  87          *
  88          * @param       $fileName       Name of this abstract file
  89          * @return      void
  90          */
  91         protected function initFile ($fileName) {
  92                 // Get a file i/o pointer instance
  93                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName));
  94
  95                 // ... and set it here
  96                 $this->setPointerInstance($pointerInstance);
  97         }
  98
  99         /**
 100          * Close a file source and set it's instance to null and the file name
 101          * to empty
 102          *
 103          * @return      void
 104          * @todo        ~10% done?
 105          */
 106         public function closeFile () {
 107                 $this->partialStub('Unfinished method.');
 108
 109                 // Remove file name
 110                 $this->setFileName('');
 111         }
 112
 113         /**
 114          * Determines seek position
 115          *
 116          * @return      $seekPosition   Current seek position
 117          */
 118         public function determineSeekPosition () {
 119                 return $this->getPointerInstance()->determineSeekPosition();
 120         }
 121
 122         /**
 123          * Seek to given offset (default) or other possibilities as fseek() gives.
 124          *
 125          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
 126          * @param       $whence         Added to offset (default: only use offset to seek to)
 127          * @return      $status         Status of file seek: 0 = success, -1 = failed
 128          */
 129         public function seek ($offset, $whence = SEEK_SET) {
 130                 return $this->getPointerInstance()->seek($offset, $whence);
 131         }
 132
 133         /**
 134          * Size of this file
 135          *
 136          * @return      $size   Size (in bytes) of file
 137          * @todo        Handle seekStatus
 138          */
 139         public function size () {
 140                 return $this->getPointerInstance()->size();
 141         }
 142
 143         /**
 144          * Read data a file pointer
 145          *
 146          * @return      mixed   The result of fread()
 147          * @throws      NullPointerException    If the file pointer instance
 148          *                                                                      is not set by setPointer()
 149          * @throws      InvalidResourceException        If there is being set
 150          */
 151         public function readFromFile () {
 152                 return $this->getPointerInstance()->readFromFile();
 153         }
 154
 155         /**
 156          * Reads given amount of bytes from file.
 157          *
 158          * @param       $bytes  Amount of bytes to read
 159          * @return      $data   Data read from file
 160          */
 161         public function read ($bytes) {
 162                 return $this->getPointerInstance()->read($bytes);
 163         }
 164
 165         /**
 166          * Write data to a file pointer
 167          *
 168          * @param       $dataStream             The data stream we shall write to the file
 169          * @return      mixed                   Number of writes bytes or FALSE on error
 170          * @throws      NullPointerException    If the file pointer instance
 171          *                                                                      is not set by setPointer()
 172          * @throws      InvalidResourceException        If there is being set
 173          *                                                                                      an invalid file resource
 174          */
 175         public function writeToFile ($dataStream) {
 176                 return $this->getPointerInstance()->writeToFile($dataStream);
 177         }
 178
 179         /**
 180          * Rewinds to the beginning of the file
 181          *
 182          * @return      $status         Status of this operation
 183          */
 184         public function rewind () {
 185                 return $this->getPointerInstance()->rewind();
 186         }
 187 }
 188
 189 // [EOF]
 190 ?>