From 4164cdacf5743ce327828214006ded4f522dede4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Roland=20H=C3=A4der?= <roland@mxchange.org>
Date: Fri, 24 Jun 2022 06:27:38 +0200
Subject: [PATCH] Changes: - added type-hints - added documentation

---
 src/Util/ReversedFileReader.php | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/src/Util/ReversedFileReader.php b/src/Util/ReversedFileReader.php
index 0566002de2..cda78ad0ab 100644
--- a/src/Util/ReversedFileReader.php
+++ b/src/Util/ReversedFileReader.php
@@ -55,7 +55,7 @@ class ReversedFileReader implements \Iterator
 	 * @param string $filename	File to open
 	 * @return $this
 	 */
-	public function open(string $filename)
+	public function open(string $filename): ReversedFileReader
 	{
 		$this->fh = fopen($filename, 'r');
 		if (!$this->fh) {
@@ -73,9 +73,10 @@ class ReversedFileReader implements \Iterator
 	/**
 	 * Read $size bytes behind last position
 	 *
+	 * @param int $size
 	 * @return string
 	 */
-	private function _read($size)
+	private function _read(int $size): string
 	{
 		$this->pos -= $size;
 		fseek($this->fh, $this->pos);
@@ -86,7 +87,7 @@ class ReversedFileReader implements \Iterator
 	 * Read next line from end of file
 	 * Return null if no lines are left to read
 	 *
-	 * @return ?string
+	 * @return string|null Depending on data being buffered
 	 */
 	private function _readline()
 	{
@@ -140,7 +141,7 @@ class ReversedFileReader implements \Iterator
 	 * @see Iterator::key()
 	 * @return int
 	 */
-	public function key()
+	public function key(): int
 	{
 		return $this->key;
 	}
@@ -151,7 +152,7 @@ class ReversedFileReader implements \Iterator
 	 * @see Iterator::current()
 	 * @return string
 	 */
-	public function current()
+	public function current(): string
 	{
 		return $this->value;
 	}
@@ -162,7 +163,7 @@ class ReversedFileReader implements \Iterator
 	 * @see Iterator::valid()
 	 * @return bool
 	 */
-	public function valid()
+	public function valid(): bool
 	{
 		return ! is_null($this->value);
 	}