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() 方法獲取當前元素的鍵名並進行輸出。