reference/zip/constants.xml
8cedd63d950e83ff12682253dadb7b3a462b20aa
...
...
@@ -6,17 +6,19 @@
6
6

7
7
<para>
8
8
<classname>ZipArchive</classname> uses class constants.
9
-
There are three types of constants :
9
+
There are various types of constants, main are:
10
10
Flags (prefixed with <literal>FL_</literal>),
11
+
Global flags (prefixed with <literal>AFL_</literal>),
11
12
errors (prefixed with <literal>ER_</literal>) and
12
13
mode (no prefix).
13
14
</para>
14
15

15
-
<variablelist>
16
+
<variablelist xml:id="ziparchive.constants.mode">
17
+
<title>Archive open modes</title>
16
18
<varlistentry xml:id="ziparchive.constants.create">
17
19
<term>
18
20
<constant>ZipArchive::CREATE</constant>
19
-
(<type>integer</type>)
21
+
(<type>int</type>)
20
22
</term>
21
23
<listitem>
22
24
<simpara>
...
...
@@ -27,7 +29,7 @@
27
29
<varlistentry xml:id="ziparchive.constants.overwrite">
28
30
<term>
29
31
<constant>ZipArchive::OVERWRITE</constant>
30
-
(<type>integer</type>)
32
+
(<type>int</type>)
31
33
</term>
32
34
<listitem>
33
35
<simpara>
...
...
@@ -40,7 +42,7 @@
40
42
<varlistentry xml:id="ziparchive.constants.excl">
41
43
<term>
42
44
<constant>ZipArchive::EXCL</constant>
43
-
(<type>integer</type>)
45
+
(<type>int</type>)
44
46
</term>
45
47
<listitem>
46
48
<simpara>
...
...
@@ -52,7 +54,7 @@
52
54
<varlistentry xml:id="ziparchive.constants.rdonly">
53
55
<term>
54
56
<constant>ZipArchive::RDONLY</constant>
55
-
(<type>integer</type>)
57
+
(<type>int</type>)
56
58
</term>
57
59
<listitem>
58
60
<simpara>
...
...
@@ -66,7 +68,7 @@
66
68
<varlistentry xml:id="ziparchive.constants.checkcons">
67
69
<term>
68
70
<constant>ZipArchive::CHECKCONS</constant>
69
-
(<type>integer</type>)
71
+
(<type>int</type>)
70
72
</term>
71
73
<listitem>
72
74
<simpara>
...
...
@@ -74,10 +76,70 @@
74
76
</simpara>
75
77
</listitem>
76
78
</varlistentry>
79
+
</variablelist>
80
+

81
+
<variablelist xml:id="ziparchive.constants.afl">
82
+
<title>Archive global flags</title>
83
+
<varlistentry xml:id="ziparchive.constants.afl-rdonly">
84
+
<term>
85
+
<constant>ZipArchive::AFL_RDONLY</constant>
86
+
(<type>int</type>)
87
+
</term>
88
+
<listitem>
89
+
<simpara>
90
+
Archive is read only, cannot be cleared.
91
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
92
+
if built against libzip ≥ 1.10.0.
93
+
</simpara>
94
+
</listitem>
95
+
</varlistentry>
96
+
<varlistentry xml:id="ziparchive.constants.afl-is-torrentzip">
97
+
<term>
98
+
<constant>ZipArchive::AFL_IS_TORRENTZIP</constant>
99
+
(<type>int</type>)
100
+
</term>
101
+
<listitem>
102
+
<simpara>
103
+
Current archive is torrentzipped.
104
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
105
+
if built against libzip ≥ 1.10.0.
106
+
</simpara>
107
+
</listitem>
108
+
</varlistentry>
109
+
<varlistentry xml:id="ziparchive.constants.afl-want-torrentzip">
110
+
<term>
111
+
<constant>ZipArchive::AFL_WANT_TORRENTZIP</constant>
112
+
(<type>int</type>)
113
+
</term>
114
+
<listitem>
115
+
<simpara>
116
+
Write archive in torrentzip format.
117
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
118
+
if built against libzip ≥ 1.10.0.
119
+
</simpara>
120
+
</listitem>
121
+
</varlistentry>
122
+
<varlistentry xml:id="ziparchive.constants.afl-create-or-keep-file-for-empty-archive">
123
+
<term>
124
+
<constant>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</constant>
125
+
(<type>int</type>)
126
+
</term>
127
+
<listitem>
128
+
<simpara>
129
+
Don't remove file if archive is empty.
130
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
131
+
if built against libzip ≥ 1.10.0.
132
+
</simpara>
133
+
</listitem>
134
+
</varlistentry>
135
+
</variablelist>
136
+

137
+
<variablelist xml:id="ziparchive.constants.fl">
138
+
<title>Archive flags</title>
77
139
<varlistentry xml:id="ziparchive.constants.fl-nocase">
78
140
<term>
79
141
<constant>ZipArchive::FL_NOCASE</constant>
80
-
(<type>integer</type>)
142
+
(<type>int</type>)
81
143
</term>
82
144
<listitem>
83
145
<simpara>
...
...
@@ -88,7 +150,7 @@
88
150
<varlistentry xml:id="ziparchive.constants.fl-nodir">
89
151
<term>
90
152
<constant>ZipArchive::FL_NODIR</constant>
91
-
(<type>integer</type>)
153
+
(<type>int</type>)
92
154
</term>
93
155
<listitem>
94
156
<simpara>
...
...
@@ -99,7 +161,7 @@
99
161
<varlistentry xml:id="ziparchive.constants.fl-compressed">
100
162
<term>
101
163
<constant>ZipArchive::FL_COMPRESSED</constant>
102
-
(<type>integer</type>)
164
+
(<type>int</type>)
103
165
</term>
104
166
<listitem>
105
167
<simpara>
...
...
@@ -110,7 +172,7 @@
110
172
<varlistentry xml:id="ziparchive.constants.fl-unchanged">
111
173
<term>
112
174
<constant>ZipArchive::FL_UNCHANGED</constant>
113
-
(<type>integer</type>)
175
+
(<type>int</type>)
114
176
</term>
115
177
<listitem>
116
178
<simpara>
...
...
@@ -121,19 +183,21 @@
121
183
<varlistentry xml:id="ziparchive.constants.fl-recompress">
122
184
<term>
123
185
<constant>ZipArchive::FL_RECOMPRESS</constant>
124
-
(<type>integer</type>)
186
+
(<type>int</type>)
125
187
</term>
126
188
<listitem>
127
189
<simpara>
128
190
Force recompression of data.
129
191
Available as of PHP 8.0.0 and PECL zip 1.18.0.
192
+
Deprecated as of PHP 8.3.0 and PECL zip 1.22.1,
193
+
will be removed in a future version of libzip.
130
194
</simpara>
131
195
</listitem>
132
196
</varlistentry>
133
197
<varlistentry xml:id="ziparchive.constants.fl-encrypted">
134
198
<term>
135
199
<constant>ZipArchive::FL_ENCRYPTED</constant>
136
-
(<type>integer</type>)
200
+
(<type>int</type>)
137
201
</term>
138
202
<listitem>
139
203
<simpara>
...
...
@@ -145,7 +209,7 @@
145
209
<varlistentry xml:id="ziparchive.constants.fl-overwrite">
146
210
<term>
147
211
<constant>ZipArchive::FL_OVERWRITE</constant>
148
-
(<type>integer</type>)
212
+
(<type>int</type>)
149
213
</term>
150
214
<listitem>
151
215
<simpara>
...
...
@@ -157,7 +221,7 @@
157
221
<varlistentry xml:id="ziparchive.constants.fl-local">
158
222
<term>
159
223
<constant>ZipArchive::FL_LOCAL</constant>
160
-
(<type>integer</type>)
224
+
(<type>int</type>)
161
225
</term>
162
226
<listitem>
163
227
<simpara>
...
...
@@ -168,8 +232,8 @@
168
232
</varlistentry>
169
233
<varlistentry xml:id="ziparchive.constants.fl-central">
170
234
<term>
171
-
<constant>ZipArchive::ZIP_FL_CENTRAL</constant>
172
-
(<type>integer</type>)
235
+
<constant>ZipArchive::FL_CENTRAL</constant>
236
+
(<type>int</type>)
173
237
</term>
174
238
<listitem>
175
239
<simpara>
...
...
@@ -182,7 +246,7 @@
182
246
<varlistentry xml:id="ziparchive.constants.fl-enc-guess">
183
247
<term>
184
248
<constant>ZipArchive::FL_ENC_GUESS</constant>
185
-
(<type>integer</type>)
249
+
(<type>int</type>)
186
250
</term>
187
251
<listitem>
188
252
<simpara>
...
...
@@ -193,7 +257,7 @@
193
257
<varlistentry xml:id="ziparchive.constants.fl-enc-raw">
194
258
<term>
195
259
<constant>ZipArchive::FL_ENC_RAW</constant>
196
-
(<type>integer</type>)
260
+
(<type>int</type>)
197
261
</term>
198
262
<listitem>
199
263
<simpara>
...
...
@@ -204,7 +268,7 @@
204
268
<varlistentry xml:id="ziparchive.constants.fl-enc-strict">
205
269
<term>
206
270
<constant>ZipArchive::FL_ENC_STRICT</constant>
207
-
(<type>integer</type>)
271
+
(<type>int</type>)
208
272
</term>
209
273
<listitem>
210
274
<simpara>
...
...
@@ -212,10 +276,10 @@
212
276
</simpara>
213
277
</listitem>
214
278
</varlistentry>
215
-
<varlistentry xml:id="ziparchive.constants.fl-enc-utf8">
279
+
<varlistentry xml:id="ziparchive.constants.fl-enc-utf-8">
216
280
<term>
217
281
<constant>ZipArchive::FL_ENC_UTF_8</constant>
218
-
(<type>integer</type>)
282
+
(<type>int</type>)
219
283
</term>
220
284
<listitem>
221
285
<simpara>
...
...
@@ -226,7 +290,7 @@
226
290
<varlistentry xml:id="ziparchive.constants.fl-enc-cp437">
227
291
<term>
228
292
<constant>ZipArchive::FL_ENC_CP437</constant>
229
-
(<type>integer</type>)
293
+
(<type>int</type>)
230
294
</term>
231
295
<listitem>
232
296
<simpara>
...
...
@@ -234,11 +298,27 @@
234
298
</simpara>
235
299
</listitem>
236
300
</varlistentry>
301
+
<varlistentry xml:id="ziparchive.constants.fl-open-file-now">
302
+
<term>
303
+
<constant>ZipArchive::FL_OPEN_FILE_NOW</constant>
304
+
(<type>int</type>)
305
+
</term>
306
+
<listitem>
307
+
<simpara>
308
+
Open the file when added instead of waiting for archive to be closed.
309
+
Be aware of file descriptors consumption.
310
+
Available as of PHP 8.3.0 and PECL zip 1.22.1.
311
+
</simpara>
312
+
</listitem>
313
+
</varlistentry>
314
+
</variablelist>
237
315

316
+
<variablelist xml:id="ziparchive.constants.cm">
317
+
<title>Compression modes</title>
238
318
<varlistentry xml:id="ziparchive.constants.cm-default">
239
319
<term>
240
320
<constant>ZipArchive::CM_DEFAULT</constant>
241
-
(<type>integer</type>)
321
+
(<type>int</type>)
242
322
</term>
243
323
<listitem>
244
324
<simpara>
...
...
@@ -249,7 +329,7 @@
249
329
<varlistentry xml:id="ziparchive.constants.cm-store">
250
330
<term>
251
331
<constant>ZipArchive::CM_STORE</constant>
252
-
(<type>integer</type>)
332
+
(<type>int</type>)
253
333
</term>
254
334
<listitem>
255
335
<simpara>
...
...
@@ -260,7 +340,7 @@
260
340
<varlistentry xml:id="ziparchive.constants.cm-shrink">
261
341
<term>
262
342
<constant>ZipArchive::CM_SHRINK</constant>
263
-
(<type>integer</type>)
343
+
(<type>int</type>)
264
344
</term>
265
345
<listitem>
266
346
<simpara>
...
...
@@ -271,7 +351,7 @@
271
351
<varlistentry xml:id="ziparchive.constants.cm-reduce-1">
272
352
<term>
273
353
<constant>ZipArchive::CM_REDUCE_1</constant>
274
-
(<type>integer</type>)
354
+
(<type>int</type>)
275
355
</term>
276
356
<listitem>
277
357
<simpara>
...
...
@@ -282,7 +362,7 @@
282
362
<varlistentry xml:id="ziparchive.constants.cm-reduce-2">
283
363
<term>
284
364
<constant>ZipArchive::CM_REDUCE_2</constant>
285
-
(<type>integer</type>)
365
+
(<type>int</type>)
286
366
</term>
287
367
<listitem>
288
368
<simpara>
...
...
@@ -293,7 +373,7 @@
293
373
<varlistentry xml:id="ziparchive.constants.cm-reduce-3">
294
374
<term>
295
375
<constant>ZipArchive::CM_REDUCE_3</constant>
296
-
(<type>integer</type>)
376
+
(<type>int</type>)
297
377
</term>
298
378
<listitem>
299
379
<simpara>
...
...
@@ -304,7 +384,7 @@
304
384
<varlistentry xml:id="ziparchive.constants.cm-reduce-4">
305
385
<term>
306
386
<constant>ZipArchive::CM_REDUCE_4</constant>
307
-
(<type>integer</type>)
387
+
(<type>int</type>)
308
388
</term>
309
389
<listitem>
310
390
<simpara>
...
...
@@ -315,7 +395,7 @@
315
395
<varlistentry xml:id="ziparchive.constants.cm-implode">
316
396
<term>
317
397
<constant>ZipArchive::CM_IMPLODE</constant>
318
-
(<type>integer</type>)
398
+
(<type>int</type>)
319
399
</term>
320
400
<listitem>
321
401
<simpara>
...
...
@@ -326,7 +406,7 @@
326
406
<varlistentry xml:id="ziparchive.constants.cm-deflate">
327
407
<term>
328
408
<constant>ZipArchive::CM_DEFLATE</constant>
329
-
(<type>integer</type>)
409
+
(<type>int</type>)
330
410
</term>
331
411
<listitem>
332
412
<simpara>
...
...
@@ -337,7 +417,7 @@
337
417
<varlistentry xml:id="ziparchive.constants.cm-deflate64">
338
418
<term>
339
419
<constant>ZipArchive::CM_DEFLATE64</constant>
340
-
(<type>integer</type>)
420
+
(<type>int</type>)
341
421
</term>
342
422
<listitem>
343
423
<simpara>
...
...
@@ -348,7 +428,7 @@
348
428
<varlistentry xml:id="ziparchive.constants.cm-pkware-implode">
349
429
<term>
350
430
<constant>ZipArchive::CM_PKWARE_IMPLODE</constant>
351
-
(<type>integer</type>)
431
+
(<type>int</type>)
352
432
</term>
353
433
<listitem>
354
434
<simpara>
...
...
@@ -359,7 +439,7 @@
359
439
<varlistentry xml:id="ziparchive.constants.cm-bzip2">
360
440
<term>
361
441
<constant>ZipArchive::CM_BZIP2</constant>
362
-
(<type>integer</type>)
442
+
(<type>int</type>)
363
443
</term>
364
444
<listitem>
365
445
<simpara>
...
...
@@ -370,7 +450,7 @@
370
450
<varlistentry xml:id="ziparchive.constants.cm-lzma">
371
451
<term>
372
452
<constant>ZipArchive::CM_LZMA</constant>
373
-
(<type>integer</type>)
453
+
(<type>int</type>)
374
454
</term>
375
455
<listitem>
376
456
<simpara>
...
...
@@ -381,7 +461,7 @@
381
461
<varlistentry xml:id="ziparchive.constants.cm-lzma2">
382
462
<term>
383
463
<constant>ZipArchive::CM_LZMA2</constant>
384
-
(<type>integer</type>)
464
+
(<type>int</type>)
385
465
</term>
386
466
<listitem>
387
467
<simpara>
...
...
@@ -391,10 +471,23 @@
391
471
</simpara>
392
472
</listitem>
393
473
</varlistentry>
474
+
<varlistentry xml:id="ziparchive.constants.cm-zstd">
475
+
<term>
476
+
<constant>ZipArchive::CM_ZSTD</constant>
477
+
(<type>int</type>)
478
+
</term>
479
+
<listitem>
480
+
<simpara>
481
+
Zstandard algorithm.
482
+
Available as of PHP 8.0.0 and PECL zip 1.19.1, respectively,
483
+
if built against libzip ≥ 1.8.0.
484
+
</simpara>
485
+
</listitem>
486
+
</varlistentry>
394
487
<varlistentry xml:id="ziparchive.constants.cm-xz">
395
488
<term>
396
489
<constant>ZipArchive::CM_XZ</constant>
397
-
(<type>integer</type>)
490
+
(<type>int</type>)
398
491
</term>
399
492
<listitem>
400
493
<simpara>
...
...
@@ -404,11 +497,50 @@
404
497
</simpara>
405
498
</listitem>
406
499
</varlistentry>
500
+
<varlistentry xml:id="ziparchive.constants.cm-terse">
501
+
<term>
502
+
<constant>ZipArchive::CM_TERSE</constant>
503
+
(<type>int</type>)
504
+
</term>
505
+
<listitem>
506
+
<simpara/>
507
+
</listitem>
508
+
</varlistentry>
509
+
<varlistentry xml:id="ziparchive.constants.cm-lz77">
510
+
<term>
511
+
<constant>ZipArchive::CM_LZ77</constant>
512
+
(<type>int</type>)
513
+
</term>
514
+
<listitem>
515
+
<simpara/>
516
+
</listitem>
517
+
</varlistentry>
518
+
<varlistentry xml:id="ziparchive.constants.cm-wavpack">
519
+
<term>
520
+
<constant>ZipArchive::CM_WAVPACK</constant>
521
+
(<type>int</type>)
522
+
</term>
523
+
<listitem>
524
+
<simpara/>
525
+
</listitem>
526
+
</varlistentry>
527
+
<varlistentry xml:id="ziparchive.constants.cm-ppmd">
528
+
<term>
529
+
<constant>ZipArchive::CM_PPMD</constant>
530
+
(<type>int</type>)
531
+
</term>
532
+
<listitem>
533
+
<simpara/>
534
+
</listitem>
535
+
</varlistentry>
536
+
</variablelist>
407
537

538
+
<variablelist xml:id="ziparchive.constants.er">
539
+
<title>Errors</title>
408
540
<varlistentry xml:id="ziparchive.constants.er-ok">
409
541
<term>
410
542
<constant>ZipArchive::ER_OK</constant>
411
-
(<type>integer</type>)
543
+
(<type>int</type>)
412
544
</term>
413
545
<listitem>
414
546
<simpara>
...
...
@@ -419,7 +551,7 @@
419
551
<varlistentry xml:id="ziparchive.constants.er-multidisk">
420
552
<term>
421
553
<constant>ZipArchive::ER_MULTIDISK</constant>
422
-
(<type>integer</type>)
554
+
(<type>int</type>)
423
555
</term>
424
556
<listitem>
425
557
<simpara>
...
...
@@ -430,7 +562,7 @@
430
562
<varlistentry xml:id="ziparchive.constants.er-rename">
431
563
<term>
432
564
<constant>ZipArchive::ER_RENAME</constant>
433
-
(<type>integer</type>)
565
+
(<type>int</type>)
434
566
</term>
435
567
<listitem>
436
568
<simpara>
...
...
@@ -441,7 +573,7 @@
441
573
<varlistentry xml:id="ziparchive.constants.er-close">
442
574
<term>
443
575
<constant>ZipArchive::ER_CLOSE</constant>
444
-
(<type>integer</type>)
576
+
(<type>int</type>)
445
577
</term>
446
578
<listitem>
447
579
<simpara>
...
...
@@ -452,7 +584,7 @@
452
584
<varlistentry xml:id="ziparchive.constants.er-seek">
453
585
<term>
454
586
<constant>ZipArchive::ER_SEEK</constant>
455
-
(<type>integer</type>)
587
+
(<type>int</type>)
456
588
</term>
457
589
<listitem>
458
590
<simpara>
...
...
@@ -463,7 +595,7 @@
463
595
<varlistentry xml:id="ziparchive.constants.er-read">
464
596
<term>
465
597
<constant>ZipArchive::ER_READ</constant>
466
-
(<type>integer</type>)
598
+
(<type>int</type>)
467
599
</term>
468
600
<listitem>
469
601
<simpara>
...
...
@@ -475,7 +607,7 @@
475
607
<varlistentry xml:id="ziparchive.constants.er-write">
476
608
<term>
477
609
<constant>ZipArchive::ER_WRITE</constant>
478
-
(<type>integer</type>)
610
+
(<type>int</type>)
479
611
</term>
480
612
<listitem>
481
613
<simpara>
...
...
@@ -486,7 +618,7 @@
486
618
<varlistentry xml:id="ziparchive.constants.er-crc">
487
619
<term>
488
620
<constant>ZipArchive::ER_CRC</constant>
489
-
(<type>integer</type>)
621
+
(<type>int</type>)
490
622
</term>
491
623
<listitem>
492
624
<simpara>
...
...
@@ -497,7 +629,7 @@
497
629
<varlistentry xml:id="ziparchive.constants.er-zipclosed">
498
630
<term>
499
631
<constant>ZipArchive::ER_ZIPCLOSED</constant>
500
-
(<type>integer</type>)
632
+
(<type>int</type>)
501
633
</term>
502
634
<listitem>
503
635
<simpara>
...
...
@@ -508,7 +640,7 @@
508
640
<varlistentry xml:id="ziparchive.constants.er-noent">
509
641
<term>
510
642
<constant>ZipArchive::ER_NOENT</constant>
511
-
(<type>integer</type>)
643
+
(<type>int</type>)
512
644
</term>
513
645
<listitem>
514
646
<simpara>
...
...
@@ -519,7 +651,7 @@
519
651
<varlistentry xml:id="ziparchive.constants.er-exists">
520
652
<term>
521
653
<constant>ZipArchive::ER_EXISTS</constant>
522
-
(<type>integer</type>)
654
+
(<type>int</type>)
523
655
</term>
524
656
<listitem>
525
657
<simpara>
...
...
@@ -530,7 +662,7 @@
530
662
<varlistentry xml:id="ziparchive.constants.er-open">
531
663
<term>
532
664
<constant>ZipArchive::ER_OPEN</constant>
533
-
(<type>integer</type>)
665
+
(<type>int</type>)
534
666
</term>
535
667
<listitem>
536
668
<simpara>
...
...
@@ -541,7 +673,7 @@
541
673
<varlistentry xml:id="ziparchive.constants.er-tmpopen">
542
674
<term>
543
675
<constant>ZipArchive::ER_TMPOPEN</constant>
544
-
(<type>integer</type>)
676
+
(<type>int</type>)
545
677
</term>
546
678
<listitem>
547
679
<simpara>
...
...
@@ -552,7 +684,7 @@
552
684
<varlistentry xml:id="ziparchive.constants.er-zlib">
553
685
<term>
554
686
<constant>ZipArchive::ER_ZLIB</constant>
555
-
(<type>integer</type>)
687
+
(<type>int</type>)
556
688
</term>
557
689
<listitem>
558
690
<simpara>
...
...
@@ -564,7 +696,7 @@
564
696
<varlistentry xml:id="ziparchive.constants.er-memory">
565
697
<term>
566
698
<constant>ZipArchive::ER_MEMORY</constant>
567
-
(<type>integer</type>)
699
+
(<type>int</type>)
568
700
</term>
569
701
<listitem>
570
702
<simpara>
...
...
@@ -576,7 +708,7 @@
576
708
<varlistentry xml:id="ziparchive.constants.er-changed">
577
709
<term>
578
710
<constant>ZipArchive::ER_CHANGED</constant>
579
-
(<type>string</type>)
711
+
(<type>int</type>)
580
712
</term>
581
713
<listitem>
582
714
<simpara>
...
...
@@ -588,7 +720,7 @@
588
720
<varlistentry xml:id="ziparchive.constants.er-compnotsupp">
589
721
<term>
590
722
<constant>ZipArchive::ER_COMPNOTSUPP</constant>
591
-
(<type>integer</type>)
723
+
(<type>int</type>)
592
724
</term>
593
725
<listitem>
594
726
<simpara>
...
...
@@ -599,7 +731,7 @@
599
731
<varlistentry xml:id="ziparchive.constants.er-eof">
600
732
<term>
601
733
<constant>ZipArchive::ER_EOF</constant>
602
-
(<type>integer</type>)
734
+
(<type>int</type>)
603
735
</term>
604
736
<listitem>
605
737
<simpara>
...
...
@@ -610,7 +742,7 @@
610
742
<varlistentry xml:id="ziparchive.constants.er-inval">
611
743
<term>
612
744
<constant>ZipArchive::ER_INVAL</constant>
613
-
(<type>integer</type>)
745
+
(<type>int</type>)
614
746
</term>
615
747
<listitem>
616
748
<simpara>
...
...
@@ -621,7 +753,7 @@
621
753
<varlistentry xml:id="ziparchive.constants.er-nozip">
622
754
<term>
623
755
<constant>ZipArchive::ER_NOZIP</constant>
624
-
(<type>integer</type>)
756
+
(<type>int</type>)
625
757
</term>
626
758
<listitem>
627
759
<simpara>
...
...
@@ -632,7 +764,7 @@
632
764
<varlistentry xml:id="ziparchive.constants.er-internal">
633
765
<term>
634
766
<constant>ZipArchive::ER_INTERNAL</constant>
635
-
(<type>integer</type>)
767
+
(<type>int</type>)
636
768
</term>
637
769
<listitem>
638
770
<simpara>
...
...
@@ -643,7 +775,7 @@
643
775
<varlistentry xml:id="ziparchive.constants.er-incons">
644
776
<term>
645
777
<constant>ZipArchive::ER_INCONS</constant>
646
-
(<type>integer</type>)
778
+
(<type>int</type>)
647
779
</term>
648
780
<listitem>
649
781
<simpara>
...
...
@@ -654,7 +786,7 @@
654
786
<varlistentry xml:id="ziparchive.constants.er-remove">
655
787
<term>
656
788
<constant>ZipArchive::ER_REMOVE</constant>
657
-
(<type>integer</type>)
789
+
(<type>int</type>)
658
790
</term>
659
791
<listitem>
660
792
<simpara>
...
...
@@ -665,7 +797,7 @@
665
797
<varlistentry xml:id="ziparchive.constants.er-deleted">
666
798
<term>
667
799
<constant>ZipArchive::ER_DELETED</constant>
668
-
(<type>integer</type>)
800
+
(<type>int</type>)
669
801
</term>
670
802
<listitem>
671
803
<simpara>
...
...
@@ -676,7 +808,7 @@
676
808
<varlistentry xml:id="ziparchive.constants.er-encrnotsupp">
677
809
<term>
678
810
<constant>ZipArchive::ER_ENCRNOTSUPP</constant>
679
-
(<type>integer</type>)
811
+
(<type>int</type>)
680
812
</term>
681
813
<listitem>
682
814
<simpara>
...
...
@@ -688,7 +820,7 @@
688
820
<varlistentry xml:id="ziparchive.constants.er-rdonly">
689
821
<term>
690
822
<constant>ZipArchive::ER_RDONLY</constant>
691
-
(<type>integer</type>)
823
+
(<type>int</type>)
692
824
</term>
693
825
<listitem>
694
826
<simpara>
...
...
@@ -700,7 +832,7 @@
700
832
<varlistentry xml:id="ziparchive.constants.er-nopasswd">
701
833
<term>
702
834
<constant>ZipArchive::ER_NOPASSWD</constant>
703
-
(<type>integer</type>)
835
+
(<type>int</type>)
704
836
</term>
705
837
<listitem>
706
838
<simpara>
...
...
@@ -712,7 +844,7 @@
712
844
<varlistentry xml:id="ziparchive.constants.er-wrongpasswd">
713
845
<term>
714
846
<constant>ZipArchive::ER_WRONGPASSWD</constant>
715
-
(<type>integer</type>)
847
+
(<type>int</type>)
716
848
</term>
717
849
<listitem>
718
850
<simpara>
...
...
@@ -723,8 +855,8 @@
723
855
</varlistentry>
724
856
<varlistentry xml:id="ziparchive.constants.er-opnotsupp">
725
857
<term>
726
-
<constant>ZipArchive::ZIP_ER_OPNOTSUPP</constant>
727
-
(<type>integer</type>)
858
+
<constant>ZipArchive::ER_OPNOTSUPP</constant>
859
+
(<type>int</type>)
728
860
</term>
729
861
<listitem>
730
862
<simpara>
...
...
@@ -736,8 +868,8 @@
736
868
</varlistentry>
737
869
<varlistentry xml:id="ziparchive.constants.er-inuse">
738
870
<term>
739
-
<constant>ZipArchive::ZIP_ER_INUSE</constant>
740
-
(<type>integer</type>)
871
+
<constant>ZipArchive::ER_INUSE</constant>
872
+
(<type>int</type>)
741
873
</term>
742
874
<listitem>
743
875
<simpara>
...
...
@@ -749,8 +881,8 @@
749
881
</varlistentry>
750
882
<varlistentry xml:id="ziparchive.constants.er-tell">
751
883
<term>
752
-
<constant>ZipArchive::ZIP_ER_TELL</constant>
753
-
(<type>integer</type>)
884
+
<constant>ZipArchive::ER_TELL</constant>
885
+
(<type>int</type>)
754
886
</term>
755
887
<listitem>
756
888
<simpara>
...
...
@@ -762,8 +894,8 @@
762
894
</varlistentry>
763
895
<varlistentry xml:id="ziparchive.constants.er-compressed-data">
764
896
<term>
765
-
<constant>ZipArchive::ZIP_ER_COMPRESSED_DATA</constant>
766
-
(<type>integer</type>)
897
+
<constant>ZipArchive::ER_COMPRESSED_DATA</constant>
898
+
(<type>int</type>)
767
899
</term>
768
900
<listitem>
769
901
<simpara>
...
...
@@ -776,7 +908,7 @@
776
908
<varlistentry xml:id="ziparchive.constants.er-cancelled">
777
909
<term>
778
910
<constant>ZipArchive::ER_CANCELLED</constant>
779
-
(<type>integer</type>)
911
+
(<type>int</type>)
780
912
</term>
781
913
<listitem>
782
914
<simpara>
...
...
@@ -786,21 +918,62 @@
786
918
</simpara>
787
919
</listitem>
788
920
</varlistentry>
921
+
<varlistentry xml:id="ziparchive.constants.er-data-length">
922
+
<term>
923
+
<constant>ZipArchive::ER_DATA_LENGTH</constant>
924
+
(<type>int</type>)
925
+
</term>
926
+
<listitem>
927
+
<simpara>
928
+
Unexpected length of data.
929
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
930
+
if built against libzip ≥ 1.10.0.
931
+
</simpara>
932
+
</listitem>
933
+
</varlistentry>
934
+
<varlistentry xml:id="ziparchive.constants.er-not-allowed">
935
+
<term>
936
+
<constant>ZipArchive::ER_NOT_ALLOWED</constant>
937
+
(<type>int</type>)
938
+
</term>
939
+
<listitem>
940
+
<simpara>
941
+
Not allowed in torrentzip.
942
+
Available as of PHP 8.3.0 and PECL zip 1.22.0, respectively,
943
+
if built against libzip ≥ 1.10.0.
944
+
</simpara>
945
+
</listitem>
946
+
</varlistentry>
947
+
</variablelist>
789
948

949
+
<variablelist xml:id="ziparchive.constants.em">
950
+
<title>Encryption modes</title>
790
951
<varlistentry xml:id="ziparchive.constants.em-none">
791
952
<term>
792
-
<constant>ZipArchive::EM_NONE</constant> (<type>integer</type>)
953
+
<constant>ZipArchive::EM_NONE</constant>
954
+
(<type>int</type>)
793
955
</term>
794
956
<listitem>
795
957
<simpara>
796
-
No encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively,
797
-
if built against libzip ≥ 1.2.0.
958
+
No encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively.
798
959
</simpara>
799
960
</listitem>
800
961
</varlistentry>
801
-
<varlistentry xml:id="ziparchive.constants.em-aez-128">
962
+
<varlistentry xml:id="ziparchive.constants.em-trad-pkware">
802
963
<term>
803
-
<constant>ZipArchive::EM_AES_128</constant> (<type>integer</type>)
964
+
<constant>ZipArchive::EM_TRAD_PKWARE</constant>
965
+
(<type>int</type>)
966
+
</term>
967
+
<listitem>
968
+
<simpara>
969
+
Traditional PKWARE encryption. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.
970
+
</simpara>
971
+
</listitem>
972
+
</varlistentry>
973
+
<varlistentry xml:id="ziparchive.constants.em-aes-128">
974
+
<term>
975
+
<constant>ZipArchive::EM_AES_128</constant>
976
+
(<type>int</type>)
804
977
</term>
805
978
<listitem>
806
979
<simpara>
...
...
@@ -809,9 +982,10 @@
809
982
</simpara>
810
983
</listitem>
811
984
</varlistentry>
812
-
<varlistentry xml:id="ziparchive.constants.em-aez-192">
985
+
<varlistentry xml:id="ziparchive.constants.em-aes-192">
813
986
<term>
814
-
<constant>ZipArchive::EM_AES_192</constant> (<type>integer</type>)
987
+
<constant>ZipArchive::EM_AES_192</constant>
988
+
(<type>int</type>)
815
989
</term>
816
990
<listitem>
817
991
<simpara>
...
...
@@ -820,9 +994,10 @@
820
994
</simpara>
821
995
</listitem>
822
996
</varlistentry>
823
-
<varlistentry xml:id="ziparchive.constants.em-aes256">
997
+
<varlistentry xml:id="ziparchive.constants.em-aes-256">
824
998
<term>
825
-
<constant>ZipArchive::EM_AES_256</constant> (<type>integer</type>)
999
+
<constant>ZipArchive::EM_AES_256</constant>
1000
+
(<type>int</type>)
826
1001
</term>
827
1002
<listitem>
828
1003
<simpara>
...
...
@@ -831,9 +1006,53 @@
831
1006
</simpara>
832
1007
</listitem>
833
1008
</varlistentry>
1009
+
<varlistentry xml:id="ziparchive.constants.em-unknown">
1010
+
<term>
1011
+
<constant>ZipArchive::EM_UNKNOWN</constant>
1012
+
(<type>int</type>)
1013
+
</term>
1014
+
<listitem>
1015
+
<simpara>
1016
+
Unknown encryption algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.
1017
+
</simpara>
1018
+
</listitem>
1019
+
</varlistentry>
1020
+
</variablelist>
1021
+

1022
+
<variablelist xml:id="ziparchive.constants.length">
1023
+
<title>Length parameter constants</title>
1024
+
<varlistentry xml:id="ziparchive.constants.length-to-end">
1025
+
<term>
1026
+
<constant>ZipArchive::LENGTH_TO_END</constant>
1027
+
(<type>int</type>)
1028
+
</term>
1029
+
<listitem>
1030
+
<simpara>
1031
+
Use file size, if the file grows additionnal data is ignored, if the file shrinks an error is raised (<constant>ZipArchive::ER_DATA_LENGTH</constant>).
1032
+
Available as of PHP 8.3.0 and PECL zip 1.22.2.
1033
+
</simpara>
1034
+
</listitem>
1035
+
</varlistentry>
1036
+
<varlistentry xml:id="ziparchive.constants.length-unchecked">
1037
+
<term>
1038
+
<constant>ZipArchive::LENGTH_UNCHECKED</constant>
1039
+
(<type>int</type>)
1040
+
</term>
1041
+
<listitem>
1042
+
<simpara>
1043
+
Use all available data.
1044
+
Available as of PHP 8.3.0 and PECL zip 1.22.2, if built against libzip ≥ 1.10.1.
1045
+
</simpara>
1046
+
</listitem>
1047
+
</varlistentry>
1048
+
</variablelist>
1049
+

1050
+
<variablelist xml:id="ziparchive.constants.other">
1051
+
<title>Other constants</title>
834
1052
<varlistentry xml:id="ziparchive.constants.libzip-version">
835
1053
<term>
836
-
<constant>ZipArchive::LIBZIP_VERSION</constant> (<type>string</type>)
1054
+
<constant>ZipArchive::LIBZIP_VERSION</constant>
1055
+
(<type>string</type>)
837
1056
</term>
838
1057
<listitem>
839
1058
<simpara>
...
...
@@ -845,79 +1064,199 @@
845
1064

846
1065
<variablelist xml:id="ziparchive.constants.opsys">
847
1066
<title>Operating system constants for external attributes</title>
848
-
<varlistentry xml:id="ziparchive.constants.opsys.default">
1067
+
<varlistentry xml:id="ziparchive.constants.opsys-dos">
849
1068
<term>
850
-
<constant>ZipArchive::OPSYS_DOS</constant> (<type>integer</type>)
1069
+
<constant>ZipArchive::OPSYS_DOS</constant>
1070
+
(<type>int</type>)
851
1071
</term>
1072
+
<listitem>
1073
+
<simpara/>
1074
+
</listitem>
1075
+
</varlistentry>
1076
+
<varlistentry xml:id="ziparchive.constants.opsys-amiga">
852
1077
<term>
853
-
<constant>ZipArchive::OPSYS_AMIGA</constant> (<type>integer</type>)
1078
+
<constant>ZipArchive::OPSYS_AMIGA</constant>
1079
+
(<type>int</type>)
854
1080
</term>
1081
+
<listitem>
1082
+
<simpara/>
1083
+
</listitem>
1084
+
</varlistentry>
1085
+
<varlistentry xml:id="ziparchive.constants.opsys-openvms">
855
1086
<term>
856
-
<constant>ZipArchive::OPSYS_OPENVMS</constant> (<type>integer</type>)
1087
+
<constant>ZipArchive::OPSYS_OPENVMS</constant>
1088
+
(<type>int</type>)
857
1089
</term>
1090
+
<listitem>
1091
+
<simpara/>
1092
+
</listitem>
1093
+
</varlistentry>
1094
+
<varlistentry xml:id="ziparchive.constants.opsys-unix">
858
1095
<term>
859
-
<constant>ZipArchive::OPSYS_UNIX</constant> (<type>integer</type>)
1096
+
<constant>ZipArchive::OPSYS_UNIX</constant>
1097
+
(<type>int</type>)
860
1098
</term>
1099
+
<listitem>
1100
+
<simpara/>
1101
+
</listitem>
1102
+
</varlistentry>
1103
+
<varlistentry xml:id="ziparchive.constants.opsys-vm-cms">
861
1104
<term>
862
-
<constant>ZipArchive::OPSYS_VM_CMS</constant> (<type>integer</type>)
1105
+
<constant>ZipArchive::OPSYS_VM_CMS</constant>
1106
+
(<type>int</type>)
863
1107
</term>
1108
+
<listitem>
1109
+
<simpara/>
1110
+
</listitem>
1111
+
</varlistentry>
1112
+
<varlistentry xml:id="ziparchive.constants.opsys-atari-st">
864
1113
<term>
865
-
<constant>ZipArchive::OPSYS_ATARI_ST</constant> (<type>integer</type>)
1114
+
<constant>ZipArchive::OPSYS_ATARI_ST</constant>
1115
+
(<type>int</type>)
866
1116
</term>
1117
+
<listitem>
1118
+
<simpara/>
1119
+
</listitem>
1120
+
</varlistentry>
1121
+
<varlistentry xml:id="ziparchive.constants.opsys-os-2">
867
1122
<term>
868
-
<constant>ZipArchive::OPSYS_OS_2</constant> (<type>integer</type>)
1123
+
<constant>ZipArchive::OPSYS_OS_2</constant>
1124
+
(<type>int</type>)
869
1125
</term>
1126
+
<listitem>
1127
+
<simpara/>
1128
+
</listitem>
1129
+
</varlistentry>
1130
+
<varlistentry xml:id="ziparchive.constants.opsys-macintosh">
870
1131
<term>
871
-
<constant>ZipArchive::OPSYS_MACINTOSH</constant> (<type>integer</type>)
1132
+
<constant>ZipArchive::OPSYS_MACINTOSH</constant>
1133
+
(<type>int</type>)
872
1134
</term>
1135
+
<listitem>
1136
+
<simpara/>
1137
+
</listitem>
1138
+
</varlistentry>
1139
+
<varlistentry xml:id="ziparchive.constants.opsys-z-system">
873
1140
<term>
874
-
<constant>ZipArchive::OPSYS_Z_SYSTEM</constant> (<type>integer</type>)
1141
+
<constant>ZipArchive::OPSYS_Z_SYSTEM</constant>
1142
+
(<type>int</type>)
875
1143
</term>
1144
+
<listitem>
1145
+
<simpara/>
1146
+
</listitem>
1147
+
</varlistentry>
1148
+
<varlistentry xml:id="ziparchive.constants.opsys-cpm">
876
1149
<term>
877
-
<constant>ZipArchive::OPSYS_CPM</constant> (<type>integer</type>)
1150
+
<constant>ZipArchive::OPSYS_CPM</constant>
1151
+
(<type>int</type>)
878
1152
</term>
1153
+
<listitem>
1154
+
<simpara/>
1155
+
</listitem>
1156
+
</varlistentry>
1157
+
<varlistentry xml:id="ziparchive.constants.opsys-windows-ntfs">
879
1158
<term>
880
-
<constant>ZipArchive::OPSYS_WINDOWS_NTFS</constant> (<type>integer</type>)
1159
+
<constant>ZipArchive::OPSYS_WINDOWS_NTFS</constant>
1160
+
(<type>int</type>)
881
1161
</term>
1162
+
<listitem>
1163
+
<simpara/>
1164
+
</listitem>
1165
+
</varlistentry>
1166
+
<varlistentry xml:id="ziparchive.constants.opsys-mvs">
882
1167
<term>
883
-
<constant>ZipArchive::OPSYS_MVS</constant> (<type>integer</type>)
1168
+
<constant>ZipArchive::OPSYS_MVS</constant>
1169
+
(<type>int</type>)
884
1170
</term>
1171
+
<listitem>
1172
+
<simpara/>
1173
+
</listitem>
1174
+
</varlistentry>
1175
+
<varlistentry xml:id="ziparchive.constants.opsys-vse">
885
1176
<term>
886
-
<constant>ZipArchive::OPSYS_VSE</constant> (<type>integer</type>)
1177
+
<constant>ZipArchive::OPSYS_VSE</constant>
1178
+
(<type>int</type>)
887
1179
</term>
1180
+
<listitem>
1181
+
<simpara/>
1182
+
</listitem>
1183
+
</varlistentry>
1184
+
<varlistentry xml:id="ziparchive.constants.opsys-acorn-risc">
888
1185
<term>
889
-
<constant>ZipArchive::OPSYS_ACORN_RISC</constant> (<type>integer</type>)
1186
+
<constant>ZipArchive::OPSYS_ACORN_RISC</constant>
1187
+
(<type>int</type>)
890
1188
</term>
1189
+
<listitem>
1190
+
<simpara/>
1191
+
</listitem>
1192
+
</varlistentry>
1193
+
<varlistentry xml:id="ziparchive.constants.opsys-vfat">
891
1194
<term>
892
-
<constant>ZipArchive::OPSYS_VFAT</constant> (<type>integer</type>)
1195
+
<constant>ZipArchive::OPSYS_VFAT</constant>
1196
+
(<type>int</type>)
893
1197
</term>
1198
+
<listitem>
1199
+
<simpara/>
1200
+
</listitem>
1201
+
</varlistentry>
1202
+
<varlistentry xml:id="ziparchive.constants.opsys-alternate-mvs">
894
1203
<term>
895
-
<constant>ZipArchive::OPSYS_ALTERNATE_MVS</constant> (<type>integer</type>)
1204
+
<constant>ZipArchive::OPSYS_ALTERNATE_MVS</constant>
1205
+
(<type>int</type>)
896
1206
</term>
1207
+
<listitem>
1208
+
<simpara/>
1209
+
</listitem>
1210
+
</varlistentry>
1211
+
<varlistentry xml:id="ziparchive.constants.opsys-beos">
897
1212
<term>
898
-
<constant>ZipArchive::OPSYS_BEOS</constant> (<type>integer</type>)
1213
+
<constant>ZipArchive::OPSYS_BEOS</constant>
1214
+
(<type>int</type>)
899
1215
</term>
1216
+
<listitem>
1217
+
<simpara/>
1218
+
</listitem>
1219
+
</varlistentry>
1220
+
<varlistentry xml:id="ziparchive.constants.opsys-tandem">
900
1221
<term>
901
-
<constant>ZipArchive::OPSYS_TANDEM</constant> (<type>integer</type>)
1222
+
<constant>ZipArchive::OPSYS_TANDEM</constant>
1223
+
(<type>int</type>)
902
1224
</term>
1225
+
<listitem>
1226
+
<simpara/>
1227
+
</listitem>
1228
+
</varlistentry>
1229
+
<varlistentry xml:id="ziparchive.constants.opsys-os-4000">
903
1230
<term>
904
-
<constant>ZipArchive::OPSYS_OS_400</constant> (<type>integer</type>)
1231
+
<constant>ZipArchive::OPSYS_OS_400</constant>
1232
+
(<type>int</type>)
905
1233
</term>
1234
+
<listitem>
1235
+
<simpara/>
1236
+
</listitem>
1237
+
</varlistentry>
1238
+
<varlistentry xml:id="ziparchive.constants.opsys-os-x">
906
1239
<term>
907
-
<constant>ZipArchive::OPSYS_OS_X</constant> (<type>integer</type>)
1240
+
<constant>ZipArchive::OPSYS_OS_X</constant>
1241
+
(<type>int</type>)
908
1242
</term>
1243
+
<listitem>
1244
+
<simpara/>
1245
+
</listitem>
1246
+
</varlistentry>
1247
+
<varlistentry xml:id="ziparchive.constants.opsys-default">
909
1248
<term>
910
-
<constant>ZipArchive::OPSYS_DEFAULT</constant> (<type>integer</type>)
1249
+
<constant>ZipArchive::OPSYS_DEFAULT</constant>
1250
+
(<type>int</type>)
911
1251
</term>
912
1252
<listitem>
913
1253
<simpara>
914
-
Since PHP 5.6.0, PECL zip 1.12.4
1254
+
Since PECL zip 1.12.4
915
1255
</simpara>
916
1256
</listitem>
917
1257
</varlistentry>
918
1258
</variablelist>
919
1259
</appendix>
920
-

921
1260
<!-- Keep this comment at the end of the file
922
1261
Local variables:
923
1262
mode: sgml
924
1263