Home/ Manual/ spl / splfileobject/ SplFileObject::key

SplFileObject::key

PHP function Edit on GitHub ✎

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

Get line number

Description

SplFileObject::key(): int

Gets the current line number.

Note

This number may not reflect the actual line number in the file if SplFileObject::setMaxLineLen is used to read fixed lengths of the file.

Parameters Parameters

Return Values

Returns the current line number.

Examples

SplFileObject::key example

php

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

The above example will output something similar to:

output

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.

SplFileObject::key example with SplFileObject::setMaxLineLen

php

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