*/
private $fileName = '';
+ /**
+ * Back-buffer
+ */
+ private $backBuffer = '';
+
+ /**
+ * Currently loaded block (will be returned by current())
+ */
+ private $currentBlock = '';
+
/**
* Protected constructor
*
* @param $className Name of the class
- * @return void
+y * @return void
*/
protected function __construct ($className) {
// Call parent constructor
return $this->fileName;
}
+ /**
+ * Initializes the back-buffer by setting it to an empty string.
+ *
+ * @return void
+ */
+ private function initBackBuffer () {
+ // Simply call the setter
+ $this->setBackBuffer('');
+ }
+
+ /**
+ * Setter for backBuffer field
+ *
+ * @param $backBuffer Characters to "store" in back-buffer
+ * @return void
+ */
+ private function setBackBuffer ($backBuffer) {
+ // Cast to string (so no arrays or objects)
+ $backBuffer = (string) $backBuffer;
+
+ // ... and set it
+ $this->backBuffer = $backBuffer;
+ }
+
+ /**
+ * Getter for backBuffer field
+ *
+ * @return $backBuffer Characters "stored" in back-buffer
+ */
+ private function getBackBuffer () {
+ return $this->backBuffer;
+ }
+
+ /**
+ * Setter for currentBlock field
+ *
+ * @param $currentBlock Characters to set a currently loaded block
+ * @return void
+ */
+ private function setCurrentBlock ($currentBlock) {
+ // Cast to string (so no arrays or objects)
+ $currentBlock = (string) $currentBlock;
+
+ // ... and set it
+ $this->currentBlock = $currentBlock;
+ }
+
/**
* Initializes this file class
*
* @return $isEndOfFileReached Whether the EOF has been reached
*/
public final function isEndOfFileReached () {
- return $this->getPointerInstance()->isEndOfFileReached();
+ return $this->isEndOfFileReached();
}
/**
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
}
+
+ /**
+ * Advances to next "block" of bytes
+ *
+ * @return void
+ * @todo This method will load large but empty files in a whole
+ */
+ public function next () {
+ // Is there nothing to read?
+ if (!$this->valid()) {
+ // Nothing to read
+ return;
+ } // END - if
+
+ // Make sure the block instance is set
+ assert($this->getBlockInstance() instanceof CalculatableBlock);
+
+ // First calculate minimum block length
+ $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
+
+ // Short be more than zero!
+ assert($length > 0);
+
+ // Wait until a entry/block separator has been found
+ $data = $this->getBackBuffer();
+ while ((!$this->isEndOfFileReached()) && (!$this->getBlockInstance()->isBlockSeparatorFound($data))) {
+ // Then read the block
+ $data .= $this->read($length);
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('data()=' . strlen($data));
+ } // END - if
+
+ // EOF reached?
+ if ($this->isEndOfFileReached()) {
+ // Set whole data as current block
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('Calling setCurrentBlock(' . strlen($data) . ') ...');
+ $this->setCurrentBlock($data);
+
+ // Then abort here silently
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('EOF reached.');
+ return;
+ } // END - if
+
+ /*
+ * Init back-buffer which is the data that has been found beyond the
+ * separator.
+ */
+ $this->initBackBuffer();
+
+ // Separate data
+ $dataArray = explode(self::getBlockSeparator(), $data);
+
+ // This array must contain two elements
+ //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('dataArray=' . print_r($dataArray, TRUE));
+ assert(count($dataArray) == 2);
+
+ // Left part is the actual block, right one the back-buffer data
+ $this->setCurrentBlock($dataArray[0]);
+ $this->setBackBuffer($dataArray[1]);
+ }
+
+ /**
+ * Checks wether the current entry is valid (not at the end of the file).
+ * This method will return TRUE if an emptied (nulled) entry has been found.
+ *
+ * @return $isValid Whether the next entry is valid
+ */
+ public function valid () {
+ // Make sure the block instance is set
+ assert($this->getBlockInstance() instanceof CalculatableBlock);
+
+ // First calculate minimum block length
+ $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
+
+ // Short be more than zero!
+ assert($length > 0);
+
+ // Get current seek position
+ $seekPosition = $this->key();
+
+ // Then try to read it
+ $data = $this->read($length);
+
+ // If some bytes could be read, all is fine
+ $isValid = ((is_string($data)) && (strlen($data) > 0));
+
+ // Get header size
+ $headerSize = $this->getBlockInstance()->getHeaderSize();
+
+ // Is the seek position at or beyond the header?
+ if ($seekPosition >= $headerSize) {
+ // Seek back to old position
+ $this->seek($seekPosition);
+ } else {
+ // Seek directly behind the header
+ $this->seek($headerSize);
+ }
+
+ // Return result
+ return $isValid;
+ }
}
// [EOF]
* Creates an instance of this File class and prepares it for usage
*
* @param $fileName Name of the index file
+ * @param $blockInstance An instance of a CalculatableBlock class
* @return $fileInstance An instance of this File class
*/
- public final static function createIndexFile ($fileName) {
+ public final static function createIndexFile ($fileName, CalculatableBlock $blockInstance) {
// Get a new instance
$fileInstance = new IndexFile();
+ // Set block instance here for callbacks
+ $fileInstance->setBlockInstance($blockInstance);
+
// Init this abstract file
$fileInstance->initFile($fileName);
* Creates an instance of this File class and prepares it for usage
*
* @param $fileName Name of the stack file
+ * @param $blockInstance An instance of a CalculatableBlock class
* @return $fileInstance An instance of this File class
*/
- public final static function createStackFile ($fileName) {
+ public final static function createStackFile ($fileName, CalculatableBlock $blockInstance) {
// Get a new instance
$fileInstance = new StackFile();
+ // Set block instance here for callbacks
+ $fileInstance->setBlockInstance($blockInstance);
+
// Init this abstract file
$fileInstance->initFile($fileName);
$fileName .= $this->getConfigInstance()->getConfigEntry('index_extension');
// Get a file i/o pointer instance for index file
- $fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileName));
+ $fileInstance = ObjectFactory::createObjectByConfiguredName('index_file_class', array($fileName, $this));
// Get iterator instance
- $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance, $this));
+ $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance));
// Is the instance implementing the right interface?
assert($iteratorInstance instanceof SeekableWritableFileIterator);
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
class FileIoIterator extends BaseIterator implements SeekableWritableFileIterator {
- /**
- * Back-buffer
- */
- private $backBuffer = '';
-
- /**
- * Currently loaded block (will be returned by current())
- */
- private $currentBlock = '';
-
/**
* Protected constructor
*
* Creates an instance of this class
*
* @param $pointerInstance An instance of a InputOutputPointer class
- * @param $blockInstance An instance of a CalculatableBlock class
* @return $iteratorInstance An instance of a Iterator class
*/
- public final static function createFileIoIterator (InputOutputPointer $pointerInstance, CalculatableBlock $blockInstance) {
+ public final static function createFileIoIterator (InputOutputPointer $pointerInstance) {
// Get new instance
$iteratorInstance = new FileIoIterator();
// Set the instance here
$iteratorInstance->setPointerInstance($pointerInstance);
- // Set the block instance here
- $iteratorInstance->setBlockInstance($blockInstance);
-
// Return the prepared instance
return $iteratorInstance;
}
- /**
- * Initializes the back-buffer by setting it to an empty string.
- *
- * @return void
- */
- private function initBackBuffer () {
- // Simply call the setter
- $this->setBackBuffer('');
- }
-
- /**
- * Setter for backBuffer field
- *
- * @param $backBuffer Characters to "store" in back-buffer
- * @return void
- */
- private function setBackBuffer ($backBuffer) {
- // Cast to string (so no arrays or objects)
- $backBuffer = (string) $backBuffer;
-
- // ... and set it
- $this->backBuffer = $backBuffer;
- }
-
- /**
- * Getter for backBuffer field
- *
- * @return $backBuffer Characters "stored" in back-buffer
- */
- private function getBackBuffer () {
- return $this->backBuffer;
- }
-
- /**
- * Setter for currentBlock field
- *
- * @param $currentBlock Characters to set a currently loaded block
- * @return void
- */
- private function setCurrentBlock ($currentBlock) {
- // Cast to string (so no arrays or objects)
- $currentBlock = (string) $currentBlock;
-
- // ... and set it
- $this->currentBlock = $currentBlock;
- }
-
/**
* Gets currently read data
*
* @return $current Currently read data
*/
public function current () {
- // Return it
- return $this->currentBlock;
+ // Call pointer instance
+ return $this->getPointerInstance()->current();
}
/**
* Advances to next "block" of bytes
*
* @return void
- * @todo This method will load large but empty files in a whole
*/
public function next () {
- // Is there nothing to read?
- if (!$this->valid()) {
- // Nothing to read
- return;
- } // END - if
-
- // First calculate minimum block length
- $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
-
- // Short be more than zero!
- assert($length > 0);
-
- // Wait until a entry/block separator has been found
- $data = $this->getBackBuffer();
- while ((!$this->getPointerInstance()->isEndOfFileReached()) && (!$this->getBlockInstance()->isBlockSeparatorFound($data))) {
- // Then read the block
- $data .= $this->read($length);
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('data()=' . strlen($data));
- } // END - if
-
- // EOF reached?
- if ($this->getPointerInstance()->isEndOfFileReached()) {
- // Set whole data as current block
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('Calling setCurrentBlock(' . strlen($data) . ') ...');
- $this->setCurrentBlock($data);
-
- // Then abort here silently
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('EOF reached.');
- return;
- } // END - if
-
- /*
- * Init back-buffer which is the data that has been found beyond the
- * separator.
- */
- $this->initBackBuffer();
-
- // Separate data
- $dataArray = explode(self::getBlockSeparator(), $data);
-
- // This array must contain two elements
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('dataArray=' . print_r($dataArray, TRUE));
- assert(count($dataArray) == 2);
-
- // Left part is the actual block, right one the back-buffer data
- $this->setCurrentBlock($dataArray[0]);
- $this->setBackBuffer($dataArray[1]);
+ // Call pointer instance
+ $this->getPointerInstance()->next();
}
/**
* @return $isValid Whether the next entry is valid
*/
public function valid () {
- // First calculate minimum block length
- $length = $this->getBlockInstance()->caluclateMinimumBlockLength();
-
- // Short be more than zero!
- assert($length > 0);
-
- // Get current seek position
- $seekPosition = $this->key();
-
- // Then try to read it
- $data = $this->read($length);
-
- // If some bytes could be read, all is fine
- $isValid = ((is_string($data)) && (strlen($data) > 0));
-
- // Get header size
- $headerSize = $this->getBlockInstance()->getHeaderSize();
-
- // Is the seek position at or beyond the header?
- if ($seekPosition >= $headerSize) {
- // Seek back to old position
- $this->seek($seekPosition);
- } else {
- // Seek directly behind the header
- $this->seek($headerSize);
- }
-
- // Return result
- return $isValid;
+ // Call pointer instance
+ return $this->getPointerInstance()->valid();
}
/**
*/
protected function initFileStack ($fileName, $type) {
// Get a stack file instance
- $fileInstance = ObjectFactory::createObjectByConfiguredName('stack_file_class', array($fileName));
+ $fileInstance = ObjectFactory::createObjectByConfiguredName('stack_file_class', array($fileName, $this));
// Get iterator instance
- $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance, $this));
+ $iteratorInstance = ObjectFactory::createObjectByConfiguredName('file_io_iterator_class', array($fileInstance));
// Is the instance implementing the right interface?
assert($iteratorInstance instanceof SeekableWritableFileIterator);
projects / core.git / commitdiff