File: zlib.php

package info (click to toggle)
codelite 12.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 95,112 kB
  • sloc: cpp: 424,040; ansic: 18,284; php: 9,569; lex: 4,186; yacc: 2,820; python: 2,294; sh: 312; makefile: 51; xml: 13
file content (414 lines) | stat: -rw-r--r-- 13,347 bytes parent folder | download | duplicates (6)
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<?php

// Start of zlib v.2.0

/**
 * Output a gz-file
 * @link http://www.php.net/manual/en/function.readgzfile.php
 * @param filename string <p>
 *       The file name. This file will be opened from the filesystem and its
 *       contents written to standard output.
 *      </p>
 * @param use_include_path int[optional] <p>
 *       You can set this optional parameter to 1, if you
 *       want to search for the file in the include_path too.
 *      </p>
 * @return int the number of (uncompressed) bytes read from the file. If
 *   an error occurs, false is returned and unless the function was
 *   called as @readgzfile, an error message is
 *   printed.
 */
function readgzfile ($filename, $use_include_path = null) {}

/**
 * Rewind the position of a gz-file pointer
 * @link http://www.php.net/manual/en/function.gzrewind.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return bool Returns true on success, false on failure.
 */
function gzrewind ($zp) {}

/**
 * Close an open gz-file pointer
 * @link http://www.php.net/manual/en/function.gzclose.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return bool Returns true on success, false on failure.
 */
function gzclose ($zp) {}

/**
 * Test for <acronym>EOF</acronym> on a gz-file pointer
 * @link http://www.php.net/manual/en/function.gzeof.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return int true if the gz-file pointer is at EOF or an error occurs;
 *   otherwise returns false.
 */
function gzeof ($zp) {}

/**
 * Get character from gz-file pointer
 * @link http://www.php.net/manual/en/function.gzgetc.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return string The uncompressed character or false on EOF (unlike gzeof).
 */
function gzgetc ($zp) {}

/**
 * Get line from file pointer
 * @link http://www.php.net/manual/en/function.gzgets.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @param length int[optional] <p>
 *       The length of data to get.
 *      </p>
 * @return string The uncompressed string, or false on error.
 */
function gzgets ($zp, $length = null) {}

/**
 * Get line from gz-file pointer and strip HTML tags
 * @link http://www.php.net/manual/en/function.gzgetss.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @param length int <p>
 *       The length of data to get.
 *      </p>
 * @param allowable_tags string[optional] <p>
 *       You can use this optional parameter to specify tags which should not 
 *       be stripped.
 *      </p>
 * @return string The uncompressed and stripped string, or false on error.
 */
function gzgetss ($zp, $length, $allowable_tags = null) {}

/**
 * Binary-safe gz-file read
 * @link http://www.php.net/manual/en/function.gzread.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @param length int <p>
 *       The number of bytes to read.
 *      </p>
 * @return string The data that have been read.
 */
function gzread ($zp, $length) {}

/**
 * Open gz-file
 * @link http://www.php.net/manual/en/function.gzopen.php
 * @param filename string <p>
 *       The file name.
 *      </p>
 * @param mode string <p>
 *       As in fopen (rb or 
 *       wb) but can also include a compression level 
 *       (wb9) or a strategy: f for
 *       filtered data as in wb6f, h for
 *       Huffman only compression as in wb1h.
 *       (See the description of deflateInit2
 *       in zlib.h for 
 *       more information about the strategy parameter.)
 *      </p>
 * @param use_include_path int[optional] <p>
 *       You can set this optional parameter to 1, if you
 *       want to search for the file in the include_path too.
 *      </p>
 * @return resource a file pointer to the file opened, after that, everything you read
 *   from this file descriptor will be transparently decompressed and what you 
 *   write gets compressed.
 *  </p>
 *  <p>
 *   If the open fails, the function returns false.
 */
function gzopen ($filename, $mode, $use_include_path = null) {}

/**
 * Output all remaining data on a gz-file pointer
 * @link http://www.php.net/manual/en/function.gzpassthru.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return int The number of uncompressed characters read from gz
 *   and passed through to the input, or false on error.
 */
function gzpassthru ($zp) {}

/**
 * Seek on a gz-file pointer
 * @link http://www.php.net/manual/en/function.gzseek.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @param offset int <p>
 *       The seeked offset.
 *      </p>
 * @param whence int[optional] <p>
 *       whence values are:
 *       
 *        SEEK_SET - Set position equal to offset bytes.
 *        SEEK_CUR - Set position to current location plus offset.
 *       
 *      </p>
 *      <p>
 *       If whence is not specified, it is assumed to be
 *       SEEK_SET.
 *      </p>
 * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking
 *   past EOF is not considered an error.
 */
function gzseek ($zp, $offset, $whence = null) {}

/**
 * Tell gz-file pointer read/write position
 * @link http://www.php.net/manual/en/function.gztell.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @return int The position of the file pointer or false if an error occurs.
 */
function gztell ($zp) {}

/**
 * Binary-safe gz-file write
 * @link http://www.php.net/manual/en/function.gzwrite.php
 * @param zp resource <p>
 *       The gz-file pointer. It must be valid, and must point to a file
 *       successfully opened by gzopen.
 *      </p>
 * @param string string <p>
 *       The string to write.
 *      </p>
 * @param length int[optional] <p>
 *       The number of uncompressed bytes to write. If supplied, writing will 
 *       stop after length (uncompressed) bytes have been
 *       written or the end of string is reached,
 *       whichever comes first.
 *      </p>
 *      
 *       <p>
 *        Note that if the length argument is given,
 *        then the magic_quotes_runtime
 *        configuration option will be ignored and no slashes will be
 *        stripped from string.
 *       </p>
 * @return int the number of (uncompressed) bytes written to the given gz-file 
 *   stream.
 */
function gzwrite ($zp, $string, $length = null) {}

/**
 * &Alias; <function>gzwrite</function>
 * @link http://www.php.net/manual/en/function.gzputs.php
 * @param fp
 * @param str
 * @param length[optional]
 */
function gzputs ($fp, $str, $length) {}

/**
 * Read entire gz-file into an array
 * @link http://www.php.net/manual/en/function.gzfile.php
 * @param filename string <p>
 *       The file name.
 *      </p>
 * @param use_include_path int[optional] <p>
 *       You can set this optional parameter to 1, if you
 *       want to search for the file in the include_path too.
 *      </p>
 * @return array An array containing the file, one line per cell.
 */
function gzfile ($filename, $use_include_path = null) {}

/**
 * Compress a string
 * @link http://www.php.net/manual/en/function.gzcompress.php
 * @param data string <p>
 *       The data to compress.
 *      </p>
 * @param level int[optional] <p>
 *       The level of compression. Can be given as 0 for no compression up to 9
 *       for maximum compression.
 *      </p>
 *      <p>
 *       If -1 is used, the default compression of the zlib library is used which is 6.
 *      </p>
 * @param encoding int[optional] <p>
 *       One of ZLIB_ENCODING_* constants.
 *      </p>
 * @return string The compressed string or false if an error occurred.
 */
function gzcompress ($data, $level = null, $encoding = null) {}

/**
 * Uncompress a compressed string
 * @link http://www.php.net/manual/en/function.gzuncompress.php
 * @param data string <p>
 *       The data compressed by gzcompress.
 *      </p>
 * @param length int[optional] <p>
 *       The maximum length of data to decode.
 *      </p>
 * @return string The original uncompressed data or false on error.
 *  </p>
 *  <p>
 *   The function will return an error if the uncompressed data is more than
 *   32768 times the length of the compressed input data 
 *   or more than the optional parameter length.
 */
function gzuncompress ($data, $length = null) {}

/**
 * Deflate a string
 * @link http://www.php.net/manual/en/function.gzdeflate.php
 * @param data string <p>
 *       The data to deflate.
 *      </p>
 * @param level int[optional] <p>
 *       The level of compression. Can be given as 0 for no compression up to 9
 *       for maximum compression. If not given, the default compression level will
 *       be the default compression level of the zlib library.
 *      </p>
 * @param encoding int[optional] <p>
 *       One of ZLIB_ENCODING_* constants.
 *      </p>
 * @return string The deflated string or false if an error occurred.
 */
function gzdeflate ($data, $level = null, $encoding = null) {}

/**
 * Inflate a deflated string
 * @link http://www.php.net/manual/en/function.gzinflate.php
 * @param data string <p>
 *       The data compressed by gzdeflate.
 *      </p>
 * @param length int[optional] <p>
 *       The maximum length of data to decode.
 *      </p>
 * @return string The original uncompressed data or false on error.
 *  </p>
 *  <p>
 *   The function will return an error if the uncompressed data is more than
 *   32768 times the length of the compressed input data 
 *   or more than the optional parameter length.
 */
function gzinflate ($data, $length = null) {}

/**
 * Create a gzip compressed string
 * @link http://www.php.net/manual/en/function.gzencode.php
 * @param data string <p>
 *       The data to encode.
 *      </p>
 * @param level int[optional] <p>
 *       The level of compression. Can be given as 0 for no compression up to 9
 *       for maximum compression. If not given, the default compression level will
 *       be the default compression level of the zlib library.
 *      </p>
 * @param encoding_mode int[optional] <p>
 *       The encoding mode. Can be FORCE_GZIP (the default)
 *       or FORCE_DEFLATE. 
 *      </p>
 *      <p>
 *       Prior to PHP 5.4.0, using FORCE_DEFLATE results in
 *       a standard zlib deflated string (inclusive zlib headers) after a gzip
 *       file header but without the trailing crc32 checksum.
 *      </p>
 *      <p>
 *       In PHP 5.4.0 and later, FORCE_DEFLATE generates
 *       RFC 1950 compliant output, consisting of a zlib header, the deflated
 *       data, and an Adler checksum.
 *      </p>
 * @return string The encoded string, or false if an error occurred.
 */
function gzencode ($data, $level = null, $encoding_mode = null) {}

/**
 * Decodes a gzip compressed string
 * @link http://www.php.net/manual/en/function.gzdecode.php
 * @param data string <p>
 *       The data to decode, encoded by gzencode.
 *      </p>
 * @param length int[optional] <p>
 *       The maximum length of data to decode.
 *      </p>
 * @return string The decoded string, or false if an error occurred.
 */
function gzdecode ($data, $length = null) {}

/**
 * Compress data with the specified encoding
 * @link http://www.php.net/manual/en/function.zlib-encode.php
 * @param data string <p>
 *      
 *     </p>
 * @param encoding string <p>
 *      
 *     </p>
 * @param level string[optional] <p>
 *      
 *     </p>
 * @return string 
 */
function zlib_encode ($data, $encoding, $level = null) {}

/**
 * Uncompress any raw/gzip/zlib encoded data
 * @link http://www.php.net/manual/en/function.zlib-decode.php
 * @param data string <p>
 *      
 *     </p>
 * @param max_decoded_len string[optional] <p>
 *      
 *     </p>
 * @return string 
 */
function zlib_decode ($data, $max_decoded_len = null) {}

/**
 * Returns the coding type used for output compression
 * @link http://www.php.net/manual/en/function.zlib-get-coding-type.php
 * @return string Possible return values are gzip, deflate,
 *   or false.
 */
function zlib_get_coding_type () {}

/**
 * ob_start callback function to gzip output buffer
 * @link http://www.php.net/manual/en/function.ob-gzhandler.php
 * @param buffer string <p>
 *      </p>
 * @param mode int <p>
 *      </p>
 * @return string 
 */
function ob_gzhandler ($buffer, $mode) {}

define ('FORCE_GZIP', 31);
define ('FORCE_DEFLATE', 15);
define ('ZLIB_ENCODING_RAW', -15);
define ('ZLIB_ENCODING_GZIP', 31);
define ('ZLIB_ENCODING_DEFLATE', 15);

// End of zlib v.2.0
?>