*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Hub Developer Team
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
$iteratorInstance = new FileIterator();
// Set the instance here
+ /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d] Setting blockInstance=%s ...', __METHOD__, __LINE__, $blockInstance->__toString()));
$iteratorInstance->setBlockInstance($blockInstance);
// Return the prepared instance
return $this->getBlockInstance()->seek($seekPosition);
}
- /**
- * Writes at given position by seeking to it.
- *
- * @param $seekPosition Seek position in file
- * @param $data Data to be written
- * @return void
- */
- public function writeAtPosition ($seekPosition, $data) {
- // First seek to it
- $this->seek($seekPosition);
-
- // Then write the data at that position
- $this->getBlockInstance()->writeToFile($data);
- }
-
/**
* Size of file stack
*
* @param $bytes Amount of bytes to read
* @return $data Data read from file
*/
- public function read ($bytes) {
+ public function read ($bytes = NULL) {
// Call block instance
return $this->getBlockInstance()->read($bytes);
}
// Just call the block instance
$this->getBlockInstance()->preAllocateFile($type);
}
+
+ /**
+ * Initializes counter for valid entries, arrays for damaged entries and
+ * an array for gap seek positions. If you call this method on your own,
+ * please re-analyze the file structure. So you are better to call
+ * analyzeFile() instead of this method.
+ *
+ * @return void
+ */
+ public function initCountersGapsArray () {
+ // Call block instance
+ $this->getBlockInstance()->initCountersGapsArray();
+ }
+
+ /**
+ * Getter for header size
+ *
+ * @return $totalEntries Size of file header
+ */
+ public final function getHeaderSize () {
+ // Call block instance
+ return $this->getBlockInstance()->getHeaderSize();
+ }
+
+ /**
+ * Setter for header size
+ *
+ * @param $headerSize Size of file header
+ * @return void
+ */
+ public final function setHeaderSize ($headerSize) {
+ // Call block instance
+ $this->getBlockInstance()->setHeaderSize($headerSize);
+ }
+
+ /**
+ * Getter for header array
+ *
+ * @return $totalEntries Size of file header
+ */
+ public final function getHeader () {
+ // Call block instance
+ return $this->getBlockInstance()->getHeader();
+ }
+
+ /**
+ * Setter for header
+ *
+ * @param $header Array for a file header
+ * @return void
+ */
+ public final function setHeader (array $header) {
+ // Call block instance
+ $this->getBlockInstance()->setHeader($header);
+ }
+
+ /**
+ * Updates seekPosition attribute from file to avoid to much access on file.
+ *
+ * @return void
+ */
+ public function updateSeekPosition () {
+ // Call block instance
+ $this->getBlockInstance()->updateSeekPosition();
+ }
+
+ /**
+ * Getter for total entries
+ *
+ * @return $totalEntries Total entries in this file
+ */
+ public final function getCounter () {
+ // Call block instance
+ return $this->getBlockInstance()->getCounter();
+ }
+
+ /**
+ * "Getter" for file size
+ *
+ * @return $fileSize Size of currently loaded file
+ */
+ public function getFileSize () {
+ // Call block instance
+ return $this->getBlockInstance()->getFileSize();
+ }
+
+ /**
+ * Writes data at given position
+ *
+ * @param $seekPosition Seek position
+ * @param $data Data to be written
+ * @param $flushHeader Whether to flush the header (default: flush)
+ * @return void
+ */
+ public function writeData ($seekPosition, $data, $flushHeader = TRUE) {
+ // Call block instance
+ $this->getBlockInstance()->writeData($seekPosition, $data, $flushHeader);
+ }
+
+ /**
+ * Getter for seek position
+ *
+ * @return $seekPosition Current seek position (stored here in object)
+ */
+ public function getSeekPosition () {
+ // Call block instance
+ return $this->getBlockInstance()->getSeekPosition();
+ }
+
+ /**
+ * Writes given value to the file and returns a hash and gap position for it
+ *
+ * @param $groupId Group identifier
+ * @param $value Value to be added to the stack
+ * @return $data Hash and gap position
+ */
+ public function writeValueToFile ($groupId, $value) {
+ // Call block instance
+ return $this->getBlockInstance()->writeValueToFile($groupId, $value);
+ }
+
+ /**
+ * Writes given raw data to the file and returns a gap position and length
+ *
+ * @param $groupId Group identifier
+ * @param $hash Hash from encoded value
+ * @param $encoded Encoded value to be written to the file
+ * @return $data Gap position and length of the raw data
+ */
+ public function writeDataToFreeGap ($groupId, $hash, $encoded) {
+ // Call block instance
+ return $this->getBlockInstance()->writeDataToFreeGap($groupId, $hash, $encoded);
+ }
+
+ /**
+ * Searches for next suitable gap the given length of data can fit in
+ * including padding bytes.
+ *
+ * @param $length Length of raw data
+ * @return $seekPosition Found next gap's seek position
+ */
+ public function searchNextGap ($length) {
+ // Call block instance
+ print $this->getBlockInstance()->__toString() . PHP_EOL;
+ return $this->getBlockInstance()->searchNextGap($length);
+ }
}
// [EOF]
projects / core.git / blobdiff