PHP 8.4.2 Released!

fgets

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

fgetsLê uma linha de um ponteiro de arquivo

Descrição

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

Retorna uma linha do ponteiro do arquivo.

Parâmetros

stream

O ponteiro de arquivo deve ser válido e deve apontar para um arquivo aberto com sucesso por fopen() ou fsockopen() (e ainda não fechado por fclose()).

length

A leitura termina quando length - 1 bytes tenham sido lidos, ou 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 fluxo continuará até chegar ao final da linha.

Valor Retornado

Retorna uma string de até length - 1 bytes lida do arquivo apontado por stream. Se não tiver mais dados para ler no ponteiro do arquivo, então retorna false.

Se um erro ocorrer, é retornado false.

Exemplos

Exemplo #1 Lendo um arquivo linha por linha

<?php

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

if (
$fp) {
while ((
$buffer = fgets($fp, 4096)) !== false) {
echo
$buffer, PHP_EOL;
}

if (!
feof($fp)) {
echo
"Erro: falha inexperada de fgets()\n";
}

fclose($fp);
}

?>

Notas

Nota: Se o PHP não estiver reconhecendo corretamente os finais de linha ao ler arquivos em um computador Macintosh ou que foram criados em um, habilitar a opção de configuração em tempo de execução auto_detect_line_endings pode ajudar a resolver o problema.

Nota:

Pessoas acostumadas à semântica do fgets() em 'C' devem notar a diferença em como o fim do arquivo (EOF) é retornado.

Veja Também

  • fgetss() - Ler uma linha de um ponteiro de arquivo e retira as tags HTML
  • fread() - Leitura de arquivo segura para binário
  • fgetc() - Lê um caractere do ponteiro de arquivo
  • stream_get_line() - Obtém uma linha do recurso do fluxo até um delimitador informado
  • fopen() - Abre um arquivo ou URL
  • popen() - Abre um processo como ponteiro de arquivo
  • fsockopen() - Abre uma conexão socket de domínio Unix ou de Internet
  • stream_set_timeout() - Define o limite de tempo em um fluxo

adicione uma nota

Notas Enviadas por Usuários (em inglês) 5 notes

up
20
Leigh Purdie
9 years ago
A better example, to illustrate the differences in speed for large files, between fgets and stream_get_line.

This example simulates situations where you are reading potentially very long lines, of an uncertain length (but with a maximum buffer size), from an input source.

As Dade pointed out, the previous example I provided was much to easy to pick apart, and did not adequately highlight the issue I was trying to address.

Note that specifying a definitive end-character for fgets (ie: newline), generally decreases the speed difference reasonably significantly.

#!/usr/bin/php
<?php
$plaintext
=file_get_contents('http://loripsum.net/api/60/verylong/plaintext'); # Should be around 90k characters
$plaintext=str_replace("\n"," ",$plaintext); # Get rid of newlines

$fp=fopen("/tmp/SourceFile.txt","w");
for(
$i=0;$i<100000;$i++) {
fputs($fp,substr($plaintext,0,rand(4096,65534)) . "\n");
}
fclose($fp);

$fp=fopen("/tmp/SourceFile.txt","r");
$start=microtime(true);
while(
$line=fgets($fp,65535)) {
1;
}
$end=microtime(true);
fclose($fp);
$delta1=($end - $start);

$fp=fopen("/tmp/SourceFile.txt","r");
$start=microtime(true);
while(
$line=stream_get_line($fp,65535)) {
1;
}
$end=microtime(true);
fclose($fp);
$delta2=($end - $start);

$pdiff=$delta1/$delta2;
print
"stream_get_line is " . ($pdiff>1?"faster":"slower") . " than fgets - pdiff is $pdiff\n";
?>

$ ./testcase.php
stream_get_line is faster than fgets - pdiff is 1.760398041785

Note that, in a vast majority of situations in which php is employed, tiny differences in speed between system calls are of negligible importance.
up
3
Anonymous
4 years ago
if you for some reason need to get lines from a string instead of a file pointer, try

<?php
function string_gets(string $source, int $offset = 0, string $delimiter = "\n"): ?string
{
$len = strlen($source);
if (
$len < $offset) {
// out of bounds.. maybe i should throw an exception
return null;
}
if (
$len === $offset) {
// end of string..
return null;
}
$delimiter_pos = strpos($source, $delimiter, $offset);
if (
$delimiter_pos === false) {
// last line.
return substr($source, $offset);
}
return
substr($source, $offset, ($delimiter_pos - $offset) + strlen($delimiter));
}

?>

(i had a ~16GB string in-memory i needed to process line-by-line, but i would get memory-allocation-crash (on a 32GB ram system) if i tried explode("\n",$str); , so came up with this.. interestingly, fgets() seems to be faster than doing it in-ram-in-php, though. php 7.3.7)
up
4
David at Weintraub.name
17 years ago
There's an error in the documentation:

The file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()).

You should also add "popen" and "pclose" to the documentation. I'm a new PHP developer and went to verify that I could use "fgets" on commands that I used with "popen".
up
2
Peter Schlaile
17 years ago
fscanf($file, "%s\n") isn't really a good substitution for fgets(), since it will stop parsing at the first whitespace and not at the end of line!

(See the fscanf page for details on this)
up
1
tavernadelleidee[italy]
18 years ago
I think that the quickest way of read a (long) file with the rows in reverse order is

<?php
$myfile
= 'myfile.txt';
$command = "tac $myfile > /tmp/myfilereversed.txt";
passthru($command);
$ic = 0;
$ic_max = 100; // stops after this number of rows
$handle = fopen("/tmp/myfilereversed.txt", "r");
while (!
feof($handle) && ++$ic<=$ic_max) {
$buffer = fgets($handle, 4096);
echo
$buffer."<br>";
}
fclose($handle);
?>

It echos the rows while it is reading the file so it is good for long files like logs.

Borgonovo
To Top