stream_copy_to_stream

(PHP 5, PHP 7, PHP 8)

stream_copy_to_stream — Copie des données depuis un flux vers un autre

Description

function stream_copy_to_stream(
    resource $from,
    resource $to,
    ?int $length = null,
    int $offset = 0
): int|false

Fait une copie jusqu'à length octets de données depuis from vers to, en partant de la position courante dans from, ou de offset s'il est supérieur à 0. Si length vaut null, tout le reste du contenu de from sera copié.

Liste de paramètres

from: Le flux de source
to: Le flux de destination
length: Nombre maximal d'octets à copier. Par défaut, tous les octets restants sont copiés.
offset: Si supérieur à 0, position dans from, comptée depuis le début du flux, à partir de laquelle démarrer la copie : from est d'abord déplacé à cette position, comme avec fseek() et SEEK_SET. Si 0 (la valeur par défaut) ou négatif, aucun déplacement n'est effectué et la copie démarre à la position courante dans from.

Valeurs de retour

Retourne le nombre total d'octets copiés, ou false si une erreur survient.

Historique

Version	Description
8.0.0	`length` est désormais nullable.

Exemples

Exemple #1 Exemple avec stream_copy_to_stream()

<?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) . " octets copiés vers first1k.txt\n";
echo stream_copy_to_stream($src, $dest2) . " octets copiés vers remainder.txt\n";

?>

Notes

Note:
Lorsque from est un flux de socket en mode bloquant, la copie s'arrête dès qu'aucune donnée n'est reçue dans le délai d'expiration du flux, même si la fin du flux n'a pas été atteinte. false peut alors être retourné, alors que les données lues jusque-là ont déjà été écrites dans to. Ce délai d'expiration vaut par défaut default_socket_timeout et peut être modifié avec stream_set_timeout().

Voir aussi

copy() - Copie un fichier

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

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)

down

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.

down

anon at example dot com ¶

10 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().

＋add a note