Função fgets() do PHP

Definição e uso

A função fgets() lê uma linha de um ponteiro de arquivo.

Sintaxe

fgets(file,length)
Parâmetros Descrição
file Obrigatório. Define o arquivo a ser lido.
length Opcional. Define o número de bytes a serem lidos. O padrão é 1024 bytes.

Descrição

de file Lê uma linha do arquivo apontado e retorna o comprimento máximo de length - uma string de -1 byte. Encontra-se o caractere de nova linha (inclusive no valor de retorno), EOF ou já foram lidos length - pára após -1 byte (dependendo do que encontrar primeiro). Se não for especificado length, o padrão é 1K, ou seja, 1024 bytes.

Se falhar, retorna false.

Dicas e comentários

Comentário:length O parâmetro tornou-se opcional a partir do PHP 4.2.0. Se ignorado, o comprimento da linha é假定 para 1024 bytes. A partir do PHP 4.3, a omissão length Continuará a ler dados do fluxo até o fim da linha. Se a maioria das linhas do arquivo for maior que 8 KB, especificar o comprimento máximo da linha no script é mais eficaz em termos de recursos.

Comentário:A partir do PHP 4.3, esta função pode ser usada de forma segura em arquivos binários. As versões anteriores não são recomendadas.

Comentário:Se o PHP não puder reconhecer o caractere de fim de linha do arquivo Macintosh ao ler o arquivo, você pode ativar a opção de configuração de tempo de execução auto_detect_line_endings.

Exemplo

Exemplo 1

<?php
$file = fopen("test.txt","r");
echo fgets($file);
fclose($file);
?>

Saída semelhante a:

Olá, este é um arquivo de teste.

Exemplo 2

<?php
$file = fopen("test.txt","r");
while(! feof($file))
  {
  echo fgets($file) . "<br />";
  }
fclose($file);
?>

Saída semelhante a:

Olá, este é um arquivo de teste. 
Há três linhas aqui. 
Esta é a última linha.