@@ -67,7 +67,7 @@ extension=zstd.so
67
67
Name | Default | Changeable
68
68
------------------------------- | ------- | ----------
69
69
zstd.output\_ compression | 0 | PHP\_ INI\_ ALL
70
- zstd.output\_ compression\_ level | -1 | PHP\_ INI\_ ALL
70
+ zstd.output\_ compression\_ level | 3 | PHP\_ INI\_ ALL
71
71
zstd.output\_ compression\_ dict | "" | PHP\_ INI\_ ALL
72
72
73
73
* zstd.output\_ compression _ boolean_ /_ integer_
@@ -82,8 +82,8 @@ zstd.output\_compression\_dict | "" | PHP\_INI\_ALL
82
82
* zstd.output\_ compression\_ level _ integer_
83
83
84
84
Compression level used for transparent output compression.
85
- Specify a value between 0 to 22.
86
- The default value of -1 uses internally defined values (3 ).
85
+ Specify a value between 1 to 22.
86
+ The default value of ` ZSTD_COMPRESS_LEVEL_DEFAULT ` (11 ).
87
87
88
88
* zstd.output\_ compression\_ dict _ string_
89
89
@@ -97,8 +97,8 @@ Name | Description
97
97
ZSTD\_ COMPRESS\_ LEVEL\_ MIN | Minimal compress level value
98
98
ZSTD\_ COMPRESS\_ LEVEL\_ MAX | Maximal compress level value
99
99
ZSTD\_ COMPRESS\_ LEVEL\_ DEFAULT | Default compress level value
100
- LIBZSTD \_ VERSION\_ NUMBER | libzstd version number
101
- LIBZSTD \_ VERSION\_ STRING | libzstd version string
100
+ ZSTD \_ VERSION\_ NUMBER | libzstd version number
101
+ ZSTD \_ VERSION\_ TEXT | libzstd version string
102
102
103
103
## Function
104
104
@@ -111,12 +111,14 @@ LIBZSTD\_VERSION\_STRING | libzstd version string
111
111
* zstd\_ uncompress\_ init — Initialize an incremental uncompress context
112
112
* zstd\_ uncompress\_ add — Incrementally uncompress data
113
113
114
-
114
+ ---
115
115
### zstd\_ compress — Zstandard compression
116
116
117
117
#### Description
118
118
119
- string ** zstd\_ compress** ( string _ $data_ [ , int _ $level_ = 3 ] )
119
+ ``` php
120
+ zstd_compress ( string $data, int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): string|false
121
+ ```
120
122
121
123
Zstandard compression.
122
124
@@ -128,8 +130,8 @@ Zstandard compression.
128
130
129
131
* _ level_
130
132
131
- The level of compression (1-22).
132
- (Defaults to 3 )
133
+ The level of compression (e.g. 1-22).
134
+ (Defaults to ` ZSTD_COMPRESS_LEVEL_DEFAULT ` )
133
135
134
136
A value smaller than 0 means a faster compression level.
135
137
(Zstandard library 1.3.4 or later)
@@ -138,12 +140,14 @@ Zstandard compression.
138
140
139
141
Returns the compressed data or FALSE if an error occurred.
140
142
141
-
143
+ ---
142
144
### zstd\_ uncompress — Zstandard decompression
143
145
144
146
#### Description
145
147
146
- string ** zstd\_ uncompress** ( string _ $data_ )
148
+ ``` php
149
+ zstd_uncompress ( string $data ): string|false
150
+ ```
147
151
148
152
Zstandard decompression.
149
153
@@ -159,12 +163,14 @@ Zstandard decompression.
159
163
160
164
Returns the decompressed data or FALSE if an error occurred.
161
165
162
-
166
+ ---
163
167
### zstd\_ compress\_ dict — Zstandard compression using a digested dictionary
164
168
165
169
#### Description
166
170
167
- string ** zstd\_ compress\_ dict** ( string _ $data_ , string _ $dict_ [ , int _ $level_ = 3 ] )
171
+ ``` php
172
+ zstd_compress_dict ( string $data , string $dict, int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): string|false
173
+ ```
168
174
169
175
Zstandard compression using a digested dictionary.
170
176
@@ -182,19 +188,21 @@ Zstandard compression using a digested dictionary.
182
188
183
189
* _ level_
184
190
185
- The level of compression (1-22).
186
- (Defaults to 3 )
191
+ The level of compression (e.g. 1-22).
192
+ (Defaults to ` ZSTD_COMPRESS_LEVEL_DEFAULT ` )
187
193
188
194
#### Return Values
189
195
190
196
Returns the compressed data or FALSE if an error occurred.
191
197
192
-
198
+ ---
193
199
### zstd\_ uncompress\_ dict — Zstandard decompression using a digested dictionary
194
200
195
201
#### Description
196
202
197
- string ** zstd\_ uncompress\_ dict** ( string _ $data_ , string _ $dict_ )
203
+ ``` php
204
+ zstd_uncompress_dict ( string $data , string $dict ): string|false
205
+ ```
198
206
199
207
Zstandard decompression using a digested dictionary.
200
208
@@ -215,31 +223,36 @@ Zstandard decompression using a digested dictionary.
215
223
216
224
Returns the decompressed data or FALSE if an error occurred.
217
225
218
-
226
+ ---
219
227
### zstd\_ compress\_ init — Initialize an incremental compress context
220
228
221
229
#### Description
222
230
223
- Zstd\\ Compress\\ Context ** zstd\_ compress\_ init** ( [ int _ $level_ = ZSTD_COMPRESS_LEVEL_DEFAULT ] )
231
+ ``` php
232
+ zstd_compress_init ( int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): Zstd\Compress\Context|false
233
+ ```
224
234
225
235
Initialize an incremental compress context
226
236
227
237
#### Parameters
228
238
229
239
* _ level_
230
240
231
- The higher the level, the slower the compression. (Defaults to ` ZSTD_COMPRESS_LEVEL_DEFAULT ` )
241
+ The higher the level, the slower the compression.
242
+ (Defaults to ` ZSTD_COMPRESS_LEVEL_DEFAULT ` )
232
243
233
244
#### Return Values
234
245
235
246
Returns a zstd context instance on success, or FALSE on failure
236
247
237
-
248
+ ---
238
249
### zstd\_ compress\_ add — Incrementally compress data
239
250
240
251
#### Description
241
252
242
- string ** zstd\_ compress\_ add** ( Zstd\\ Compress\\ Context _ $context_ , string _ $data_ [ , bool _ $end_ = false ] )
253
+ ``` php
254
+ zstd_compress_add ( Zstd\Compress\Context $context, string $data, bool $end = false ): string|false
255
+ ```
243
256
244
257
Incrementally compress data
245
258
@@ -261,25 +274,29 @@ Incrementally compress data
261
274
262
275
Returns a chunk of compressed data, or FALSE on failure.
263
276
264
-
277
+ ---
265
278
### zstd\_ uncompress\_ init — Initialize an incremental uncompress context
266
279
267
280
#### Description
268
281
269
- Zstd\\ UnCompress\\ Context ** zstd\_ uncompress\_ init** ( void )
282
+ ``` php
283
+ zstd_uncompress_init ( void ): Zstd\UnCompress\Context|false
284
+ ```
270
285
271
286
Initialize an incremental uncompress context
272
287
273
288
#### Return Values
274
289
275
290
Returns a zstd context instance on success, or FALSE on failure
276
291
277
-
292
+ ---
278
293
### zstd\_ uncompress\_ add — Incrementally uncompress data
279
294
280
295
#### Description
281
296
282
- string ** zstd\_ uncompress\_ add** ( Zstd\\ UnCompress\\ Context _ $context_ , string _ $data_ )
297
+ ``` php
298
+ zstd_uncompress_add ( Zstd\UnCompress\Context $context, string $data ): string|false
299
+ ```
283
300
284
301
Incrementally uncompress data
285
302
@@ -300,18 +317,17 @@ Returns a chunk of uncompressed data, or FALSE on failure.
300
317
301
318
## Namespace
302
319
303
- ```
320
+ ``` php
304
321
Namespace Zstd;
305
322
306
- function compress( $data [, $level = 3 ] )
307
- function uncompress( $data )
308
- function compress_dict ( $data, $dict )
309
- function uncompress_dict ( $data, $dict )
310
- function compress_init ( [ $level = 3 ] )
311
- function compress_add ( $context, $data [, $end = false ] )
312
- function uncompress_init ()
313
- function uncompress_add ( $context, $data )
314
-
323
+ function compress( string $data, int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): string|false {}
324
+ function uncompress( string $data ): string|false {}
325
+ function compress_dict ( string $data, string $dict, int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): string|false {}
326
+ function uncompress_dict ( string $data, string $dict ): string|false {}
327
+ function compress_init ( int $level = ZSTD_COMPRESS_LEVEL_DEFAULT ): \Zstd\Compress\Context|false {}
328
+ function compress_add ( \Zstd\Compress\Context $context, string $data, bool $end = false ): string|false {}
329
+ function uncompress_init (): \Zstd\UnCompress\Context|false {}
330
+ function uncompress_add ( \Zstd\UnCompress\Context $context, string $data ): string|false
315
331
```
316
332
317
333
` zstd_compress ` , ` zstd_uncompress ` , ` zstd_compress_dict ` ,
0 commit comments