PHP Conference Japan 2024

    SeekableIterator 接口

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

    简介

    可寻址迭代器。

    接口概要

    interface SeekableIterator extends Iterator {
    /* 方法 */
    public seek(int $offset): void
    /* 继承的方法 */
    public Iterator::current(): mixed
    public Iterator::key(): mixed
    public Iterator::next(): void
    public Iterator::rewind(): void
    public Iterator::valid(): bool
    }

    示例

    示例 #1 基本用法

    此示例演示如何创建自定义 SeekableIterator，跳转到某个位置并处理无效位置。

    <?php
    class MySeekableIterator implements SeekableIterator {

    private     $position;

    private     $array = array(
    "第一个元素",
    "第二个元素",
    "第三个元素",
    "第四个元素"
    );

    /* SeekableIterator 接口所需的方法 */

    public function seek($position) {
    if (!isset(    $this->array[$position])) {
    throw new     OutOfBoundsException("无效的跳转位置（$position）");
    }

    $this->position = $position;
    }

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

    以上示例将输出类似以下内容

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

    目录

    发现问题？

    了解如何改进此页面 • 提交拉取请求 • 报告错误
    ＋添加注释

    用户贡献的注释 4 条注释

    8
    svenr at selfhtml dot org
    13 年前
    最佳方法

    <?php

    if ($object instanceof SeekableIterator) {
    echo     "\$object 有 seek() 方法";
    }

    ?>

    请使用检查是否已实现特定接口的方法，以确保您正在处理的对象确实具有您即将使用的方法。

    这也适用于类型提示

    <?php

    class foo {
    public function     doSomeSeeking(SeekableIterator $seekMe) {
    $seekMe->seek(10); // 将会工作，否则类型提示会触发报错
    }
    }

    ?>
    1
    info at ensostudio dot ru
    2 年前
    注意：SeekableIterator::seek() 的 $offset 参数是列表中的位置，而不是数组键。
    <?php
    $iterator     = new ArrayIterator([1 => "apple", 2 => "banana", 3 => "cherry"]);
    echo     $iterator->offsetGet(2); // banana
    $iterator->seek(2);
    echo     $iterator->current(); // cherry
    ?>
    -1
    info at ensostudio dot ru
    4 年前
    注意：使用 array_key_exists 代替 isset！
    <?php
    public function seek($position)
    {
    $position = (int) $position;
    if (!     array_key_exists($position, array_values($this->array))) {
    throw new     OutOfBoundsException('无效的跳转位置: ' . $position);
    }
    $this->position = $position;
    }
    ?>
    -2
    匿名用户
    11 年前
    上面的代码缺少一个闭合括号。

    <?php
    if (!isset($this->array[$position]) {
    throw new     OutOfBoundsException("无效的跳转位置 ($position)");
    }
    ?>

    应为

    <?php
    if (!isset($this->array[$position])) { // 在此处闭合
    throw new OutOfBoundsException("无效的跳转位置 ($position)");
    }
    ?>
    ＋添加注释
    To Top