(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
file_get_contents — Lê todo o conteúdo de um arquivo para uma string
$filename,$use_include_path = false,$context = null,$offset = 0,$length = null
Esta função é semelhante à file(), exceto que
file_get_contents() retorna o arquivo em uma
string, começando a partir de offset
até length bytes. Em caso de falha,
file_get_contents() retornará false.
file_get_contents() é o método preferível para ler o conteúdo de um arquivo em uma string. Ela usa técnicas de mapeamento de memória suportadas pelo seu SO para melhorar a performance.
Nota:
Se você estiver abrindo uma URI com caracteres especiais, como espaços, você precisa codificar a URI com urlencode().
filenameNome do arquivo para ler.
use_include_pathNota:
A constante
FILE_USE_INCLUDE_PATHpode ser usada para acionar a busca no include path. Isto não é possível se a tipagem estrita estiver habilitada, já queFILE_USE_INCLUDE_PATHé um int. Em vez disso, usetrue.
context
Um recurso de contexto válido, criado com
stream_context_create(). Se você não precisa usar um
contexto personalizado, você pode ignorar este parâmetro passando null.
offsetO ponto onde a leitura deve começar na stream original. Offsets negativos contam a partir do final da stream.
offset não é suportado em arquivos remotos.
Tentar buscar (seek) em arquivos não locais pode funcionar com offsets
pequenos, mas isso é imprevisível pois só funciona na stream em buffer.
lengthComprimento máximo dos dados lidos. O padrão é ler até que o fim do arquivo seja alcançado. Note que este parâmetro é aplicado para a stream processada pelos filtros.
A função retorna os dados lidos ou false em caso de falha.
Esta função pode
retornar o booleano false, mas também pode retornar um valor não-booleano que pode ser
avaliado como false, como 0 ou
"". Leia a seção em Booleanos para maiores
informações. Utilize o operador ===
para testar o valor retornado por esta função.
Um erro de nível E_WARNING é gerado se filename não puder ser encontrado,
length é menor que zero, ou se a busca na stream pelo offset especificado falhar.
Quando file_get_contents() é chamada em um diretório, um
erro nível E_WARNING é gerado no Windows, e a partir
do PHP 7.4 em outros sistemas operacionais também.
| Versão | Descrição |
|---|---|
| 8.0.0 |
length agora é anulável.
|
| 7.1.0 |
Suporte para offsets negativos foi adicionado.
|
Exemplo #1 Obtém e exibe o código-fonte da página inicial de um website
<?php
$homepage = file_get_contents('http://www.example.com/');
echo $homepage;
?>
Exemplo #2 Buscando no include_path
<?php
// Se strict types estiver ativado com declare(strict_types=1);
$file = file_get_contents('./people.txt', true);
// Se não
$file = file_get_contents('./people.txt', FILE_USE_INCLUDE_PATH);
?>
Exemplo #3 Lendo uma sessão de um arquivo
<?php
// Le 14 letras começando da letra 21
$section = file_get_contents('./people.txt', FALSE, NULL, 20, 14);
var_dump($section);
?>
O exemplo acima irá imprimir algo similar à:
string(14) "lle Bjori Ro"
Exemplo #4 Usando stream contexts
<?php
// Criam um stream
$opts = array(
'http'=>array(
'method'=>"GET",
'header'=>"Accept-language: en\r\n" .
"Cookie: foo=bar\r\n"
)
);
$context = stream_context_create($opts);
// Abre o arquivo utilizando os headers HTTP craidos acima
$file = file_get_contents('http://www.example.com/', false, $context);
?>
Nota: Esta função é binary-safe.
Uma URL pode ser utilizada como um nome de arquivo se fopen wrappers estiver ativo. Veja fopen() para mais detalhes em como especificar o filename. Veja também the Protocolos e Wrappers suportados para informações sobre que capacidades cada wrapper tem, notas de uso e informações sobre variáveis predefinidas fornecidas.
Quando usando SSL, o Microsoft IIS
irá violar o protocolo fechando a conexão sem enviar uma notificação
close_notify. O PHP acusará isso como sendo "SSL: Fatal
Protocol Error" quando tentar ler os dados. Para prevenir isso, o valor de
error_reporting deve ser
reduzido para um nível que não inclui avisos.
para o nível que não emita warnings.
O PHP pode detectar servidores IIS defeituosos quando você abre
um stream utilizando o wrapper https:// e suprimirá os avisos.
Se você está usando fsockopen() para criar um socket
ssl://, a responsabilidade de detectar e suprimir esse aviso é do desenvolvedor.
file_get_contents can do a POST, create a context for that first:
<?php
$opts = array('http' =>
array(
'method' => 'POST',
'header' => "Content-Type: text/xml\r\n".
"Authorization: Basic ".base64_encode("$https_user:$https_password")."\r\n",
'content' => $body,
'timeout' => 60
)
);
$context = stream_context_create($opts);
$url = 'https://'.$https_server;
$result = file_get_contents($url, false, $context, -1, 40000);
?>
//从指定位置获取指定长度的文件内容
function file_start_length($path,$start=0,$length=null){
if(!file_exists($path)) return false;
$size=filesize($path);
if($start<0) $start+=$size;
if($length===null) $length=$size-$start;
return file_get_contents($path, false, null, $start, $length );
}
if the connection is
content-encoding: gzip
and you need to manually ungzip it, this is apparently the key
$c=gzinflate( substr($c,10,-8) );
(stolen from the net)
I'm not sure why @jlh was downvoted, but I verified what he reported.
>>> file_get_contents($path false, null, 5, null)
=> ""
>>> file_get_contents($path, false, null, 5, 5)
=> "r/bin"
