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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
|
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="ZipArchive" namespace="" name="ZipArchive">
<implements name="Countable" full="Countable"/>
<member name="status" static="false">
<default>null</default>
<docblock>
<description compact="Status of the Zip Archive"/>
<var type="int"/>
</docblock>
</member>
<member name="statusSys" static="false">
<default>null</default>
<docblock>
<description compact="System status of the Zip Archive"/>
<var type="int"/>
</docblock>
</member>
<member name="numFiles" static="false">
<default>null</default>
<docblock>
<description compact="Number of files in archive"/>
<var type="int"/>
</docblock>
</member>
<member name="filename" static="false">
<default>null</default>
<docblock>
<description compact="File name in the file system"/>
<var type="string"/>
</docblock>
</member>
<member name="comment" static="false">
<default>null</default>
<docblock>
<description compact="Comment for the archive"/>
<var type="string"/>
</docblock>
</member>
<method name="addEmptyDir" abstract="false" static="false" final="false">
<docblock>
<description compact="Add a new directory"/>
<return type="bool"/>
</docblock>
<parameter name="dirname" optional="false" byreference="false" type="string"/>
</method>
<method name="addFile" abstract="false" static="false" final="false">
<docblock>
<description compact="Adds a file to a ZIP archive from the given path"/>
<return type="bool"/>
</docblock>
<parameter name="filename" optional="false" byreference="false" type="string"/>
<parameter name="localname" optional="true" byreference="false" type="string"/>
<parameter name="start" optional="true" byreference="false" type="int"/>
<parameter name="length" optional="true" byreference="false" type="int"/>
</method>
<method name="addFromString" abstract="false" static="false" final="false">
<docblock>
<description compact="Add a file to a ZIP archive using its contents"/>
<return type="bool"/>
</docblock>
<parameter name="localname" optional="false" byreference="false" type="string"/>
<parameter name="contents" optional="false" byreference="false" type="string"/>
</method>
<method name="addGlob" abstract="false" static="false" final="false">
<docblock>
<description compact="Add files from a directory by glob pattern"/>
<return type="bool"/>
</docblock>
<parameter name="pattern" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="addPattern" abstract="false" static="false" final="false">
<docblock>
<description compact="Add files from a directory by PCRE pattern"/>
<return type="bool"/>
</docblock>
<parameter name="pattern" optional="false" byreference="false" type="string"/>
<parameter name="path" optional="true" byreference="false" type="string"/>
<parameter name="options" optional="true" byreference="false" type="object" class="array"/>
</method>
<method name="close" abstract="false" static="false" final="false">
<docblock>
<description compact="Close the active archive (opened or newly created)"/>
<return type="bool"/>
</docblock>
</method>
<method name="count" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Counts the number of files in the achive"/>
<return type="int"/>
</docblock>
</method>
<method name="deleteIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Delete an entry in the archive using its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
</method>
<method name="deleteName" abstract="false" static="false" final="false">
<docblock>
<description compact="Delete an entry in the archive using its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
<method name="extractTo" abstract="false" static="false" final="false">
<docblock>
<description compact="Extract the archive contents"/>
<return type="bool"/>
</docblock>
<parameter name="destination" optional="false" byreference="false" type="string"/>
<parameter name="entries" optional="true" byreference="false" type="object" class="mixed"/>
</method>
<method name="getArchiveComment" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the Zip archive comment"/>
<return type="string"/>
</docblock>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getCommentIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the comment of an entry using the entry index"/>
<return type="string"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getCommentName" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the comment of an entry using the entry name"/>
<return type="string"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="GetExternalAttributesIndex" abstract="false" static="false" final="false">
<docblock>
<description compact=""/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="opsys" optional="false" byreference="false" type="int"/>
<parameter name="attr" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getExternalAttributesName" abstract="false" static="false" final="false">
<docblock>
<description compact="Retrieve the external attributes of an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="opsys" optional="false" byreference="false" type="int"/>
<parameter name="attr" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getFromIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the entry contents using its index"/>
<return type="string"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="length" optional="true" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getFromName" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the entry contents using its name"/>
<return type="string"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="length" optional="true" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getNameIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the name of an entry using its index"/>
<return type="string"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="getStatusString" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the status error message, system and/or zip messages"/>
<return type="string"/>
</docblock>
</method>
<method name="getStream" abstract="false" static="false" final="false">
<docblock>
<description compact="Get a file handler to the entry defined by its name (read only)"/>
<return type="resource"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
<method name="locateName" abstract="false" static="false" final="false">
<docblock>
<description compact="Returns the index of the entry in the archive"/>
<return type="int"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="open" abstract="false" static="false" final="false">
<docblock>
<description compact="Open a ZIP file archive"/>
<return type="mixed"/>
</docblock>
<parameter name="filename" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="renameIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Renames an entry defined by its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="newname" optional="false" byreference="false" type="string"/>
</method>
<method name="renameName" abstract="false" static="false" final="false">
<docblock>
<description compact="Renames an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="newname" optional="false" byreference="false" type="string"/>
</method>
<method name="setArchiveComment" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the comment of a ZIP archive"/>
<return type="bool"/>
</docblock>
<parameter name="comment" optional="false" byreference="false" type="string"/>
</method>
<method name="setCommentIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the comment of an entry defined by its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="comment" optional="false" byreference="false" type="string"/>
</method>
<method name="setCommentName" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the comment of an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="comment" optional="false" byreference="false" type="string"/>
</method>
<method name="setCompressionIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the compression method of an entry defined by its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="comp_method" optional="false" byreference="false" type="int"/>
<parameter name="comp_flags" optional="true" byreference="false" type="int"/>
</method>
<method name="setCompressionName" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the compression method of an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="comp_method" optional="false" byreference="false" type="int"/>
<parameter name="comp_flags" optional="true" byreference="false" type="int"/>
</method>
<method name="setEncryptionIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the encryption method of an entry defined by its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="method" optional="false" byreference="false" type="string"/>
<parameter name="password" optional="true" byreference="false" type="string"/>
</method>
<method name="setEncryptionName" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the encryption method of an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="method" optional="false" byreference="false" type="int"/>
<parameter name="password" optional="true" byreference="false" type="string"/>
</method>
<method name="setExternalAttributesIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the external attributes of an entry defined by its index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="opsys" optional="false" byreference="false" type="int"/>
<parameter name="attr" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="setExternalAttributesName" abstract="false" static="false" final="false">
<docblock>
<description compact="Set the external attributes of an entry defined by its name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="opsys" optional="false" byreference="false" type="int"/>
<parameter name="attr" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="setPassword" abstract="false" static="false" visibility="public" final="false">
<docblock>
<description compact="Set the password for the active archive"/>
<return type="bool"/>
</docblock>
<parameter name="password" optional="false" byreference="false" type="string"/>
</method>
<method name="statIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Get the details of an entry defined by its index"/>
<return type="array"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="statName" abstract="false" static="false" final="false">
<docblock>
<description compact="Get the details of an entry defined by its name"/>
<return type="array"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
<parameter name="flags" optional="true" byreference="false" type="int"/>
</method>
<method name="unchangeAll" abstract="false" static="false" final="false">
<docblock>
<description compact="Undo all changes done in the archive"/>
<return type="bool"/>
</docblock>
</method>
<method name="unchangeArchive" abstract="false" static="false" final="false">
<docblock>
<description compact="Revert all global changes done in the archive"/>
<return type="bool"/>
</docblock>
</method>
<method name="unchangeIndex" abstract="false" static="false" final="false">
<docblock>
<description compact="Revert all changes done to an entry at the given index"/>
<return type="bool"/>
</docblock>
<parameter name="index" optional="false" byreference="false" type="int"/>
</method>
<method name="unchangeName" abstract="false" static="false" final="false">
<docblock>
<description compact="Revert all changes done to an entry with the given name"/>
<return type="bool"/>
</docblock>
<parameter name="name" optional="false" byreference="false" type="string"/>
</method>
</class>
|
