reference/zip/functions/zip-entry-read.xml
e7278889420140e0af5df90efe9f1cb63eb63842
...
...
@@ -6,12 +6,17 @@
6
6
<refname>zip_entry_read</refname>
7
7
<refpurpose>Read from an open directory entry</refpurpose>
8
8
</refnamediv>
9
+

10
+
<refsynopsisdiv>
11
+
&warn.deprecated.function-8-0-0;
12
+
</refsynopsisdiv>
13
+

9
14
<refsect1 role="description">
10
15
&reftitle.description;
11
16
<methodsynopsis>
12
-
<type>string</type><methodname>zip_entry_read</methodname>
17
+
<type class="union"><type>string</type><type>false</type></type><methodname>zip_entry_read</methodname>
13
18
<methodparam><type>resource</type><parameter>zip_entry</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1024</initializer></methodparam>
19
+
<methodparam choice="opt"><type>int</type><parameter>len</parameter><initializer>1024</initializer></methodparam>
15
20
</methodsynopsis>
16
21
<para>
17
22
Reads from an open directory entry.
...
...
@@ -30,7 +35,7 @@
30
35
</listitem>
31
36
</varlistentry>
32
37
<varlistentry>
33
-
<term><parameter>length</parameter></term>
38
+
<term><parameter>len</parameter></term>
34
39
<listitem>
35
40
<para>
36
41
The number of bytes to return.
...
...
@@ -51,6 +56,32 @@
51
56
Returns the data read, empty string on end of a file, or &false; on error.
52
57
</para>
53
58
</refsect1>
59
+

60
+
<refsect1 role="changelog">
61
+
&reftitle.changelog;
62
+
<para>
63
+
<informaltable>
64
+
<tgroup cols="2">
65
+
<thead>
66
+
<row>
67
+
<entry>&Version;</entry>
68
+
<entry>&Description;</entry>
69
+
</row>
70
+
</thead>
71
+
<tbody>
72
+
<row>
73
+
<entry>8.0.0</entry>
74
+
<entry>
75
+
This function is deprecated in favor of the Object API,
76
+
see <methodname>ZipArchive::getFromIndex</methodname>.
77
+
</entry>
78
+
</row>
79
+
</tbody>
80
+
</tgroup>
81
+
</informaltable>
82
+
</para>
83
+
</refsect1>
84
+

54
85
<refsect1 role="seealso">
55
86
&reftitle.seealso;
56
87
<para>
...
...
@@ -61,8 +92,8 @@
61
92
</simplelist>
62
93
</para>
63
94
</refsect1>
64
-
</refentry>
65
95

96
+
</refentry>
66
97
<!-- Keep this comment at the end of the file
67
98
Local variables:
68
99
mode: sgml
69
100