Edit Report a Bug

    The SeekableIterator interface

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

    Einführung

    The Seekable iterator.

    Interface-Übersicht

    interface SeekableIterator extends Iterator {
    /* Methoden */
    public seek(int $offset): void
    /* Geerbte Methoden */
    public Iterator::current(): mixed
    public Iterator::key(): mixed
    public Iterator::next(): void
    public Iterator::rewind(): void
    public Iterator::valid(): bool
    }

    Beispiel #1 Basic usage

    This example demonstrates creating a custom SeekableIterator, seeking to a position and handling an invalid position.

    <?php
    class MySeekableIterator implements SeekableIterator {

    private     $position;

    private     $array = array(
    "first element",
    "second element",
    "third element",
    "fourth element"
    );

    /* Method required for SeekableIterator interface */

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

    $this->position = $position;
    }

    /* Methods required for Iterator interface */

    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();
    }
    ?>

    Das oben gezeigte Beispiel erzeugt eine ähnliche Ausgabe wie:

    first element
third element
second element
invalid seek position (10)

    Inhaltsverzeichnis

    add a note add a note

    User Contributed Notes 6 notes

    up
    9
    svenr at selfhtml dot org
    13 years ago
    Best method:

    <?php

    if ($object instanceof SeekableIterator) {
      echo     "\$object has method seek()";
    }

    ?>

    Please, make use of checking if a particular interface has been implemented to assure that the object you are dealing with definately has the methods you are about to use.

    This also works as typehinting:

    <?php

    class foo {
      public function     doSomeSeeking(SeekableIterator $seekMe) {
            $seekMe->seek(10); // will work, otherwise Typehint triggers complaints
          }
    }

    ?>
    up
    1
    info at ensostudio dot ru
    4 years ago
    Note: use array_key_exists instead isset!
    <?php
    public function seek($position)
    {
            $position = (int) $position;
        if (!     array_key_exists($position, array_values($this->array))) {
            throw new     OutOfBoundsException('Invalid position to seek: ' . $position);
        }
            $this->position = $position;
    }
    ?>
    up
    0
    info at ensostudio dot ru
    2 years ago
    Note: $offset parameter of SeekableIterator::seek()  is position in list, not array key.
    <?php
    $iterator     = new ArrayIterator([1 => "apple", 2 => "banana", 3 => "cherry"]);
    echo     $iterator->offsetGet(2); // banana
    $iterator->seek(2);
    echo     $iterator->current(); // cherry
    ?>
    up
    0
    Anonymous
    11 years ago
    The code above is missing a closing parenthesis.

    <?php
    if (!isset($this->array[$position]) {
              throw new     OutOfBoundsException("invalid seek position ($position)");
    }
    ?>

    should be

    <?php
    if (!isset($this->array[$position])) { // close here
                  throw new OutOfBoundsException("invalid seek position ($position)");
    }
    ?>
    up
    -8
    martin at smasty dot net
    13 years ago
    The reflection approach:

    <?php

    $reflection     = new ReflectionClass('MySeekableIterator');
    if(    $reflection->hasMethod('seek'))
      echo     "This class has method seek().";

    ?>
    up
    -16
    marcin dot kleczek at gmail dot com
    14 years ago
    Better method:

    <?php
                $class     = 'SeekableIterator';
                    $findingMethod = 'seek'; // have to be lower chars
              
                    $methods = get_class_methods($class);
              
                foreach(     $methods as $pVal )
                    if (     $findingMethod == strtolower($pVal) ) {
                        echo     'This class has method seek().';
                        break;
                    }

    }

    ?>

    Best method: http://php.net/manual/en/function.method-exists.php
    add a note add a note
    To Top