Php get all file contents

file_get_contents

Данная функция похожа на функцию file() с той только разницей, что file_get_contents() возвращает содержимое файла в строке, начиная с указанного смещения offset и до maxlen байт. В случае неудачи, file_get_contents() вернёт FALSE .

Использование функции file_get_contents() наиболее предпочтительно в случае необходимости получить содержимое файла целиком, поскольку для улучшения производительности функция использует технику отображения файла в память (memory mapping), если она поддерживается вашей операционной системой.

Замечание:

Если вы открываете URI содержащий спецсимволы, такие как пробел, вам нужно закодировать URI при помощи urlencode() .

Список параметров

Замечание:

Начиная с версии PHP 5 можно использовать константу FILE_USE_INCLUDE_PATH для поиска файла в include path.

Корректный ресурс контекста, созданный с помощью функции stream_context_create() . Если в использовании особого контекста нет необходимости, можно пропустить этот параметр передав в него значение NULL .

Смещение, с которого начнется чтение оригинального потока.

Поиск смещения ( offset ) не поддерживается при работе с удаленными файлами. Попытка поиска смещения на нелокальных файлах может работать при небольших смещениях, но этот результат является непредсказуемым, так как он работает на буферизованном потоке.

Максимальный размер читаемых данных. По умолчанию чтение осуществляется пока не будет достигнут конец файла. Учтите, что этот параметр применяется и к потоку с фильтрами.

Возвращаемые значения

Функция возвращает прочтенные данные или FALSE в случае возникновения ошибки.

Эта функция может возвращать как boolean FALSE , так и не-boolean значение, которое приводится к FALSE . За более подробной информацией обратитесь к разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой функцией.

Ошибки

Будет сгенерирована ошибка уровня E_WARNING , если параметр filename не удается найти, параметр maxlength меньше нуля или поиск по смещению offset в потоке завершается неудачно.

Примеры

Пример #1 Получить и вывести исходный код домашней страницы вебсайта

Пример #2 Поиск файлов в include_path

// $file = file_get_contents ( ‘./people.txt’ , true );
// > PHP 5
$file = file_get_contents ( ‘./people.txt’ , FILE_USE_INCLUDE_PATH );
?>

Пример #3 Чтение секции файла

// Читаем 14 символов, начиная с 21 символа
$section = file_get_contents ( ‘./people.txt’ , NULL , NULL , 20 , 14 );
var_dump ( $section );
?>

Результатом выполнения данного примера будет что-то подобное:

Пример #4 Использование потоковых контекстов

// Создаем поток
$opts = array(
‘http’ =>array(
‘method’ => «GET» ,
‘header’ => «Accept-language: en\r\n» .
«Cookie: foo=bar\r\n»
)
);

$context = stream_context_create ( $opts );

// Открываем файл с помощью установленных выше HTTP-заголовков
$file = file_get_contents ( ‘http://www.example.com/’ , false , $context );
?>

Список изменений

Версия	Описание
5.1.0	Добавлены аргументы offset и maxlen .

Примечания

Замечание: Эта функция безопасна для обработки данных в двоичной форме.

Для этой функции вы можете использовать URL в качестве имени файла, если была включена опция fopen wrappers. Смотрите более подробную информацию об определении имени файла в описании функции fopen() . Смотрите также список поддерживаемых оберток URL, их возможности, замечания по использованию и список предопределенных констант в Поддерживаемые протоколы и обработчики (wrappers).

При использовании SSL, Microsoft IIS нарушает протокол, закрывая соединение без отправки индикатора close_notify. PHP сообщит об этом как «SSL: Fatal Protocol Error» в тот момент, когда вы достигнете конца данных. Чтобы обойти это, вы должны установить error_reporting на уровень, исключающий E_WARNING. PHP версий 4.3.7 и старше умеет определять, что на стороне сервера находится проблемный IIS при открытии потока с помощью обертки https:// и не выводит предупреждение. Если вы используете fsockopen() для создания ssl:// сокета, вы сами отвечаете за определение и подавление этого предупреждения.

Смотрите также

• file() — Читает содержимое файла и помещает его в массив
• fgets() — Читает строку из файла
• fread() — Бинарно-безопасное чтение файла
• readfile() — Выводит файл
• file_put_contents() — Пишет строку в файл
• stream_get_contents() — Читает оставшуюся часть потока в строку
• stream_context_create() — Создаёт контекст потока
• $http_response_header

Источник

PHP file_get_contents

Summary: in this tutorial, you will learn how to use the PHP file_get_contents() function to read the entire file into a string.

Introduction to the PHP file_get_contents() function

The file_get_contents() function reads the entire file into a string. Here’s the syntax of the file_get_contents() function:

file_get_contents ( string $filename , bool $use_include_path = false , resource $context = ? , int $offset = 0 , int $maxlen = ? ) : string|falseCode language: PHP (php)

The file_get_contents( ) function has the following parameters:

• $filename is the name of the file to read.
• $use_include_path if you set it to true, the function will also search for the file in the include path.
• $context specifies a valid context resource or null if don’t use a custom context.
• $offset is the offset where the function starts reading on the original stream. If it is negative, the offset counts from the end of the stream.
• $maxlen specifies the maximum length of data to read. By default, the function reads data till the end of the file.

The file_get_contents() returns the file contents on success or false on failure.

PHP file_get_contents() function examples

Let’s take some examples of using the file_get_contents() function.

1) Using the file_get_contents() function to download a webpage example

The following example shows how to use the file_get_contents() function to download an entire webpage into a string:

 $html = file_get_contents('https://www.php.net/'); echo $html;Code language: HTML, XML (xml)

2) Using the file_get_contents() function to read an entire file into a string example

The following example uses the file_get_contents() to read the data from the readme.txt into a string:

 $filename = 'readme1.txt'; if (!is_readable($filename)) < die('File does not exist or is not readable'); > echo file_get_contents($filename);Code language: HTML, XML (xml)

• First, throw an exception if the file exists or readable using the is_readable() function.
• Second, read the entire file into a string and show its contents.

3) Using the file_get_contents() function to read a part of a file into a string

The following example uses the file_get_contents() function to read 20 characters starting from the 5th character in the readme.txt file:

 $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);Code language: HTML, XML (xml)

In PHP 8, you can use the name arguments when calling the file_get_contents() function as follows:

$content = file_get_contents( $filename = $filename, $offset = 5, $maxlen = 20 );Code language: PHP (php)

Summary

Источник

file_get_contents

This function is similar to file() , except that file_get_contents() returns the file in a string , starting at the specified offset up to length bytes. On failure, file_get_contents() will return false .

file_get_contents() is the preferred way to read the contents of a file into a string. It will use memory mapping techniques if supported by your OS to enhance performance.

Note:

If you’re opening a URI with special characters, such as spaces, you need to encode the URI with urlencode() .

Parameters

Note:

The FILE_USE_INCLUDE_PATH constant can be used to trigger include path search. This is not possible if strict typing is enabled, since FILE_USE_INCLUDE_PATH is an int . Use true instead.

A valid context resource created with stream_context_create() . If you don’t need to use a custom context, you can skip this parameter by null .

The offset where the reading starts on the original stream. Negative offsets count from the end of the stream.

Seeking ( offset ) is not supported with remote files. Attempting to seek on non-local files may work with small offsets, but this is unpredictable because it works on the buffered stream.

Maximum length of data read. The default is to read until end of file is reached. Note that this parameter is applied to the stream processed by the filters.

Return Values

The function returns the read data or false on failure.

This function may return Boolean false , but may also return a non-Boolean value which evaluates to false . Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.

Errors/Exceptions

An E_WARNING level error is generated if filename cannot be found, length is less than zero, or if seeking to the specified offset in the stream fails.

When file_get_contents() is called on a directory, an E_WARNING level error is generated on Windows, and as of PHP 7.4 on other operating systems as well.

Changelog

Version	Description
8.0.0	length is nullable now.
7.1.0	Support for negative offset s has been added.

Examples

Example #1 Get and output the source of the homepage of a website

Example #2 Searching within the include_path

// If strict types are enabled i.e. declare(strict_types=1);
$file = file_get_contents ( ‘./people.txt’ , true );
// Otherwise
$file = file_get_contents ( ‘./people.txt’ , FILE_USE_INCLUDE_PATH );
?>

Example #3 Reading a section of a file

// Read 14 characters starting from the 21st character
$section = file_get_contents ( ‘./people.txt’ , FALSE , NULL , 20 , 14 );
var_dump ( $section );
?>

The above example will output something similar to:

Example #4 Using stream contexts

// Create a stream
$opts = array(
‘http’ =>array(
‘method’ => «GET» ,
‘header’ => «Accept-language: en\r\n» .
«Cookie: foo=bar\r\n»
)
);

$context = stream_context_create ( $opts );

// Open the file using the HTTP headers set above
$file = file_get_contents ( ‘http://www.example.com/’ , false , $context );
?>

Notes

Note: This function is binary-safe.

A URL can be used as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename. See the Supported Protocols and Wrappers for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.

When using SSL, Microsoft IIS will violate the protocol by closing the connection without sending a close_notify indicator. PHP will report this as «SSL: Fatal Protocol Error» when you reach the end of the data. To work around this, the value of error_reporting should be lowered to a level that does not include warnings. PHP can detect buggy IIS server software when you open the stream using the https:// wrapper and will suppress the warning. When using fsockopen() to create an ssl:// socket, the developer is responsible for detecting and suppressing this warning.

See Also

• file() — Reads entire file into an array
• fgets() — Gets line from file pointer
• fread() — Binary-safe file read
• readfile() — Outputs a file
• file_put_contents() — Write data to a file
• stream_get_contents() — Reads remainder of a stream into a string
• stream_context_create() — Creates a stream context
• $http_response_header

User Contributed Notes 6 notes

file_get_contents can do a POST, create a context for that first:

$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 );

Note that if an HTTP request fails but still has a response body, the result is still false, Not the response body which may have more details on why the request failed.

There’s barely a mention on this page but the $http_response_header will be populated with the HTTP headers if your file was a link. For example if you’re expecting an image you can do this:

$mimetype = null ;
foreach ( $http_response_header as $v ) if ( preg_match ( ‘/^content\-type:\s*(image\/[^;\s\n\r]+)/i’ , $v , $m )) $mimetype = $m [ 1 ];
>
>

if (! $mimetype ) // not an image
>

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)

//从指定位置获取指定长度的文件内容
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 );
>

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»

Источник