接口
在线手册：中文 英文
PHP手册

The SeekableIterator interface

(PHP 5 >= 5.1.0)

简介

The Seekable iterator.

接口摘要

SeekableIterator extends Iterator {
/* 方法 */
abstract public void seek ( int $position )
/* 继承的方法 */
abstract public mixed Iterator::current ( void )
abstract public scalar Iterator::key ( void )
abstract public void Iterator::next ( void )
abstract public void Iterator::rewind ( void )
abstract public boolean Iterator::valid ( void )
}

Example #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 = 0;

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

    public function seek($position) {
      $this->position = $position;
      
      if (!$this->valid()) {
          throw new OutOfBoundsException("invalid seek position ($position)");
      }
    }

    /* Methods required for Iterator interface */
    
    public function __construct() {
        $this->position = 0;
    }

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

以上例程的输出类似于：

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

Table of Contents

接口
在线手册：中文 英文
PHP手册
PHP手册 - N: The SeekableIterator interface

用户评论:

svenr at selfhtml dot org (15-Nov-2011 12:21)

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
  }
}

?>

martin at smasty dot net (15-May-2011 04:01)

The reflection approach:

<?php

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

?>

marcin dot kleczek at gmail dot com (15-Apr-2010 07:59)

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

dreake at example dot com (30-Jun-2009 10:38)

This example show how to check if some class has method seek() (or another method).

<?php
$class = 'SeekableIterator';
            $findingMethod = 'seek'; // have to be lower chars
           
            $methods = get_class_methods($class);
           
            for($i = 0, $ii = count($methods); $i < $ii; $i++){
                $sl = strtolower($methods[$i]);
                $lowermethods[$i] = $sl;
            }
           
           
            if(in_array($findingMethod,$lowermethods))
                echo 'This class has method seek().';
?>