Получает номер строки

# SplFileObject::key

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

SplFileObject::key — Получает номер строки

### Описание

public function SplFileObject::key(): int

Получает номер текущей строки.

> Замечание:

> Этот номер может отличаться от реального положения файлового указателя, когда читаются строки фиксированной длины с заданием этой длины методом SplFileObject::setMaxLineLen().

### Список параметров

Сигнатура функции не содержит параметров.

### Возвращаемые значения

Возвращает номер текущей строки файла.

### Примеры

Пример #1 Пример использования SplFileObject::key()

    <?php
    $file = new SplFileObject("lipsum.txt");
    foreach ($file as $line) {
        echo $file->key() . ". " . $line;
    }
    ?>

Вывод приведённого примера будет похож на:

    0. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
    1. Duis nec sapien felis, ac sodales nisl.
    2. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Пример #2 Пример использования SplFileObject::key() при задании длины строки методом SplFileObject::setMaxLineLen()

    <?php
    $file = new SplFileObject("lipsum.txt");
    $file->setMaxLineLen(20);
    foreach ($file as $line) {
        echo $file->key() . ". " . $line . "\n";
    }
    ?>

Вывод приведённого примера будет похож на:

    0. Lorem ipsum dolor s
    1. it amet, consectetu
    2. r adipiscing elit.
    3.

    4. Duis nec sapien fel
    5. is, ac sodales nisl
    6. .

    7. Lorem ipsum dolor s
    8. it amet, consectetu
    9. r adipiscing elit.

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

- SplFileObject::current() - Получает текущую строку файла
- SplFileObject::seek() - Перемещает файловый указатель на заданную строку
- SplFileObject::next() - Считывает следующую строку
- SplFileObject::rewind() - Отматывает файловый указатель в начало файла
- SplFileObject::valid() - Проверяет, достигнут ли конец файла (EOF)

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