Resumo : neste tutorial, você aprenderá como usar a file_get_contents()
função PHP para ler o arquivo inteiro em uma string.
Introdução à função PHP file_get_contents()
A file_get_contents()
função lê o arquivo inteiro em uma string. Aqui está a sintaxe da file_get_contents()
função:
file_get_contents (
string $filename ,
bool $use_include_path = false ,
resource $context = ? ,
int $offset = 0 ,
int $maxlen = ?
) : string|false
Linguagem de código: PHP ( php )
A file_get_contents(
função ) possui os seguintes parâmetros:
$filename
é o nome do arquivo a ser lido.$use_include_path
se você definir como verdadeiro, a função também procurará o arquivo no caminho de inclusão.$context
especifica um recurso de contexto válido ou nulo se não usar um contexto personalizado.$offset
é o deslocamento onde a função começa a ler no fluxo original. Se for negativo, o deslocamento conta a partir do final do fluxo.$maxlen
especifica o comprimento máximo de dados a serem lidos. Por padrão, a função lê os dados até o final do arquivo.
O file_get_contents()
retorna o conteúdo do arquivo em caso de sucesso ou false
falha.
Exemplos de funções PHP file_get_contents()
Vejamos alguns exemplos de uso da file_get_contents()
função.
1) Usando a função file_get_contents() para baixar um exemplo de página da web
O exemplo a seguir mostra como usar a file_get_contents()
função para baixar uma página inteira em uma string:
<?php
$html = file_get_contents('https://www.php.net/');
echo $html;
Linguagem de código: HTML, XML ( xml )
2) Usando a função file_get_contents() para ler um arquivo inteiro em um exemplo de string
O exemplo a seguir usa the file_get_contents()
para ler os dados de the readme.txt
em uma string:
<?php
$filename = 'readme1.txt';
if (!is_readable($filename)) {
die('File does not exist or is not readable');
}
echo file_get_contents($filename);
Linguagem de código: HTML, XML ( xml )
Como funciona.
- Primeiro, lance uma exceção se o arquivo existir ou for legível usando a
is_readable()
função. - Segundo, leia o arquivo inteiro em uma string e mostre seu conteúdo.
3) Usando a função file_get_contents() para ler uma parte de um arquivo em uma string
O exemplo a seguir usa a file_get_contents()
função para ler 20 caracteres começando no 5º caractere do readme.txt
arquivo:
<?php
$filename = 'readme.txt';
if (!is_readable($filename)) {
die('File does not exist or is not readable');
}
echo file_get_contents($filename, null, null, 10, 20);
Linguagem de código: HTML, XML ( xml )
No PHP 8, você pode usar os argumentos name ao chamar a file_get_contents()
função da seguinte forma:
$content = file_get_contents(
$filename = $filename,
$offset = 5,
$maxlen = 20
);
Linguagem de código: PHP ( php )
Resumo
- Use a função PHP
file_get_contents()
para ler um arquivo em uma string.