inc/classes/main/file_directories/output/class_FrameworkFileOutputPointer.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 - 2013 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 FrameworkFileOutputPointer extends BaseFileIo {
  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 createFrameworkFileOutputPointer ($fileName, $mode) {
  46                 // Secure with realpath()
  47                 $fileName = realpath($fileName);
  48
  49                 // Some pre-sanity checks...
  50                 if (is_null($fileName)) {
  51                         // No filename given
  52                         throw new FileIsEmptyException(NULL, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  53                 } // END - if
  54
  55                 // Try to open a handler
  56                 $filePointer = @fopen($fileName, $mode);
  57                 if ((is_null($filePointer)) || ($filePointer === FALSE)) {
  58                         // Something bad happend
  59                         throw new FileIoException ($fileName, self::EXCEPTION_FILE_POINTER_INVALID);
  60                 } // END - if
  61
  62                 // Create new instance
  63                 $pointerInstance = new FrameworkFileOutputPointer();
  64
  65                 // Set file pointer and file name
  66                 $pointerInstance->setPointer($filePointer);
  67                 $pointerInstance->setFileName($fileName);
  68
  69                 // Return the instance
  70                 return $pointerInstance;
  71         }
  72
  73         /**
  74          * Write data to a file pointer
  75          *
  76          * @param       $dataStream             The data stream we shall write to the file
  77          * @return      mixed                   Number of writes bytes or FALSE on error
  78          * @throws      NullPointerException    If the file pointer instance
  79          *                                                                      is not set by setPointer()
  80          * @throws      InvalidResourceException        If there is being set
  81          *                                                                                      an invalid file resource
  82          */
  83         public function writeToFile ($dataStream) {
  84                 if (is_null($this->getPointer())) {
  85                         // Pointer not initialized
  86                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
  87                 } elseif (!is_resource($this->getPointer())) {
  88                         // Pointer is not a valid resource!
  89                         throw new InvalidResourceException($this, self::EXCEPTION_INVALID_RESOURCE);
  90                 }
  91
  92                 // Write data to the file pointer and return written bytes
  93                 return fwrite($this->getPointer(), $dataStream);
  94         }
  95 }
  96
  97 // [EOF]
  98 ?>