X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FUtil%2FReversedFileReader.php;h=92c8cced184e1db5c8b602815ed3a4a9373af302;hb=eadcc8dc9338339f9790f580fc9c4be92b13e70b;hp=64d41b25d66115763006cd1d8d7828a6273c26fd;hpb=ec4f53d56f9aa2f82b1cf327a7f0869251fb1dbb;p=friendica.git

diff --git a/src/Util/ReversedFileReader.php b/src/Util/ReversedFileReader.php
index 64d41b25d6..92c8cced18 100644
--- a/src/Util/ReversedFileReader.php
+++ b/src/Util/ReversedFileReader.php
@@ -51,7 +51,7 @@ class ReversedFileReader implements \Iterator
 
 	/**
 	 * Open $filename for read and reset iterator
-	 * 
+	 *
 	 * @param string $filename	File to open
 	 * @return $this
 	 */
@@ -70,6 +70,11 @@ class ReversedFileReader implements \Iterator
 		return $this;
 	}
 
+	/**
+	 * Read $size bytes behind last position
+	 *
+	 * @return string
+	 */
 	private function _read($size)
 	{
 		$this->pos -= $size;
@@ -77,6 +82,12 @@ class ReversedFileReader implements \Iterator
 		return fread($this->fh, $size);
 	}
 
+	/**
+	 * Read next line from end of file
+	 * Return null if no lines are left to read
+	 *
+	 * @return ?string
+	 */
 	private function _readline()
 	{
 		$buffer = & $this->buffer;
@@ -84,6 +95,9 @@ class ReversedFileReader implements \Iterator
 			if ($this->pos == 0) {
 				return array_pop($buffer);
 			}
+			if (is_null($buffer)) {
+				return null;
+			}
 			if (count($buffer) > 1) {
 				return array_pop($buffer);
 			}
@@ -91,12 +105,24 @@ class ReversedFileReader implements \Iterator
 		}
 	}
 
+	/**
+	 * Fetch next line from end and set it as current iterator value.
+	 *
+	 * @see Iterator::next()
+	 * @return void
+	 */
 	public function next()
 	{
 		++$this->key;
 		$this->value = $this->_readline();
 	}
 
+	/**
+	 * Rewind iterator to the first line at the end of file
+	 *
+	 * @see Iterator::rewind()
+	 * @return void
+	 */
 	public function rewind()
 	{
 		if ($this->filesize > 0) {
@@ -108,16 +134,34 @@ class ReversedFileReader implements \Iterator
 		}
 	}
 
+	/**
+	 * Return current line number, starting from zero at the end of file
+	 *
+	 * @see Iterator::key()
+	 * @return int
+	 */
 	public function key()
 	{
 		return $this->key;
 	}
 
+	/**
+	 * Return current line
+	 *
+	 * @see Iterator::current()
+	 * @return string
+	 */
 	public function current()
 	{
 		return $this->value;
 	}
 
+	/**
+	 * Checks if current iterator value is valid, that is, we readed all lines in files
+	 *
+	 * @see Iterator::valid()
+	 * @return bool
+	 */
 	public function valid()
 	{
 		return ! is_null($this->value);