- /**
- * Setter for total entries
- *
- * @param $totalEntries Total entries in this file
- * @return void
- */
- protected final function setCounter ($counter) {
- // Set it
- $this->totalEntries = $counter;
- }
-
- /**
- * Increment counter
- *
- * @return void
- */
- protected final function incrementCounter () {
- // Get it
- $this->totalEntries++;
- }
-
- /**
- * Getter for header size
- *
- * @return $totalEntries Size of file header
- */
- protected final function getHeaderSize () {
- // Get it
- return $this->headerSize;
- }
-
- /**
- * Setter for header size
- *
- * @param $headerSize Size of file header
- * @return void
- */
- protected final function setHeaderSize ($headerSize) {
- // Set it
- $this->headerSize = $headerSize;
- }
-
- /**
- * Getter for header array
- *
- * @return $totalEntries Size of file header
- */
- protected final function getHeade () {
- // Get it
- return $this->header;
- }
-
- /**
- * Setter for header
- *
- * @param $header Array for a file header
- * @return void
- */
- protected final function setHeader (array $header) {
- // Set it
- $this->header = $header;
- }
-
- /**
- * Getter for seek position
- *
- * @return $seekPosition Current seek position (stored here in object)
- */
- protected final function getSeekPosition () {
- // Get it
- return $this->seekPosition;
- }
-
- /**
- * Setter for seek position
- *
- * @param $seekPosition Current seek position (stored here in object)
- * @return void
- */
- protected final function setSeekPosition ($seekPosition) {
- // And set it
- $this->seekPosition = $seekPosition;
- }
-
- /**
- * Updates seekPosition attribute from file to avoid to much access on file.
- *
- * @return void
- */
- protected function updateSeekPosition () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
- // Get key (= seek position)
- $seekPosition = $this->getIteratorInstance()->key();
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Setting seekPosition=%s', __METHOD__, __LINE__, $seekPosition));
-
- // And set it here
- $this->setSeekPosition($seekPosition);
-
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] EXIT!', __METHOD__, __LINE__));
- }
-
- /**
- * Checks whether the file header is initialized
- *
- * @return $isInitialized Whether the file header is initialized
- */
- protected function isFileHeaderInitialized () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
- // Is the method there?
- assert(is_callable(array($this, 'readFileHeader')));
-
- // Default is not initialized
- $isInitialized = FALSE;
-
- // Is the file initialized?
- if ($this->isFileInitialized()) {
- // Some bytes has been written, so rewind to start of it.
- $rewindStatus = $this->getIteratorInstance()->rewind();
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] rewindStatus=%s', __METHOD__, __LINE__, $rewindStatus));
-
- // Is the rewind() call successfull?
- if ($rewindStatus != 1) {
- // Something bad happened
- self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] Could not rewind().', __METHOD__, __LINE__));
- } // END - if
-
- // Read file header
- $this->readFileHeader();
-
- // The above method does already check the header
- $isInitialized = TRUE;