Devuelve una cadena de hasta longitud - 1 bytes leÃdos desde el archivo apuntado por gestor. La lectura termina cuando se han leÃdo longitud - 1 bytes, se alcanza un salto de lÃnea (el cual se incluye en el valor devuelto), o en EOF (lo que ocurra primero). Si no se especifica una longitud, el valor predeterminado es de 1k, o 1024 bytes.
Si ocurre un error, devuelve FALSE.
Errores comunes:
Aquellos acostumbrados a la semántice de fgets() en 'C', debe notar la diferencia en el modo en que EOF es devuelto.
El puntero de fichero debe de ser valido y debe de apuntar a un fichero abierto con exito por fopen() o fsockopen().
A continuación se presenta un ejemplo simple:
Nota: El parámetro longitud se hizo opcional en PHP 4.2.0, si se omite, se asume 1024 como la longitud de lÃnea. A partir de PHP 4.3, al omitir longitud, la lectura de la secuencia continuará hasta que se alcance el final de la lÃnea. Si la mayorÃa de lÃneas en el archivo superan los 8KB, es más eficiente en términos de recursos espicificar la longitud máxima de lÃnea en su script.
Nota: Esta función es segura con material binario desde PHP 4.3. Las versiones anteriores no contaban con ésta caracterÃstica.
Nota: Si sufre problemas con PHP no reconociendo los finales de lÃnea cuando lee archivos creados en un Macintosh (o leyendo archivos sobre uno), puede probar activando la opción de configuración auto_detect_line_endings.
Vea también fgetss() fread(), fgetc(), stream_get_line(), fopen(), popen(), fsockopen(), y stream_set_timeout().