- * Translates boolean TRUE to 'Y' and FALSE to 'N'
- *
- * @param $boolean Boolean value
- * @return $translated Translated boolean value
- */
- public static final function translateBooleanToYesNo ($boolean) {
- // Make sure it is really boolean
- assert(is_bool($boolean));
-
- // "Translate" it
- $translated = ($boolean === TRUE) ? 'Y' : 'N';
-
- // ... and return it
- return $translated;
- }
-
- /**
- * 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
- */
- protected function initCountersGapsArray () {
- // Init counter and seek position
- $this->setCounter(0);
- $this->setSeekPosition(0);
-
- // Init arrays
- $this->gaps = array();
- $this->damagedEntries = array();
- }
-
- /**
- * Getter for total entries
- *
- * @return $totalEntries Total entries in this file
- */
- protected final function getCounter () {
- // Get it
- return $this->totalEntries;
- }
-
- /**
- * 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
- */
- public 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;
- } // END - if
-
- // Return result
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] isInitialized=%d - EXIT!', __METHOD__, __LINE__, intval($isInitialized)));
- return $isInitialized;
- }
-
- /**
- * Checks whether the assigned file has been initialized
- *
- * @return $isInitialized Whether the file's size is zero
- */
- protected function isFileInitialized () {
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
-
- // size() must be callable
- assert(is_callable(array($this, 'size')));
-
- // Get it from iterator which holds the pointer instance. If FALSE is returned
- $fileSize = $this->size();
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] fileSize=%s', __METHOD__, __LINE__, $fileSize));
-
- /*
- * The returned file size should not be FALSE or NULL as this means
- * that the pointer class does not work correctly.
- */
- assert(is_int($fileSize));
-
- // Is more than 0 returned?
- $isInitialized = ($fileSize > 0);
-
- // Return result
- //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] isInitialized=%d - EXIT!', __METHOD__, __LINE__, intval($isInitialized)));
- return $isInitialized;
- }
-
- /**
- * Creates the assigned file