Интерфейс SeekableIterator

(PHP 5 >= 5.1.0)

Введение

Итератор Seekable.

Обзор интерфейсов

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

Пример #1 Простое использование

Этот пример демонстрирует создание пользовательского итератора SeekableIterator, который ищет позицию и обрабатывает недействильную позицию.

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

    
/* Методы, необходимые для интерфейса Iterator */
    
    
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)

Содержание

Коментарии

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

?>
2011-11-14 18:21:20
http://php5.kiev.ua/manual/ru/class.seekableiterator.html
Автор:
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)");
}
?>
2013-10-20 03:43:08
http://php5.kiev.ua/manual/ru/class.seekableiterator.html
Note: use array_key_exists instead isset!
<?php
public function seek($position)
{
   
$position = (int) $position;
    if (! 
array_key_exists($positionarray_values($this->array))) {
        throw new 
OutOfBoundsException('Invalid position to seek: ' $position);
    }
   
$this->position $position;
}
?>
2020-10-20 22:20:33
http://php5.kiev.ua/manual/ru/class.seekableiterator.html
Note: $offset parameter of SeekableIterator::seek()  is position in list, not array key.
<?php
$iterator 
= new ArrayIterator([=> "apple"=> "banana"=> "cherry"]);
echo 
$iterator->offsetGet(2); // banana
$iterator->seek(2);
echo 
$iterator->current(); // cherry
?>
2022-07-18 10:30:42
http://php5.kiev.ua/manual/ru/class.seekableiterator.html

    Поддержать сайт на родительском проекте КГБ