現在のキーを取得する

# AppendIterator::key

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

AppendIterator::key — 現在のキーを取得する

### 説明

public function AppendIterator::key(): scalar

現在のキーを取得します。

### パラメータ

この関数にはパラメータはありません。

### 戻り値

有効な状態の場合は現在のキー、それ以外の場合は `null` を返します。

### 例

例1 AppendIterator::key() の基本的な例

    <?php
    $array_a = new ArrayIterator(array('a' => 'aardwolf', 'b' => 'bear', 'c' => 'capybara'));
    $array_b = new ArrayIterator(array('apple', 'orange', 'lemon'));

    $iterator = new AppendIterator;
    $iterator->append($array_a);
    $iterator->append($array_b);

    // Manual iteration
    $iterator->rewind();
    while ($iterator->valid()) {
        echo $iterator->key() . ' ' . $iterator->current() . PHP_EOL;
        $iterator->next();
    }

    echo PHP_EOL;

    // With foreach
    foreach ($iterator as $key => $current) {
        echo $key . ' ' . $current . PHP_EOL;
    }
    ?>

上の例の出力は以下となります。

    a aardwolf
    b bear
    c capybara
    0 apple
    1 orange
    2 lemon

    a aardwolf
    b bear
    c capybara
    0 apple
    1 orange
    2 lemon

### 参考

- AppendIterator::current() - 現在の値を取得する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open