◐ Shell
clean mode source ↗

PHP: stream_copy_to_stream - Manual

(PHP 5, PHP 7, PHP 8)

stream_copy_to_streamCopies data from one stream to another

Description

Parameters

from

The source stream

to

The destination stream

length

Maximum bytes to copy. By default all bytes left are copied.

offset

The offset where to start to copy data

Return Values

Returns the total count of bytes copied, or false on failure.

Changelog

Version Description
8.0.0 length is now nullable.

Examples

Example #1 A stream_copy_to_stream() example

<?php
$src = fopen('http://www.example.com', 'r');
$dest1 = fopen('first1k.txt', 'w');
$dest2 = fopen('remainder.txt', 'w');

echo stream_copy_to_stream($src, $dest1, 1024) . " bytes copied to first1k.txt\n";
echo stream_copy_to_stream($src, $dest2) . " bytes copied to remainder.txt\n";

?>

Found A Problem?

divinity76 at gmail dot com

7 years ago

note that this function does not actually use sendfile() on linux systems (at least not in PHP 7.2.12)

none at noone dot com

19 years ago

stream_copy_to_stream almost copies a stream...

$objInputStream = fopen("php://input", "rb");
$objTempStream = fopen("php://temp", "w+b");
stream_copy_to_stream($objInputStream, $objTempStream);

That code will copy a stream but it will also move the stream pointers to EOF.  This is fine if you plan on rewinding the temp stream but good luck rewinding the input stream.

rewind($objTempStream);
rewind($objInputStream);

So as you can see this is stream copy or stream move depending on what kind of stream you are working with, and because there are no peaking functions your effed if you need to read from an input stream in multiple classes that are unrelated.

anon at example dot com

7 months ago

Passing 0 as $offset does not rewind the stream. Any offset that's zero or less is just ignored. It's a bit inconsistent with stream_get_contents().