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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ziparchive.addglob" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ZipArchive::addGlob</refname>
<refpurpose>Add files from a directory by glob pattern</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="ZipArchive">
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>ZipArchive::addGlob</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
</methodsynopsis>
<para>
Add files from a directory which match the glob <parameter>pattern</parameter>.
</para>
&zip.filename.separator;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
A <function>glob</function> pattern against which files will be matched.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
A bit mask of <literal>glob()</literal> flags.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
An associative array of options. Available options are:
<itemizedlist>
<listitem>
<para>
<literal>"add_path"</literal>
</para>
<para>
Prefix to prepend when translating to the local path of the file within
the archive. This is applied after any remove operations defined by the
<literal>"remove_path"</literal> or <literal>"remove_all_path"</literal>
options.
</para>
</listitem>
<listitem>
<para>
<literal>"remove_path"</literal>
</para>
<para>
Prefix to remove from matching file paths before adding to the archive.
</para>
</listitem>
<listitem>
<para>
<literal>"remove_all_path"</literal>
</para>
<para>
&true; to use the file name only and add to the root of the archive.
</para>
</listitem>
<listitem>
<para>
<literal>"flags"</literal>
</para>
<para>
Bitmask consisting of
<constant>ZipArchive::FL_OVERWRITE</constant>,
<constant>ZipArchive::FL_ENC_GUESS</constant>,
<constant>ZipArchive::FL_ENC_UTF_8</constant>,
<constant>ZipArchive::FL_ENC_CP437</constant>,
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant>.
The behaviour of these constants is described on the
<link linkend="zip.constants">ZIP constants</link> page.
</para>
</listitem>
<listitem>
<para>
<literal>"comp_method"</literal>
</para>
<para>
Compression method, one of the <constant>ZipArchive::CM_<replaceable>*</replaceable></constant>
constants.
</para>
</listitem>
<listitem>
<para>
<literal>"comp_flags"</literal>
</para>
<para>
Compression level.
</para>
</listitem>
<listitem>
<para>
<literal>"enc_method"</literal>
</para>
<para>
Encryption method, one of the <constant>ZipArchive::EM_<replaceable>*</replaceable></constant>
constants.
</para>
</listitem>
<listitem>
<para>
<literal>"enc_password"</literal>
</para>
<para>
Password used for encryption.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <type>array</type> of added files on success &return.falseforfailure;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0, PECL zip 1.18.0</entry>
<entry>
<literal>"flags"</literal> in <parameter>options</parameter> was added.
</entry>
</row>
<row>
<entry>8.0.0, PECL zip 1.18.1</entry>
<entry>
<literal>"comp_method"</literal>, <literal>"comp_flags"</literal>,
<literal>"enc_method"</literal> and <literal>"enc_password"</literal> in
<parameter>options</parameter> were added.
</entry>
</row>
<row>
<entry>8.3.0, PECL zip 1.22.1</entry>
<entry>
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant> was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="ziparchive.addglob.example.basic">
<title><methodname>ZipArchive::addGlob</methodname> example</title>
<para>
Add all php scripts and text files from current working directory
</para>
<programlisting role="php">
<![CDATA[
<?php
$zip = new ZipArchive();
$ret = $zip->open('application.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE);
if ($ret !== TRUE) {
printf('Failed with code %d', $ret);
} else {
$options = array('add_path' => 'sources/', 'remove_all_path' => TRUE);
$zip->addGlob('*.{php,txt}', GLOB_BRACE, $options);
$zip->close();
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ZipArchive::addFile</methodname></member>
<member><methodname>ZipArchive::addPattern</methodname></member>
</simplelist>
</para>
</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
-->
|
