Manuel PHP - fgets - Récupère la ligne courante sur laquelle se trouve le pointeur du fichier

Description

string fgets ( resource $handle [, int $length ] )

Récupère la ligne courante sur laquelle se trouve le pointeur du fichier.

Liste de paramètres

handle: Le pointeur de fichier doit être valide et pointer sur un fichier ouvert avec succès par fopen() ou fsockopen() (et pas encore fermé par fclose()).
length: Lit jusqu'à la taille length - 1 octet depuis le pointeur de fichier handle, ou bien la fin du fichier, ou une nouvelle ligne (qui est inclue dans la valeur retournée), ou encore un EOF (celui qui arrive en premier). Si aucune longueur n'est fournie, la fonction lira le flux jusqu'à la fin de la ligne.

Note:
Jusqu'en PHP 4.3.0, le fait d'omettre ce paramètre fait que la fonction lira 1024 octets de la ligne. Si la majorité des lignes du fichier dépassent les 8 ko, il est plus efficace pour votre script de spécifier ce paramètre.

Valeurs de retour

Retourne une chaîne de caractères contenant les length premiers caractères, moins 1 octet depuis le pointeur de fichier handle. FALSE est retourné s'il n'y a plus de données à lire.

Si une erreur survient, la fonction retourne FALSE.

Historique

Version	Description
4.3.0	fgets() est compatible avec les données binaires.
4.2.0	Le paramètre `length` devient optionnel.

Exemples

Exemple #1 Lecture d'un fichier ligne par ligne

<?php
$handle = @fopen("/tmp/inputfile.txt", "r");
if ($handle) {
	while (($buffer = fgets($handle, 4096)) !== false) {
		echo $buffer;
	}
	if (!feof($handle)) {
		echo "Erreur: fgets() a échoué\n";
	}
	fclose($handle);
}
?>

Notes

Note: Si vous avez des problèmes avec PHP qui ne reconnaît pas certaines lignes lors de la lecture de fichiers qui ont été créés ou lus sur un MacIntosh, vous pouvez activer l'option de configuration auto_detect_line_endings.

Note:
Les programmeurs habitués à la programmation 'C' noteront que fgets() ne se comporte pas comme son équivalent C lors de la rencontre de la fin du fichier.

Voir aussi

fgetss() - Renvoie la ligne courante du fichier et élimine les balises HTML
fread() - Lecture du fichier en mode binaire
fgetc() - Lit un caractère dans un fichier
stream_get_line() - Lit une ligne dans un flux
fopen() - Ouvre un fichier ou une URL
popen() - Crée un processus de pointeur de fichier
fsockopen() - Ouvre un socket de connexion Internet ou Unix
stream_set_timeout() - Configure la durée d'expiration d'un flux