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 — Lit tout un flux dans une chaîne
Description
stream_get_contents(resource
$handle, int $maxlength = -1, int $offset = -1): string|false
stream_get_contents() est identique à
file_get_contents(), sauf qu'elle opère sur
un pointeur de fichier déjà ouvert et retourne le contenu restant, allant jusqu'à
maxlength octets, dans une chaîne et commençant à la position
offset.
Liste de paramètres
-
handle(resource) -
Une ressource de flux (e.g. retournée par la fonction fopen())
-
maxlength(entier) -
Le nombre maximal d'octets à lire. Par défaut, -1 (lit tout le contenu restant du buffer).
-
offset(entier) -
Se déplace à la position spécifiée avant la lecture. Si le nombre passé est négatif, aucun déplacement ne sera effectué et la lecture commencera de la position courante.
Valeurs de retour
Retourne une chaîne de caractères ou false si une erreur survient.
Exemples
Exemple #1 Exemple avec stream_get_contents()
<?php
if ($stream = fopen('http://www.example.com', 'r')) {
// affiche toute la page, en commençant à la position 10
echo stream_get_contents($stream, -1, 10);
fclose($stream);
}
if ($stream = fopen('http://www.exemple.net', 'r')) {
// Affichage des 5 premiers octets
echo stream_get_contents($stream, 5);
fclose($stream);
}
?>
Notes
Note: Cette fonction gère les chaînes binaires.
Voir aussi
- fgets() - Récupère la ligne courante à partir de l'emplacement du pointeur sur fichier
- fread() - Lecture du fichier en mode binaire
- fpassthru() - Affiche le reste du fichier
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;
}
