fgets
(PHP 4, PHP 5)
fgets — Lê uma linha de um ponteiro de arquivo
Descrição
Retorna uma linha do ponteiro do arquivo.
Parâmetros
- handle
-
O ponteiro do arquivo tem de ser válido por uma chamada a fopen() ou fsockopen() (e ainda não fechado por fclose()).
- length
-
A leitura termina quando length - 1 bytes tenham sido lidos, em uma quebra de linha (que é incluÃda no retorno), ou no final do arquivo (EOF), o que acontecer primeiro. Se nenhum comprimento for especificado, a leitura do stream continuará até chegar ao final da linha.
Nota: Até o PHP 4.3.0, era assumido 1024 como o comprimento da linha, quando omitido. Se a maioria das linhas no arquivo for maior que 8KB, é mais eficiente para seu script especificar o comprimento máximo de linha.
Valor Retornado
Retorna uma string de até length - 1 bytes lida do arquivo apontado por handle .
Se um erro ocorrer, retorna FALSE.
Histórico
| Versão | Descrição |
|---|---|
| 4.3.0 | fgets() passou a ser segura para binários |
| 4.2.0 | O parâmetro length tornou-se opcional |
Exemplos
Example#1 Lendo um arquivo linha por linha
<?php
$handle = @fopen("/tmp/arquivodeentrada.txt", "r");
if ($handle) {
while (!feof($handle)) {
$buffer = fgets($handle, 4096);
echo $buffer;
}
fclose($handle);
}
?>
Notas
Nota: Se você está tendo problemas com o PHP no reconhecimento do final de linha quando criando ou lendo arquivos num computador Macintosh, você pode habilitar a opção auto_detect_line_endings.
Nota: Pessoas acostumadas à semântica do fgets em 'C' devem notar a diferença em como o fim do arquivo (EOF) é retornado.