Function renamed

[friendica.git] / src / Util / ReversedFileReader.php

diff --git a/src/Util/ReversedFileReader.php b/src/Util/ReversedFileReader.php
index 0566002de29e899e75034972d51f2fa4ad023be1..fdd15bec90520cdf6fa266b4cf29e6d0b70ca5bd 100644 (file)
--- a/src/Util/ReversedFileReader.php
+++ b/src/Util/ReversedFileReader.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -55,12 +55,12 @@ 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) {
                        // this should use a custom exception.
-                       throw \Exception("Unable to open $filename");
+                       throw new \Exception("Unable to open $filename");
                }
                $this->filesize = filesize($filename);
                $this->pos      = -1;
@@ -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,18 +152,18 @@ class ReversedFileReader implements \Iterator
         * @see Iterator::current()
         * @return string
         */
-       public function current()
+       public function current(): string
        {
                return $this->value;
        }
 
        /**
-        * Checks if current iterator value is valid, that is, we readed all lines in files
+        * Checks if current iterator value is valid, that is, we read all lines in files
         *
         * @see Iterator::valid()
         * @return bool
         */
-       public function valid()
+       public function valid(): bool
        {
                return ! is_null($this->value);
        }