PHP File Iterator Class

TxtFileIterator.php

<?php


class TxtFileIterator implements \Iterator
{
    protected $fileHandler;
    protected $current;
    protected $key;

    function __construct(string $filePath)
    {
        $this->fileHandler = fopen($filePath, "r") or die("Unable to open file!");
        $this->key = 0;
    }

    function __destruct()
    {
        fclose($this->fileHandler);
    }

    public function current()
    {
        return $this->current;
    }

    public function key()
    {
        return $this->key;
    }

    public function next(): void
    {
        $this->current = fgets($this->fileHandler);
        $this->key++;
    }

    public function rewind(): void
    {
        rewind($this->fileHandler);
        $this->current = fgets($this->fileHandler);
    }

    public function valid(): bool
    {
        return $this->current !== false;
    }
}

// Example
$iterator = new TxtFileIterator('path/file.txt');


// Use "foreach"
foreach ($iterator as $line) {
    var_dump($line);
}

// Or "while"
$iterator->rewind();

while ($iterator->valid()) {
    $key = $iterator->key();
    $value = $iterator->current();
    
    var_dump($key, $value);
    
    $iterator->next();
}