1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.ziparchive-open">
<refnamediv>
<refname>ZipArchive::open</refname>
<refpurpose>Open a ZIP file archive</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ZipArchive::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Opens a new zip archive for reading, writing or modifying.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The file name of the ZIP archive to open.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The mode to use to open the archive.
<itemizedlist>
<listitem>
<para>
<constant>ZIPARCHIVE::CREATE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::EXCL</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::CHECKCONS</constant>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<variablelist>
<varlistentry>
<term><parameter>Error codes</parameter></term>
<listitem>
<para>
Returns &true; on success or the error code.
<itemizedlist>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_EXISTS</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_INCONS</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_INVAL</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_MEMORY</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_NOENT</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_NOZIP</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_OPEN</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_READ</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZIPARCHIVE::ER_SEEK</constant>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
This example opens a ZIP file archive, reads each file in the
archive and prints out its contents. The
<filename>test2.zip</filename> archive used in this example is
one of the test archives in the ZZIPlib source distribution.
</para>
<example>
<title>Open and extract</title>
<programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip')
if ($res === TRUE) {
echo 'ok';
$zip->extractTo('test');
$zip->close();
} else {
echo 'failed, code:' . $res;
}
?>
]]>
</programlisting>
</example>
<example>
<title>Create an archive</title>
<programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive;
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
$zip->addFromString('test.txt', 'file content goes here');
$zip->addFile('data.txt', 'entryname.txt');
$zip->close();
echo 'ok';
} else {
echo 'failed';
}
?>
]]>
</programlisting>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
