reference/stream/functions/stream-copy-to-stream.xml
6a5b227850bbad1ec81fd52b6a08e12e3f2c03ac
...
...
@@ -8,19 +8,19 @@
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>int</type><methodname>stream_copy_to_stream</methodname>
12
-
<methodparam><type>resource</type><parameter>source</parameter></methodparam>
13
-
<methodparam><type>resource</type><parameter>dest</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>maxlength</parameter><initializer>-1</initializer></methodparam>
11
+
<type class="union"><type>int</type><type>false</type></type><methodname>stream_copy_to_stream</methodname>
12
+
<methodparam><type>resource</type><parameter>from</parameter></methodparam>
13
+
<methodparam><type>resource</type><parameter>to</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
15
15
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Makes a copy of up to <parameter>maxlength</parameter> bytes
18
+
Makes a copy of up to <parameter>length</parameter> bytes
19
19
of data from the current position (or from the
20
20
<parameter>offset</parameter> position, if specified) in
21
-
<parameter>source</parameter> to <parameter>dest</parameter>. If
22
-
<parameter>maxlength</parameter> is not specified, all remaining content in
23
-
<parameter>source</parameter> will be copied.
21
+
<parameter>from</parameter> to <parameter>to</parameter>. If
22
+
<parameter>length</parameter> is &null;, all remaining content in
23
+
<parameter>from</parameter> will be copied.
24
24
</para>
25
25
</refsect1>
26
26

...
...
@@ -29,7 +29,7 @@
29
29
<para>
30
30
<variablelist>
31
31
<varlistentry>
32
-
<term><parameter>source</parameter></term>
32
+
<term><parameter>from</parameter></term>
33
33
<listitem>
34
34
<para>
35
35
The source stream
...
...
@@ -37,7 +37,7 @@
37
37
</listitem>
38
38
</varlistentry>
39
39
<varlistentry>
40
-
<term><parameter>dest</parameter></term>
40
+
<term><parameter>to</parameter></term>
41
41
<listitem>
42
42
<para>
43
43
The destination stream
...
...
@@ -45,10 +45,10 @@
45
45
</listitem>
46
46
</varlistentry>
47
47
<varlistentry>
48
-
<term><parameter>maxlength</parameter></term>
48
+
<term><parameter>length</parameter></term>
49
49
<listitem>
50
50
<para>
51
-
Maximum bytes to copy
51
+
Maximum bytes to copy. By default all bytes left are copied.
52
52
</para>
53
53
</listitem>
54
54
</varlistentry>
...
...
@@ -67,32 +67,30 @@
67
67
<refsect1 role="returnvalues">
68
68
&reftitle.returnvalues;
69
69
<para>
70
-
Returns the total count of bytes copied, &return.falseforfailure;.
70
+
Returns the total count of bytes copied,&return.falseforfailure;.
71
71
</para>
72
72
</refsect1>
73
73

74
74
<refsect1 role="changelog">
75
75
&reftitle.changelog;
76
-
<para>
77
-
<informaltable>
78
-
<tgroup cols="2">
79
-
<thead>
80
-
<row>
81
-
<entry>&Version;</entry>
82
-
<entry>&Description;</entry>
83
-
</row>
84
-
</thead>
85
-
<tbody>
86
-
<row>
87
-
<entry>5.1.0</entry>
88
-
<entry>
89
-
Added the <parameter>offset</parameter> parameter
90
-
</entry>
91
-
</row>
92
-
</tbody>
93
-
</tgroup>
94
-
</informaltable>
95
-
</para>
76
+
<informaltable>
77
+
<tgroup cols="2">
78
+
<thead>
79
+
<row>
80
+
<entry>&Version;</entry>
81
+
<entry>&Description;</entry>
82
+
</row>
83
+
</thead>
84
+
<tbody>
85
+
<row>
86
+
<entry>8.0.0</entry>
87
+
<entry>
88
+
<parameter>length</parameter> is now nullable.
89
+
</entry>
90
+
</row>
91
+
</tbody>
92
+
</tgroup>
93
+
</informaltable>
96
94
</refsect1>
97
95

98
96
<refsect1 role="examples">
...
...
@@ -126,7 +124,6 @@ echo stream_copy_to_stream($src, $dest2) . " bytes copied to remainder.txt\n";
126
124
</para>
127
125
</refsect1>
128
126
</refentry>
129
-

130
127
<!-- Keep this comment at the end of the file
131
128
Local variables:
132
129
mode: sgml
133
130