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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZipArchive::open</refname>
<refpurpose>Open a ZIP file archive</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ZipArchive">
<modifier>public</modifier> <type class="union"><type>bool</type><type>int</type></type><methodname>ZipArchive::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Opens a new or existing zip archive for reading, writing or modifying.
</para>
<para>
Since libzip 1.6.0, an empty file is not a valid archive any longer.
</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::OVERWRITE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::CREATE</constant>
</para>
</listitem>
<listitem>
<para>
<constant>ZipArchive::RDONLY</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>
Returns &true; on success, &false; or one of the following error codes on error:
<variablelist>
<varlistentry>
<term><constant>ZipArchive::ER_EXISTS</constant></term>
<listitem>
<simpara>File already exists.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_INCONS</constant></term>
<listitem>
<simpara>Zip archive inconsistent.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_INVAL</constant></term>
<listitem>
<simpara>Invalid argument.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_MEMORY</constant></term>
<listitem>
<simpara>Malloc failure.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_NOENT</constant></term>
<listitem>
<simpara>No such file.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_NOZIP</constant></term>
<listitem>
<simpara>Not a zip archive.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_OPEN</constant></term>
<listitem>
<simpara>Can't open file.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_READ</constant></term>
<listitem>
<simpara>Read error.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>ZipArchive::ER_SEEK</constant></term>
<listitem>
<simpara>Seek error.</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<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>
<example>
<title>Create an temporary archive</title>
<programlisting role="php">
<![CDATA[
<?php
$name = tempnam(sys_get_temp_dir(), "FOO");
$zip = new ZipArchive;
$res = $zip->open($name, ZipArchive::OVERWRITE); /* truncate as empty file is not valid */
if ($res === TRUE) {
$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:"~/.phpdoc/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
-->
|
