stream_get_contents

(PHP 5, PHP 7, PHP 8)

stream_get_contents — Akımdan kalanı bir dizgeye okur

Açıklama

stream_get_contents(resource $akım, ?int $uzunluk = null, int $konum = -1): string|false

Evvelce açılmış bir akımla çalışması ve belirtilen akım'da kalan içeriğin konum'dan itibaren uzunluk bayta kadar kısmını döndürmesi dışında file_get_contents() işlevi gibidir.

Bağımsız Değişkenler

akım (resource): fopen() gibi bir işlevden döndürülmüş bir akım özkaynağı.
uzunluk (int): Okunacak azami bayt sayısı. Öntanımlı değer null olup tamponda kalan tüm baytların okunacağı anlamına gelir.
konum: Okuma işlemine başlamadan önce gösterici buraya konumlanır. Bu sayı negatif ise konumlama yapılmaz ve okuma işlemi geçerli konumdan başlar.

Dönen Değerler

Bir dizge, başarısızlık durumunda false döner.

Sürüm Bilgisi

Sürüm:	Açıklama
8.0.0	`uzunluk` artık `null` olabiliyor.

Örnekler

Örnek 1 - stream_get_contents() örneği

<?php

if ($stream = fopen('http://www.example.com', 'r')) {
    // 10. bayttan itibaren tüm sayfayı basalım
    echo stream_get_contents($stream, -1, 10);

    fclose($stream);
}


if ($stream = fopen('http://www.example.net', 'r')) {
    // İlk 5 baytı basalım
    echo stream_get_contents($stream, 5);

    fclose($stream);
}

?>

Notlar

Bilginize: Bu işlev ikil dosyalarla çalışırken dosya içeriğini değiştirmez.

Bilginize:
null dışında bir uzunluk değeri belirtirken, gerçek içerik önemli ölçüde daha kısa olsa bile bu işlev hemen o boyutta dahili bir tampon ayırır.

Ayrıca Bakınız

fgets() - Dosya tanıtıcısından bir satır döndürür
fread() - Dosyayı ikil kipte okur
fpassthru() - Bir dosya tanıtıcısında kalan verinin tamamını çıktılar

add a note

User Contributed Notes 4 notes

down

vasiliy at hotger dot com ¶

12 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.

down

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

down

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.

down

-1

fearpro13 at gmail dot com ¶

11 months ago


It states that $length parameter which value is null is intended to read all remaining contents from $stream
However, example listed under docs uses -1 as $length parameter to achieve such behavior

Recently i had to start few commands from php7.4 and read content from them, proc_open was used to create processes.
Both output[1] and error[2] pipes were set to non-blocking mode. For some unknown reason sometimes process error[2] channel was available, sometimes not(it was empty string).

After some investigation it was found that stream_get_contents works just great with -1 as a $length value instead of null if you are trying to get all remaining buffer.

add a note