PHP 5.5.16 is released

stream_get_contents

(PHP 5)

stream_get_contentsLit tout un flux dans une chaîne

Description

string stream_get_contents ( resource $handle [, int $maxlength = -1 [, int $offset = -1 ]] )

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.

Historique

Version Description
5.1.0 Le paramètre offset a été ajouté.

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, -110);

    
fclose($stream);
}


if (
$stream fopen('http://www.exemple.net''r')) {
    
// Affichage des 5 premiers octets
    
echo stream_get_contents($stream5);

    
fclose($stream);
}

?>

Notes

Note: Cette fonction gère les chaînes binaires.

Voir aussi

  • fgets() - Récupère la ligne courante sur laquelle se trouve le pointeur du fichier
  • fread() - Lecture du fichier en mode binaire
  • fpassthru() - Affiche le reste du fichier

add a note add a note

User Contributed Notes 5 notes

up
1
vasiliy at hotger dot com
2 years ago
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.
up
0
clarck dot smith at gmail dot com
2 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
up
0
m rahman
3 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.
up
0
finalmau at gmail dot com
6 years ago
some times this functions cause an max execution time time error, Why?

Simple, if you use it the function wait for have the specified byte  length into the resource or the end of file, but, several times this not happend, so we need implement an artificial flag like this:

$tmp = stream_get_contents($this->socket, 42);
while($tmp[42] != 'N'){

//Your code...

$tmp = stream_get_contents($this->socket, 42);
}
up
-2
Anonymous
3 years ago
It seems that using fiddler as a proxy in the stream context options causes this function to throw a warning:

Warning: stream_get_contents() [function.stream-get-contents]: SSL: An existing connection was forcibly closed by the remote host.
To Top