Iterator::key()函数—用法及示例

函数名称：Iterator::key()

函数描述：获取当前迭代器指针所指向的元素的键名。

适用版本：PHP 5, PHP 7

用法： Iterator::key() 方法用于返回当前迭代器指针所指向的元素的键名。它可以与迭代器对象一起使用。

语法： public Iterator::key ( void ) : mixed

参数： 该函数没有参数。

返回值： 返回当前迭代器指针所指向的元素的键名。如果指针无效，则返回 NULL。

示例：

// 创建一个实现了迭代器接口的类
class MyIterator implements Iterator {
    private $position = 0;
    private $array = array(
        "键1" => "值1",
        "键2" => "值2",
        "键3" => "值3"
    );

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

// 创建一个迭代器对象
$it = new MyIterator;

// 使用key()方法获取当前元素的键名
echo "当前元素的键名为：" . $it->key(); // 输出：当前元素的键名为：0
$it->next(); // 移动指针到下一个元素
echo "当前元素的键名为：" . $it->key(); // 输出：当前元素的键名为：1

在上面的示例中，我们创建了一个实现了迭代器接口的类 MyIterator。在 key() 方法中，我们返回了当前指针的位置，然后通过迭代器对象 $it 的 key() 方法获取当前元素的键名并进行输出。