Возвращает текущий ключ

# 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);

    // Ручная итерация
    $iterator->rewind();
    while ($iterator->valid()) {
        echo $iterator->key() . ' ' . $iterator->current() . PHP_EOL;
        $iterator->next();
    }

    echo PHP_EOL;

    // С конструкцией 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

### Смотрите также

- Iterator::key() - Возвращает ключ текущего элемента
- AppendIterator::current() - Возвращает текущее значение
- AppendIterator::valid() - Проверяет срок действия текущего элемента
- AppendIterator::next() - Переходит к следующему элементу
- AppendIterator::rewind() - Перематывает итератор

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