inc/main/classes/file_directories/output/raw/class_FrameworkRawFileOutputPointer.php

   1 <?php
   2 /**
   3  * A class for writing 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 FrameworkRawFileOutputPointer extends BaseFileIo implements OutputPointer {
  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          * @param       $mode           The output mode ('w', 'a' are valid)
  41          * @throws      FileIsEmptyException    If the provided file name is empty.
  42          * @throws      FileIoException                 If fopen() returns not a file resource
  43          * @return      void
  44          */
  45         public static final function createFrameworkRawFileOutputPointer ($fileName, $mode) {
  46                 // Some pre-sanity checks...
  47                 if (is_null($fileName)) {
  48                         // No filename given
  49                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  50                 } // END - if
  51
  52                 // Try to open a handler
  53                 $filePointer = @fopen($fileName, $mode);
  54                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
  55                         // Something bad happend
  56                         throw new FileIoException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  57                 } // END - if
  58
  59                 // Create new instance
  60                 $pointerInstance = new FrameworkRawFileOutputPointer();
  61
  62                 // Set file pointer and file name
  63                 $pointerInstance->setPointer($filePointer);
  64                 $pointerInstance->setFileName($fileName);
  65
  66                 // Return the instance
  67                 return $pointerInstance;
  68         }
  69
  70         /**
  71          * Write data to a file pointer
  72          *
  73          * @param       $dataStream             The data stream we shall write to the file
  74          * @return      mixed                   Number of writes bytes or FALSE on error
  75          * @throws      NullPointerException    If the file pointer instance
  76          *                                                                      is not set by setPointer()
  77          * @throws      InvalidResourceException        If there is being set
  78          *                                                                                      an invalid file resource
  79          */
  80         public function writeToFile ($dataStream) {
  81                 if (is_null($this->getPointer())) {
  82                         // Pointer not initialized
  83                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  84                 } elseif (!is_resource($this->getPointer())) {
  85                         // Pointer is not a valid resource!
  86                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
  87                 }
  88
  89                 // Write data to the file pointer and return written bytes
  90                 return fwrite($this->getPointer(), $dataStream);
  91         }
  92
  93         /**
  94          * Analyzes entries in index file. This will count all found (and valid)
  95          * entries, mark invalid as damaged and count gaps ("fragmentation"). If
  96          * only gaps are found, the file is considered as "virgin" (no entries).
  97          *
  98          * @return      void
  99          * @throws      UnsupportedOperationException   If this method is called
 100          */
 101         public function analyzeFile () {
 102                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 103         }
 104
 105         /**
 106          * Writes at given position by seeking to it.
 107          *
 108          * @param       $seekPosition   Seek position in file
 109          * @param       $data                   Data to be written
 110          * @return      mixed                   Number of writes bytes or FALSE on error
 111          * @throws      UnsupportedOperationException   If this method is called
 112          */
 113         public function writeAtPosition ($seedPosition, $data) {
 114                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 115         }
 116
 117         /**
 118          * Advances to next "block" of bytes
 119          *
 120          * @return      void
 121          * @throws      UnsupportedOperationException   If this method is called
 122          */
 123         public function next () {
 124                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 125         }
 126
 127         /**
 128          * Checks wether the current entry is valid (not at the end of the file).
 129          * This method will return TRUE if an emptied (nulled) entry has been found.
 130          *
 131          * @return      $isValid        Whether the next entry is valid
 132          * @throws      UnsupportedOperationException   If this method is called
 133          */
 134         public function valid () {
 135                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 136         }
 137
 138         /**
 139          * Gets current seek position ("key").
 140          *
 141          * @return      $key    Current key in iteration
 142          * @throws      UnsupportedOperationException   If this method is called
 143          */
 144         public function key () {
 145                 throw new UnsupportedOperationException(array($this, __FUNCTION__), self::EXCEPTION_UNSPPORTED_OPERATION);
 146         }
 147 }
 148
 149 // [EOF]
 150 ?>