PHP Manual»Funciones del Sistema de Archivos»fgets

fgets

(PHP 4, PHP 5, PHP 7, PHP 8)

fgets — Recupera la línea actual a partir de la posición del puntero de archivo

Descripción

function fgets(resource $stream, ?int $length = null): string|false

Recupera la línea actual a partir de la posición del puntero de archivo.

Parámetros

stream: El puntero de fichero debe ser válido y apuntar a un archivo abierto con éxito por fopen() o fsockopen() (y no cerrado aún por fclose()).
length: Lee hasta la longitud length - 1 byte desde el puntero de archivo stream, o bien el final del archivo, o una nueva línea (que es incluida en el valor devuelto), o un EOF (el que llegue primero). Si no se proporciona longitud, la función leerá el flujo hasta el final de la línea.

Valores devueltos

Devuelve un string que contiene los length primeros caracteres, menos 1 byte desde el puntero de archivo stream. false es devuelto si no hay más datos para leer.

Si ocurre un error, la función devuelve false.

Ejemplos

Ejemplo #1 Lectura de un archivo línea por línea

<?php

$fp = @fopen("/tmp/inputfile.txt", "r");

if ($fp) {
    while (($buffer = fgets($fp, 4096)) !== false) {
        echo $buffer, PHP_EOL;
    }
    if (!feof($fp)) {
        echo "Error: fgets() falló\n";
    }

    fclose($fp);
}

?>

Notas

Nota:
Antes de PHP 8.1.0, la opción de configuración en tiempo de ejecución auto_detect_line_endings se podía activar para ayudar a PHP a reconocer correctamente los finales de línea al leer ficheros creados en sistemas Macintosh. Esta opción está obsoleta a partir de PHP 8.1.0. Si es necesario, en su lugar se deben gestionar manualmente los saltos de línea "\r".

Nota:
Los programadores acostumbrados a la programación 'C' notarán que fgets() no se comporta como su equivalente en C al encontrar el final del archivo.

Véase también

fgetss() - Obtiene un línea desde un puntero a un archivo y elimina las etiquetas HTML
fread() - Lectura del archivo en modo binario
fgetc() - Lee un carácter en un fichero
stream_get_line() - Lee una línea en un flujo
fopen() - Abre un fichero o un URL
popen() - Crea un puntero de archivo de proceso
fsockopen() - Abre un socket de conexión Internet o Unix
stream_set_timeout() - Configura el tiempo de espera de un flujo