SplFileObject::key

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

SplFileObject::key — Récupère le numéro de la ligne courant

Description

public SplFileObject::key(): int

Récupère le numéro de la ligne courant.

Note:
Ce nombre peut ne pas être exact si la méthode SplFileObject::setMaxLineLen() est utilisée pour lire une longueur fixe du fichier.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne le numéro de la ligne courante.

Exemples

Exemple #1 Exemple avec SplFileObject::key()

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

Résultat de l'exemple ci-dessus est similaire à :

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.

Exemple #2 Exemple avec SplFileObject::key() et SplFileObject::setMaxLineLen()

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

Résultat de l'exemple ci-dessus est similaire à :

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.

Voir aussi

SplFileObject::current() - Récupère la ligne courante d'un fichier
SplFileObject::seek() - Se déplace sur une ligne spécifique
SplFileObject::next() - Se déplace sur la prochaine ligne
SplFileObject::rewind() - Réinitialise le fichier à la première ligne
SplFileObject::valid() - Vérifie si la fin du fichier a été atteinte

add a note

User Contributed Notes 1 note

down

xzero at elite7hackers dot net ¶

4 years ago


Another gotcha that is not mentioned: If you have flag SKIP_EMPTY set, then key() will not reflect actual line numbers as empty lines are not accounted.

add a note