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 5 notes

down

vasiliy at hotger dot com ¶

11 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 ¶

11 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 ¶

12 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

-2

Mike Shiyan ¶

6 years ago


stream_get_contents() can be used instead of fread() even with local files.

down

-15

divinity76+nospam at gmail dot com ¶

7 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;
}

＋add a note