* You can set this optional parameter to 1, if you * want to search for the file in the include_path too. *
* @return int|false the number of (uncompressed) bytes read from the file, or FALSE on error */ function readgzfile(string $filename, int $use_include_path = 0): int|false {} /** * Rewind the position of a gz-file pointer * @link https://php.net/manual/en/function.gzrewind.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return bool TRUE on success or FALSE on failure. */ function gzrewind($stream): bool {} /** * Close an open gz-file pointer * @link https://php.net/manual/en/function.gzclose.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return bool TRUE on success or FALSE on failure. */ function gzclose($stream): bool {} /** * Test for EOF on a gz-file pointer * @link https://php.net/manual/en/function.gzeof.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return bool TRUE if the gz-file pointer is at EOF or an error occurs; * otherwise returns FALSE. */ function gzeof($stream): bool {} /** * Get character from gz-file pointer * @link https://php.net/manual/en/function.gzgetc.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return string|false The uncompressed character or FALSE on EOF (unlike gzeof). */ function gzgetc($stream): string|false {} /** * Get line from file pointer * @link https://php.net/manual/en/function.gzgets.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @param int|null $length* The length of data to get. *
* @return string|false The uncompressed string, or FALSE on error. */ function gzgets($stream, ?int $length = null): string|false {} /** * Get line from gz-file pointer and strip HTML tags * @link https://php.net/manual/en/function.gzgetss.php * @param resource $zp* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @param int $length [optional]* The length of data to get. *
* @param string $allowable_tags [optional]* You can use this optional parameter to specify tags which should not * be stripped. *
* @return string|false The uncompressed and striped string, or FALSE on error. * @removed 8.0 */ #[Deprecated(since: "7.3")] function gzgetss($zp, int $length, $allowable_tags) {} /** * Binary-safe gz-file read * @link https://php.net/manual/en/function.gzread.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @param int $length* The number of bytes to read. *
* @return string|false The data that have been read. */ function gzread($stream, int $length): string|false {} /** * Open gz-file * @link https://php.net/manual/en/function.gzopen.php * @param string $filename* The file name. *
* @param string $mode* 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.) *
* @param int $use_include_path [optional]* You can set this optional parameter to 1, if you * want to search for the file in the include_path too. *
* @return resource|false 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. * ** If the open fails, the function returns FALSE. */ function gzopen(string $filename, string $mode, int $use_include_path = 0) {} /** * Output all remaining data on a gz-file pointer * @link https://php.net/manual/en/function.gzpassthru.php * @param resource $stream
* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return int The number of uncompressed characters read from gz * and passed through to the input, or FALSE on error. */ function gzpassthru($stream): int {} /** * Seek on a gz-file pointer * @link https://php.net/manual/en/function.gzseek.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @param int $offset* The seeked offset. *
* @param int $whence [optional]* whence values are: * SEEK_SET - Set position equal to offset bytes. * SEEK_CUR - Set position to current location plus offset. *
** If whence is not specified, it is assumed to be * SEEK_SET. *
* @return int Upon success, returns 0; otherwise, returns -1. Note that seeking * past EOF is not considered an error. */ function gzseek($stream, int $offset, int $whence = SEEK_SET): int {} /** * Tell gz-file pointer read/write position * @link https://php.net/manual/en/function.gztell.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @return int|false The position of the file pointer or FALSE if an error occurs. */ function gztell($stream): int|false {} /** * Binary-safe gz-file write * @link https://php.net/manual/en/function.gzwrite.php * @param resource $stream* The gz-file pointer. It must be valid, and must point to a file * successfully opened by gzopen. *
* @param string $data* The string to write. *
* @param int|null $length [optional]* 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. *
** 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. *
* @return int|false the number of (uncompressed) bytes written to the given gz-file * stream. */ function gzwrite($stream, string $data, ?int $length): int|false {} /** * Alias of gzwrite * @link https://php.net/manual/en/function.gzputs.php * @param resource $stream * @param string $data * @param int|null $length [optional] * @return int|false */ function gzputs($stream, string $data, ?int $length): int|false {} /** * Read entire gz-file into an array * @link https://php.net/manual/en/function.gzfile.php * @param string $filename* The file name. *
* @param int $use_include_path [optional]* You can set this optional parameter to 1, if you * want to search for the file in the include_path too. *
* @return array|false An array containing the file, one line per cell. */ function gzfile(string $filename, int $use_include_path = 0): array|false {} /** * Compress a string * @link https://php.net/manual/en/function.gzcompress.php * @param string $data* The data to compress. *
* @param int $level [optional]* The level of compression. Can be given as 0 for no compression up to 9 * for maximum compression. *
** If -1 is used, the default compression of the zlib library is used which is 6. *
* @param int $encoding [optional]* One of ZLIB_ENCODING_* constants. *
* @return string|false The compressed string or FALSE if an error occurred. */ #[Pure] function gzcompress(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_DEFLATE): string|false {} /** * Uncompress a compressed string * @link https://php.net/manual/en/function.gzuncompress.php * @param string $data* The data compressed by gzcompress. *
* @param int $max_length [optional]* The maximum length of data to decode. *
* @return string|false The original uncompressed data or FALSE on error. ** 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. *
*/ #[Pure] function gzuncompress(string $data, int $max_length = 0): string|false {} /** * Deflate a string * @link https://php.net/manual/en/function.gzdeflate.php * @param string $data* The data to deflate. *
* @param int $level [optional]* 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. *
* @param int $encoding [optional]* One of ZLIB_ENCODING_* constants. *
* @return string|false The deflated string or FALSE if an error occurred. */ #[Pure] function gzdeflate(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_RAW): string|false {} /** * Inflate a deflated string * @link https://php.net/manual/en/function.gzinflate.php * @param string $data* The data compressed by gzdeflate. *
* @param int $max_length [optional]* The maximum length of data to decode. *
* @return string|false The original uncompressed data or FALSE on error. ** 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. *
*/ #[Pure] function gzinflate(string $data, int $max_length = 0): string|false {} /** * Create a gzip compressed string * @link https://php.net/manual/en/function.gzencode.php * @param string $data* The data to encode. *
* @param int $level [optional]* 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. *
* @param int $encoding [optional]* The encoding mode. Can be FORCE_GZIP (the default) * or FORCE_DEFLATE. *
** 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. *
** 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. *
* @return string|false The encoded string, or FALSE if an error occurred. */ #[Pure] function gzencode(string $data, int $level = -1, int $encoding = FORCE_GZIP): string|false {} /** * Decodes a gzip compressed string * @link https://php.net/manual/en/function.gzdecode.php * @param string $data* The data to decode, encoded by gzencode. *
* @param int $max_length* The maximum length of data to decode. *
* @return string|false The decoded string, or FALSE if an error occurred. * @since 5.4 */ #[Pure] function gzdecode(string $data, int $max_length = 0): string|false {} /** * Compress data with the specified encoding * @link https://php.net/manual/en/function.zlib-encode.php * @param string $data*
* @param int $encoding*
* @param int $level [optional] default -1*
* @return string|false * @since 5.4 */ #[Pure] function zlib_encode(string $data, int $encoding, int $level = -1): string|false {} /** * Uncompress any raw/gzip/zlib encoded data * @link https://php.net/manual/en/function.zlib-decode.php * @param string $data*
* @param int $max_length*
* @return string|false * @since 5.4 */ #[Pure] function zlib_decode(string $data, int $max_length = 0): string|false {} /** * Returns the coding type used for output compression * @link https://php.net/manual/en/function.zlib-get-coding-type.php * @return string|false Possible return values are gzip, deflate, * or FALSE. */ #[Pure] function zlib_get_coding_type(): string|false {} /** * ob_start callback function to gzip output buffer * @link https://php.net/manual/en/function.ob-gzhandler.php * @param string $data * @param int $flags * @return string|false */ function ob_gzhandler(string $data, int $flags): string|false {} /** * Initialize an incremental deflate context * @link https://php.net/manual/en/function.deflate-init.php * @param int $encoding* One of the ZLIB_ENCODING_* constants. *
* @param array $options* An associative array which may contain the following elements: * levelThe compression level in range -1..9; defaults to -1. * memoryThe compression memory level in range 1..9; defaults to 8. * windowThe zlib window size (logarithmic) in range 8..15; defaults * to 15. strategyOne of ZLIB_FILTERED, ZLIB_HUFFMAN_ONLY, * ZLIB_RLE, ZLIB_FIXED or ZLIB_DEFAULT_STRATEGY (the * default). dictionaryA string or an array of strings of the preset * dictionary (default: no preset dictionary).
* @return resource|false|DeflateContext* Returns a deflate context resource (zlib.deflate) on success, or * FALSE on failure. *
* @since 7.0 */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "DeflateContext|false"], default: "resource|false")] function deflate_init(int $encoding, array $options = []) {} /** * Incrementally deflate data * @link https://php.net/manual/en/function.deflate-add.php * @param DeflateContext|resource $context* A context created with deflate_init(). *
* @param string $data* A chunk of data to compress. *
* @param int $flush_mode [optional]* One of ZLIB_BLOCK, ZLIB_NO_FLUSH, ZLIB_PARTIAL_FLUSH, * ZLIB_SYNC_FLUSH (default), ZLIB_FULL_FLUSH, * ZLIB_FINISH. Normally you will want to set ZLIB_NO_FLUSH to * maximize compression, and ZLIB_FINISH to terminate with * the last chunk of data. *
* @return string|false* Returns a chunk of compressed data, or FALSE on failure. *
* @since 7.0 */ function deflate_add(#[LanguageLevelTypeAware(["8.0" => "DeflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} /** * Initialize an incremental inflate context * @link https://php.net/manual/en/function.inflate-init.php * @param int $encoding* One of the ZLIB_ENCODING_* constants. *
* @param array $options [optional]* An associative array which may contain the following elements: * levelThe compression level in range -1..9; defaults to -1. * memoryThe compression memory level in range 1..9; defaults to 8. * windowThe zlib window size (logarithmic) in range 8..15; defaults * to 15. strategyOne of ZLIB_FILTERED, ZLIB_HUFFMAN_ONLY, * ZLIB_RLE, ZLIB_FIXED or ZLIB_DEFAULT_STRATEGY (the * default). dictionaryA string or an array of strings of the preset * dictionary (default: no preset dictionary).
* @return resource|false|InflateContext* Returns an inflate context resource (zlib.inflate) on success, or * FALSE on failure. *
* @since 7.0 */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "InflateContext|false"], default: "resource|false")] function inflate_init(int $encoding, array $options = []) {} /** * Incrementally inflate encoded data * @link https://php.net/manual/en/function.inflate-add.php * @param InflateContext|resource $context* A context created with inflate_init(). *
* @param string $data* A chunk of compressed data. *
* @param int $flush_mode [optional]* One of ZLIB_BLOCK, ZLIB_NO_FLUSH, ZLIB_PARTIAL_FLUSH, * ZLIB_SYNC_FLUSH (default), ZLIB_FULL_FLUSH, * ZLIB_FINISH. Normally you will want to set ZLIB_NO_FLUSH to * maximize compression, and ZLIB_FINISH to terminate with * the last chunk of data. *
* @return string|false* Returns a chunk of uncompressed data, or FALSE on failure. *
* @since 7.0 */ function inflate_add(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} /** * Get number of bytes read so far * @param InflateContext|resource $context * @return int * @since 7.2 */ #[Pure] function inflate_get_read_len(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int {} /** * Get decompression status * @param InflateContext|resource $context * @return int * @since 7.2 */ #[Pure] function inflate_get_status(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int {} /** * @since 8.0 */ final class InflateContext { /** * Use inflate_init() instead * @see inflate_init() */ private function __construct() {} } /** * @since 8.0 */ final class DeflateContext { /** * Use deflate_init() instead * @see deflate_init() */ private function __construct() {} } define('FORCE_GZIP', 31); define('FORCE_DEFLATE', 15); /** @link https://php.net/manual/en/zlib.constants.php */ define('ZLIB_ENCODING_RAW', -15); /** @link https://php.net/manual/en/zlib.constants.php */ define('ZLIB_ENCODING_GZIP', 31); /** @link https://php.net/manual/en/zlib.constants.php */ define('ZLIB_ENCODING_DEFLATE', 15); define('ZLIB_NO_FLUSH', 0); define('ZLIB_PARTIAL_FLUSH', 1); define('ZLIB_SYNC_FLUSH', 2); define('ZLIB_FULL_FLUSH', 3); define('ZLIB_BLOCK', 5); define('ZLIB_FINISH', 4); define('ZLIB_FILTERED', 1); define('ZLIB_HUFFMAN_ONLY', 2); define('ZLIB_RLE', 3); define('ZLIB_FIXED', 4); define('ZLIB_DEFAULT_STRATEGY', 0); define('ZLIB_OK', 0); define('ZLIB_STREAM_END', 1); define('ZLIB_NEED_DICT', 2); define('ZLIB_ERRNO', -1); define('ZLIB_STREAM_ERROR', -2); define('ZLIB_DATA_ERROR', -3); define('ZLIB_MEM_ERROR', -4); define('ZLIB_BUF_ERROR', -5); define('ZLIB_VERSION_ERROR', -6); define('ZLIB_VERSION', 'zlib_version_string'); // This is set to the zlib version define('ZLIB_VERNUM', 'zlib_version_string'); // This is set to the zlib version