It is important to know that stream_get_contents behaves differently with different versions of PHP. Consider the following
<?php
$handle = fopen('file', 'w+'); // truncate + attempt to create
fwrite($handle, '12345'); // file position > 0
rewind($handle); // position = 0
$content = stream_get_contents($handle); // file position = 0 in PHP 5.1.6, file position > 0 in PHP 5.2.17!
fwrite($handle, '6789');
fclose($handle);
/**
*
* 'file' content
*
* PHP 5.1.6:
* 67895
*
* PHP 5.2.17:
* 123456789
*
*/
?>
As a result, stream_get_contents() affects file position in 5.1, and do not affect file position in 5.2 or better.
stream_get_contents
(PHP 5, PHP 7, PHP 8)
stream_get_contents — Читает оставшуюся часть потока в строку
Описание
stream_get_contents(resource
$handle, int $maxlength = -1, int $offset = -1): string|false
Похожа на функцию file_get_contents(), за исключением того, что
stream_get_contents() работает с уже открытым
ресурсом потока и возвращает оставшуюся часть содержимого в строку размером до
maxlength байт и начиная с указанного смещения
offset.
Список параметров
-
handle(resource) -
Ресурс потока (например, полученный при помощи функции fopen())
-
maxlength(int) -
Максимальное количество байт для чтения. По умолчанию -1 (прочитать весь оставшийся буфер).
-
offset(int) -
Перейти к указанному смещению перед чтением. Если это число отрицательное, то переход не произойдёт и чтение начнётся с текущей позиции.
Возвращаемые значения
Возвращает строку или false в случае возникновения ошибки.
Примеры
Пример #1 Пример использования stream_get_contents()
<?php
if ($stream = fopen('http://www.example.com', 'r')) {
// вывести всю страницу начиная со смещения 10
echo stream_get_contents($stream, -1, 10);
fclose($stream);
}
if ($stream = fopen('http://www.example.net', 'r')) {
// вывести первые 5 байт
echo stream_get_contents($stream, 5);
fclose($stream);
}
?>
Примечания
Замечание: Эта функция безопасна для обработки данных в двоичной форме.
Смотрите также
- fgets() - Читает строку из файла
- fread() - Бинарно-безопасное чтение файла
- fpassthru() - Выводит все оставшиеся данные из файлового указателя
add a note
User Contributed Notes 5 notes
vasiliy at hotger dot com ¶
12 years ago
clarck dot smith at gmail dot com ¶
12 years ago
In that case when stream_get_contents/fread/fgets or other stream reading functions block indefinitely your script because they don't reached the limit of bytes to read use the socket_get_meta_data function to figure out the number of the bytes to read. It returns an array that contains a key named 'unread_bytes' and then pass that number to your favourite stream reading functions second parameter to read from the stream.
Maybe a good workaround to use the stream_select function, and set the socket to non-blocking mode with the use of stream_set_blocking($stream, 0). In this case the socket reading functions work properly.
Cheers, Ervin
m rahman ¶
13 years ago
When omitting the parameter $maxlength, any received bytes are stacked up until the underlying stream is not readable anymore, the the function returns that stack in one piece.
Mike Shiyan ¶
7 years ago
stream_get_contents() can be used instead of fread() even with local files.
divinity76+nospam at gmail dot com ¶
8 years ago
/*
* problem: stream_get_contents blocks / is very slow.
* I have tried
* 1: stream_set_blocking, doesn't make a difference.
* 2: stream_get_meta_data['unread_bytes'] = ITS BUGGED, ALWAYS SAYS 0.
* 3: feof(): ALSO EFFING BLOCKING
* 4: my_stream_get_contents hack... kinda working! :D
*/
function my_stream_get_contents ($handle, $timeout_seconds = 0.5)
{
$ret = "";
// feof ALSO BLOCKS:
// while(!feof($handle)){$ret.=stream_get_contents($handle,1);}
while (true) {
$starttime = microtime(true);
$new = stream_get_contents($handle, 1);
$endtime = microtime(true);
if (is_string($new) && strlen($new) >= 1) {
$ret .= $new;
}
$time_used = $endtime - $starttime;
// var_dump('time_used:',$time_used);
if (($time_used >= $timeout_seconds) || ! is_string($new) ||
(is_string($new) && strlen($new) < 1)) {
break;
}
}
return $ret;
}
