fgets

(PHP 4, PHP 5)

fgetsR�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 inclut 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 .

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 (!
feof($handle)) {
        
$buffer fgets($handle4096);
        echo 
$buffer;
    }
    
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 une socket de connexion Internet ou Unix
  • stream_set_timeout() - Configure la dur�e d'expiration d'un flux