/**
* Close a file source and set it's instance to null and the file name
- * to empty
+ * to empty.
*
* @return void
- * @throws NullPointerException If the file pointer instance
- * is not set by setPointer()
+ * @throws NullPointerException If the file pointer instance is not set by setPointer()
* @throws InvalidResourceException If there is being set
*/
public function closeFile () {
* @param $filePointer File resource
* @return void
*/
- public final function setPointer ($filePointer) {
+ protected final function setPointer ($filePointer) {
$this->filePointer = $filePointer;
}
/**
* Getter for the file pointer
*
- * @return $filePointer The file pointer which shall be a valid
- * file resource
+ * @return $filePointer The file pointer which shall be a valid file resource
*/
public final function getPointer () {
return $this->filePointer;
* @param $fileName The new file name
* @return void
*/
- public final function setFileName ($fileName) {
+ protected final function setFileName ($fileName) {
$fileName = (string) $fileName;
$this->fileName = $fileName;
}
}
/**
- * "Getter" for seek position
+ * Determines seek position
*
* @return $seekPosition Current seek position
*/
- public final function getSeekPosition () {
+ public final function determineSeekPosition () {
return ftell($this->getPointer());
}
+ /**
+ * Determines whether the EOF has been reached
+ *
+ * @return $isEndOfFileReached Whether the EOF has been reached
+ */
+ public final function isEndOfFileReached () {
+ return feof($this->getPointer());
+ }
+
/**
* Seek to given offset (default) or other possibilities as fseek() gives.
*
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] CALLED!', __METHOD__, __LINE__));
// Get current seek position
- $seekPosition = $this->getSeekPosition();
+ $seekPosition = $this->determineSeekPosition();
// Seek to end
$seekStatus = $this->seek(0, SEEK_END);
//* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:%d:] seekStatus=%d', __METHOD__, __LINE__, $seekStatus));
// Get position again (which is the end of the file)
- $size = $this->getSeekPosition();
+ $size = $this->determineSeekPosition();
// Reset seek position to old
$this->seek($seekPosition);