fgets
(PHP 4, PHP 5)
fgets — Obtiene una línea desde el puntero a un fichero
Descripción
$handle
[, int $length
] )Obtiene una línea desde el puntero al fichero.
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, o una nueva línea (la cual está incluida en el valor de retorno), o un EOF (lo que suceda primero). Si no se especifica una longitud, se 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 del fichero son todas mayores de 8KB, es más eficiente para el script en cuestión de recursos especificar la longitud máxima de línea.
Valores devueltos
Devuelve una cadena de hasta length - 1 bytes leídos desde
el fichero apuntado por handle. Si no hay más datos
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 |
Ejemplos
Ejemplo #1 Leer un fichero línea a línea
<?php
$gestor = @fopen("/tmp/inputfile.txt", "r");
if ($gestor) {
while (($búfer = fgets($gestor, 4096)) !== false) {
echo $búfer;
}
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:
Las personas que suele usar la semántica tipo 'C' de fgets() deberían observar la diferencia de cómo se devuelve EOF.
Ver también
- fgetss() - Obtiene un línea desde un puntero a un archivo y elimina las etiquetas HTML
- fread() - Lectura de un fichero en modo binario seguro
- fgetc() - Obtiene un carácter de un puntero a un archivo
- stream_get_line() - Obtiene una línea del recurso de flujo hasta un delimitador dado
- fopen() - Abre un fichero o una URL
- popen() - Abre un proceso de un puntero a un fichero
- fsockopen() - Abre una conexión vía sockets a Internet o a un dominio Unix
- stream_set_timeout() - Establecer un perido de tiempo de espera en un flujo