L'interface SeekableIterator

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Introduction

L'itérateur SeekableIterator.

Sommaire de l'Interface

interface SeekableIterator extends Iterator {
/* Méthodes */
public function seek(int $offset): void
/* Méthodes héritées */
public function Iterator::current(): mixed
public function Iterator::key(): mixed
public function Iterator::next(): void
public function Iterator::rewind(): void
public function Iterator::valid(): bool
}

Exemples

Exemple #1 Utilisation simple

Cet exemple montre comment crée une classe SeekableIterator personnalisée, qui gère une position invalide. 

<?php
class MySeekableIterator implements SeekableIterator {

    private $position;

    private $array = array(
        "premier élément",
        "second élément",
        "troisième élément",
        "quatrième élément"
    );

    /* Méthode requise pour l'interface SeekableIterator */

    public function seek($position) {
      if (!isset($this->array[$position])) {
          throw new OutOfBoundsException("position invalide ($position)");
      }

      $this->position = $position;
    }

    /* Méthodes requises par l'interface Iterator */
    
    public function rewind() {
        $this->position = 0;
    }

    public function current() {
        return $this->array[$this->position];
    }

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

    public function next() {
        ++$this->position;
    }

    public function valid() {
        return isset($this->array[$this->position]);
    }
}

try {

    $it = new MySeekableIterator;
    echo $it->current(), "\n";
    
    $it->seek(2);
    echo $it->current(), "\n";
    
    $it->seek(1);
    echo $it->current(), "\n";
    
    $it->seek(10);
    
} catch (OutOfBoundsException $e) {
    echo $e->getMessage();
}
?>

Résultat de l'exemple ci-dessus est similaire à :

premier élément
troisième élément
second élément
position invalide (10)

Sommaire