* Similar to the fopen function, only 'r' (read) * and 'w' (write) are supported. Everything else will cause bzopen * to return FALSE. *
* @return resource|false If the open fails, bzopen returns FALSE, otherwise * it returns a pointer to the newly opened file. */ #[Pure] function bzopen($file, string $mode) {} /** * Binary safe bzip2 file read * @link https://php.net/manual/en/function.bzread.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @param int<1024, 8192> $length [optional]* If not specified, bzread will read 1024 * (uncompressed) bytes at a time. A maximum of 8192 * uncompressed bytes will be read at a time. *
* @return string|false the uncompressed data, or FALSE on error. */ function bzread($bz, int $length = 1024): string|false {} /** * Binary safe bzip2 file write * @link https://php.net/manual/en/function.bzwrite.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @param string $data* The written data. *
* @param int|null $length [optional]* If supplied, writing will stop after length * (uncompressed) bytes have been written or the end of * data is reached, whichever comes first. *
* @return int|false the number of bytes written, or FALSE on error. */ function bzwrite($bz, string $data, ?int $length): int|false {} /** * Force a write of all buffered data * @link https://php.net/manual/en/function.bzflush.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @return bool TRUE on success or FALSE on failure. */ function bzflush($bz): bool {} /** * Close a bzip2 file * @link https://php.net/manual/en/function.bzclose.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @return bool TRUE on success or FALSE on failure. */ function bzclose($bz): bool {} /** * Returns a bzip2 error number * @link https://php.net/manual/en/function.bzerrno.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @return int the error number as an integer. */ #[Pure] #[LanguageLevelTypeAware(['8.1' => 'int', '8.0' => 'int|false'], default: 'int')] function bzerrno($bz) {} /** * Returns a bzip2 error string * @link https://php.net/manual/en/function.bzerrstr.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @return string a string containing the error message. */ #[Pure] #[LanguageLevelTypeAware(['8.1' => 'string', '8.0' => 'string|false'], default: 'string')] function bzerrstr($bz) {} /** * Returns the bzip2 error number and error string in an array * @link https://php.net/manual/en/function.bzerror.php * @param resource $bz* The file pointer. It must be valid and must point to a file * successfully opened by bzopen. *
* @return array an associative array, with the error code in the * errno entry, and the error message in the * errstr entry. */ #[Pure] #[LanguageLevelTypeAware(['8.1' => 'array', '8.0' => 'array|false'], default: 'array')] #[ArrayShape(["errno" => "int", "errstr" => "string"])] function bzerror($bz) {} /** * Compress a string into bzip2 encoded data * @link https://php.net/manual/en/function.bzcompress.php * @param string $data* The string to compress. *
* @param int $block_size* Specifies the blocksize used during compression and should be a number * from 1 to 9 with 9 giving the best compression, but using more * resources to do so. *
* @param int $work_factor [optional]* Controls how the compression phase behaves when presented with worst * case, highly repetitive, input data. The value can be between 0 and * 250 with 0 being a special case. *
** Regardless of the workfactor, the generated * output is the same. *
* @return string|int The compressed string, or an error number if an error occurred. */ #[Pure] function bzcompress( string $data, #[PhpStormStubsElementAvailable(from: '5.3', to: '7.0')] int $blocksize, #[PhpStormStubsElementAvailable(from: '7.1')] int $block_size = 4, int $work_factor = 0 ): string|int {} /** * Decompresses bzip2 encoded data * @link https://php.net/manual/en/function.bzdecompress.php * @param string $data* The string to decompress. *
* @param bool $use_less_memory [optional]* If TRUE, an alternative decompression algorithm will be used which * uses less memory (the maximum memory requirement drops to around 2300K) * but works at roughly half the speed. *
** See the bzip2 documentation for more * information about this feature. *
* @return string|int|false The decompressed string, or an error number if an error occurred. */ #[Pure] function bzdecompress(string $data, bool $use_less_memory = false): string|int|false {}