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          * Setter for file name
  56          *
  57          * @param       $fileName       The new file name
  58          * @return      void
  59          */
  60         protected final function setFileName ($fileName) {
  61                 $fileName = (string) $fileName;
  62                 $this->fileName = $fileName;
  63         }
  64
  65         /**
  66          * Getter for file name
  67          *
  68          * @return      $fileName       The current file name
  69          */
  70         public final function getFileName () {
  71                 return $this->fileName;
  72         }
  73
  74         /**
  75          * Initializes this file class
  76          *
  77          * @param       $fileName       Name of this abstract file
  78          * @return      void
  79          */
  80         protected function initFile ($fileName) {
  81                 // Get a file i/o pointer instance
  82                 $pointerInstance = ObjectFactory::createObjectByConfiguredName('file_raw_input_output_class', array($fileName));
  83
  84                 // ... and set it here
  85                 $this->setPointerInstance($pointerInstance);
  86         }
  87
  88         /**
  89          * Close a file source and set it's instance to null and the file name
  90          * to empty
  91          *
  92          * @return      void
  93          * @todo        ~10% done?
  94          */
  95         public function closeFile () {
  96                 $this->partialStub('Unfinished method.');
  97
  98                 // Remove file name
  99                 $this->setFileName('');
 100         }
 101
 102         /**
 103          * Determines seek position
 104          *
 105          * @return      $seekPosition   Current seek position
 106          */
 107         public function determineSeekPosition () {
 108                 return $this->getPointerInstance()->determineSeekPosition();
 109         }
 110
 111         /**
 112          * Seek to given offset (default) or other possibilities as fseek() gives.
 113          *
 114          * @param       $offset         Offset to seek to (or used as "base" for other seeks)
 115          * @param       $whence         Added to offset (default: only use offset to seek to)
 116          * @return      $status         Status of file seek: 0 = success, -1 = failed
 117          */
 118         public function seek ($offset, $whence = SEEK_SET) {
 119                 return $this->getPointerInstance()->seek($offset, $whence);
 120         }
 121
 122         /**
 123          * Size of this file
 124          *
 125          * @return      $size   Size (in bytes) of file
 126          * @todo        Handle seekStatus
 127          */
 128         public function size () {
 129                 return $this->getPointerInstance()->size();
 130         }
 131
 132         /**
 133          * Read data a file pointer
 134          *
 135          * @return      mixed   The result of fread()
 136          * @throws      NullPointerException    If the file pointer instance
 137          *                                                                      is not set by setPointer()
 138          * @throws      InvalidResourceException        If there is being set
 139          */
 140         public function readFromFile () {
 141                 return $this->getPointerInstance()->readFromFile();
 142         }
 143
 144         /**
 145          * Reads given amount of bytes from file.
 146          *
 147          * @param       $bytes  Amount of bytes to read
 148          * @return      $data   Data read from file
 149          */
 150         public function read ($bytes) {
 151                 return $this->getPointerInstance()->read($bytes);
 152         }
 153
 154         /**
 155          * Write data to a file pointer
 156          *
 157          * @param       $dataStream             The data stream we shall write to the file
 158          * @return      mixed                   Number of writes bytes or FALSE on error
 159          * @throws      NullPointerException    If the file pointer instance
 160          *                                                                      is not set by setPointer()
 161          * @throws      InvalidResourceException        If there is being set
 162          *                                                                                      an invalid file resource
 163          */
 164         public function writeToFile ($dataStream) {
 165                 return $this->getPointerInstance()->writeToFile($dataStream);
 166         }
 167
 168         /**
 169          * Rewinds to the beginning of the file
 170          *
 171          * @return      $status         Status of this operation
 172          */
 173         public function rewind () {
 174                 return $this->getPointerInstance()->rewind();
 175         }
 176 }
 177
 178 // [EOF]
 179 ?>