inc/classes/main/iterator/io/class_FileIoIterator.php

   1 <?php
   2 /**
   3  * A file i/o iterator
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub 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 FileIoIterator extends BaseIterator implements SeekableWritableFileIterator {
  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          * Creates an instance of this class
  37          *
  38          * @param       $pointerInstance        An instance of a InputOutputPointer class
  39          * @return      $iteratorInstance       An instance of a Iterator class
  40          */
  41         public final static function createFileIoIterator (InputOutputPointer $pointerInstance) {
  42                 // Get new instance
  43                 $iteratorInstance = new FileIoIterator();
  44
  45                 // Set the instance here
  46                 $iteratorInstance->setPointerInstance($pointerInstance);
  47
  48                 // Return the prepared instance
  49                 return $iteratorInstance;
  50         }
  51
  52         /**
  53          * Gets currently read data
  54          *
  55          * @return      $current        Currently read data
  56          */
  57         public function current () {
  58                 // Default is null
  59                 $current = null;
  60
  61                 $this->partialStub('Please implement this method.');
  62
  63                 // Return it
  64                 return $current;
  65         }
  66
  67         /**
  68          * Gets current seek position ("key").
  69          *
  70          * @return      $key    Current key in iteration
  71          */
  72         public function key () {
  73                 // Return it
  74                 return $this->getPointerInstance()->getSeekPosition();
  75         }
  76
  77         /**
  78          * Advances to next "block" of bytes
  79          *
  80          * @return      void
  81          */
  82         public function next () {
  83                 $this->partialStub('Please implement this method.');
  84         }
  85
  86         /**
  87          * Rewinds to the beginning of the file
  88          *
  89          * @return      void
  90          */
  91         public function rewind () {
  92                 // Call pointer instance
  93                 $this->getPointerInstance()->rewind();
  94         }
  95
  96         /**
  97          * Seeks to given position
  98          *
  99          * @param       $seekPosition   Seek position in file
 100          * @return      void
 101          */
 102         public function seek ($seekPosition) {
 103                 // Call pointer instance
 104                 $this->getPointerInstance()->seek($seekPosition);
 105         }
 106
 107         /**
 108          * Writes at given position by seeking to it.
 109          *
 110          * @param       $seekPosition   Seek position in file
 111          * @param       $data                   Data to be written
 112          * @return      void
 113          */
 114         public function writeAtPosition ($seekPosition, $data) {
 115                 // First seek to it
 116                 $this->seek($seekPosition);
 117
 118                 // Then write the data at that position
 119                 $this->getPointerInstance()->writeToFile($data);
 120         }
 121
 122         /**
 123          * Size of file stack
 124          *
 125          * @return      $size   Size (in bytes) of file
 126          */
 127         public function size () {
 128                 // Call the pointer object
 129                 $size = $this->getPointerInstance()->size();
 130
 131                 // Return result
 132                 return $size;
 133         }
 134
 135         /**
 136          * Checks wether the current entry is valid (not at the end of the file).
 137          * This method will return TRUE if an emptied (nulled) entry has been found.
 138          *
 139          * @return      void
 140          */
 141         public function valid () {
 142                 $this->partialStub('Please implement this method.');
 143         }
 144 }
 145
 146 // [EOF]
 147 ?>