Funciones del Sistema de Archivos
PHP Manual

fgets

(PHP 4, PHP 5)

fgetsObtiene un línea del puntero a un archivo

Descripción

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

Obtiene una línea del puntero al archivo.

Parámetros

handle

El fichero al que se apunta debe ser válido, y debe apuntar a un fichero abierto por fopen() o fsockopen() (y que todavía no esté cerrado por fclose()).

length

La lectura termina cuando se han leído length - 1 bytes, en una nueva línea (la cual está incluida en el valor de retorno), o en EOF (lo que suceda primero). Si no se especifiva una longitud, serguirá leyendo desde el flujo hasta que alcance el final de la línea.

Nota:

Hasta PHP 4.3.0, al omitirlo se asumía una longitud de línea de 1024. Si la mayoría de las lineas en el archivo son todas mayores de 8KB, es más eficiente para el script especificar la longitud máxima de línea.

Valores devueltos

Devuelve una cadena de hasta length - 1 bytes leídos desde el archivo apuntado por handle. Si no hay más información que leer en el puntero al fichero, devuelve FALSE.

Si se produjo un error, devuelve FALSE.

Historial de cambios

Versión Descripción
4.3.0 fgets() ahora es segura al trabajar con datos binarios
4.2.0 El parámetro length se volvió opcional

Ejemplos

Ejemplo #1 Leer un archivo línea a línea

<?php
$gestor 
= @fopen("/tmp/inputfile.txt""r");
if (
$gestor) {
    while ((
$buffer fgets($gestor4096)) !== false) {
        echo 
$buffer;
    }
    if (!
feof($gestor)) {
        echo 
"Error: fallo inesperado de fgets()\n";
    }
    
fclose($gestor);
}
?>

Notas

Nota: Si sufre problemas con PHP no reconociendo los finales de línea cuando lee o crea ficheros en Macintosh, puede probar de activar la opción de configuración en tiempo de ejecución auto_detect_line_endings para intentar resolver el problema.

Nota:

La gente que suele usar la semántica tipo 'C' de fgets() debería observar la diferencia de cómo EOF es devuelto.

Ver también


Funciones del Sistema de Archivos
PHP Manual