Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kjdev/php-ext-brotli
Brotli Extension for PHP
https://github.com/kjdev/php-ext-brotli
Last synced: 4 days ago
JSON representation
Brotli Extension for PHP
- Host: GitHub
- URL: https://github.com/kjdev/php-ext-brotli
- Owner: kjdev
- License: mit
- Created: 2015-09-25T04:05:07.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T21:21:33.000Z (about 2 months ago)
- Last Synced: 2024-12-30T23:14:28.476Z (11 days ago)
- Language: C
- Size: 204 KB
- Stars: 179
- Watchers: 14
- Forks: 29
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Brotli Extension for PHP
[](https://github.com/kjdev/php-ext-brotli/actions?query=workflow%3ALinux+branch%3Amaster)
[](https://github.com/kjdev/php-ext-brotli/actions?query=workflow%3AWindows+branch%3Amaster)
This extension allows Brotli compression.
Documentation for Brotli can be found at
[» https://github.com/google/brotli/](https://github.com/google/brotli/).
## Build
```
% git clone --recursive --depth=1 https://github.com/kjdev/php-ext-brotli.git
% cd php-ext-brotli
% phpize
% ./configure
% make
$ make install
```
To use the system library (using pkg-config)
``` bash
% ./configure --with-libbrotli
```
## Distribution binary packages
### Fedora / CentOS / RHEL
RPM packages of this extension are available in [» Remi's RPM repository](https://rpms.remirepo.net/) and are named **php-brotli**.
## Configuration
php.ini:
```
extension=brotli.so
```
### Output handler option
Name | Default | Changeable
--------------------------------- | ------- | ----------
brotli.output\_compression | 0 | PHP\_INI\_ALL
brotli.output\_compression\_level | -1 | PHP\_INI\_ALL
* brotli.output\_compression _boolean_
Whether to transparently compress pages.
If this option is set to "On" in php.ini or the Apache configuration,
pages are compressed if the browser sends an "Accept-Encoding: br" header.
"Content-Encoding: br" and "Vary: Accept-Encoding" headers are added to
the output. In runtime, it can be set only before sending any output.
* brotli.output\_compression\_level _integer_
Compression level used for transparent output compression.
Specify a value between 0 to 11.
The default value of -1 uses internally defined values (11).
## Constant
Name | Description
--------------------------------- | -----------
BROTLI\_COMPRESS\_LEVEL\_MIN | Minimal compress level value
BROTLI\_COMPRESS\_LEVEL\_MAX | Maximal compress level value
BROTLI\_COMPRESS\_LEVEL\_DEFAULT | Default compress level value
## Function
* brotli\_compress — Compress a string
* brotli\_uncompress — Uncompress a compressed string
* brotli\_compress\_init — Initialize an incremental compress context
* brotli\_compress\_add — Incrementally compress data
* brotli\_uncompress\_init — Initialize an incremental uncompress context
* brotli\_uncompress\_add — Incrementally uncompress data
---
### brotli\_compress — Compress a string
#### Description
string **brotli\_compress** ( string _$data_ [, int _$quality_ = BROTLI\_COMPRESS\_LEVEL\_DEFAULT, int _$mode_ = BROTLI\_GENERIC ] )
This function compress a string.
#### Parameters
* _data_
The data to compress.
* _quality_
The higher the quality, the slower the compression.
(Defaults to `BROTLI\_COMPRESS\_LEVEL\_DEFAULT`)
* _mode_
The compression mode can be `BROTLI_GENERIC` (default),
`BROTLI_TEXT` (for UTF-8 format text input) or `BROTLI_FONT` (for WOFF 2.0).
#### Return Values
The compressed string or FALSE if an error occurred.
---
### brotli\_uncompress — Uncompress a compressed string
#### Description
string **brotli\_uncompress** ( string _$data_ [, int _$length_ = 0 ] )
This function uncompress a compressed string.
#### Parameters
* _data_
The data compressed by brotli\_compress().
* _length_
The maximum length of data to decode.
#### Return Values
The original uncompressed data or FALSE on error.
---
### brotli\_compress\_init — Initialize an incremental compress context
#### Description
resource **brotli\_compress\_init** ( [ int _$quality_ = BROTLI\_COMPRESS\_LEVEL\_DEFAULT, int _$mode_ = BROTLI\_GENERIC ] )
Initialize an incremental compress context.
#### Parameters
* _quality_
The higher the quality, the slower the compression.
(Defaults to `BROTLI\_COMPRESS\_LEVEL\_DEFAULT`)
* _mode_
The compression mode can be `BROTLI_GENERIC` (default),
`BROTLI_TEXT` (for UTF-8 format text input) or `BROTLI_FONT` (for WOFF 2.0).
#### Return Values
Returns a brotli context resource (brotli.state) on success,
or FALSE on failure.
---
### brotli\_compress\_add — Incrementally compress data
#### Description
string **brotli\_compress\_add** ( resource _$context_, string _$data_ [, _$mode_ = BROTLI\_FLUSH ] )
Incrementally compress data.
#### Parameters
* _context_
A context created with `brotli_compress_init()`.
* _data_
A chunk of data to compress.
* _mode_
One of `BROTLI_FLUSH` (default) and `BROTLI_PROCESS`, `BROTLI_FINISH`.
`BROTLI_FINISH` to terminate with the last chunk of data.
#### Return Values
Returns a chunk of compressed data, or FALSE on failure.
---
### brotli\_uncompress\_init — Initialize an incremental uncompress context
#### Description
resource **brotli\_uncompress\_init** ( void )
Initialize an incremental uncompress context.
#### Return Values
Returns a brotli context resource (brotli.state) on success,
or FALSE on failure.
---
### brotli\_uncompress\_add — Incrementally uncompress data
#### Description
string **brotli\_uncompress\_add** ( resource _$context_, string _$data_ [, _$mode_ = BROTLI\_FLUSH ] )
Incrementally uncompress data.
#### Parameters
* _context_
A context created with `brotli_uncompress_init()`.
* _data_
A chunk of compressed data.
* _mode_
One of `BROTLI_FLUSH` (default) and `BROTLI_PROCESS`, `BROTLI_FINISH`.
`BROTLI_FINISH` to terminate with the last chunk of data.
#### Return Values
Returns a chunk of uncompressed data, or FALSE on failure.
## Namespace
```
Namespace Brotli;
function compress( $data [, $quality = \\BROTLI\_COMPRESS\_LEVEL\_DEFAULT, $mode = \\BROTLI\_GENERIC ] )
function uncompress( $data [, $length = 0 ] )
function compress\_init( [ $quality = \\BROTLI\_COMPRESS\_LEVEL\_DEFAULT, $mode = \\BROTLI\_GENERIC ] )
function compress\_add( resource $context, string $data [, $mode = \\BROTLI\_FLUSH] )
function uncompress\_init()
function uncompress\_add( resource $context, string $data [, $mode = \\BROTLI\_FLUSH] )
```
alias functions..
## Streams
Brotli compression and uncompression are available using the
`compress.brotli://` stream prefix.
## Examples
``` php
$compressed = brotli_compress('Compresstest');
$uncompressed = brotli_uncompress($compressed);
echo $uncompressed;
```
### Output handler
``` php
ini_set('brotli.output_compression', 'On');
// OR
// ob_start('ob_brotli_handler');
echo ...;
```
> "Accept-Encoding: br" must be specified.
### Namespace
``` php
$data = \Brotli\compress('test');
\Brotli\uncompress($data);
```
### Streams
``` php
file_put_contents("compress.brotli:///patch/to/data.br", $data);
readfile("compress.brotli:///patch/to/data.br");
```
### Incrementally
```php
// compression
$resource = brotli_compress_init();
$compressed = '';
$compressed .= brotli_compress_add($resource, 'Hello, ', BROTLI_FLUSH);
$compressed .= brotli_compress_add($resource, 'World!', BROTLI_FLUSH);
$compressed .= brotli_compress_add($resource, '', BROTLI_FINISH);
echo brotli_uncompress($compressed), PHP_EOL; // Hello, World!
// uncompression
$resource = brotli_uncompress_init();
$uncompressed = '';
$uncompressed .= brotli_uncompress_add($resource, substr($compressed, 0, 5), BROTLI_FLUSH);
$uncompressed .= brotli_uncompress_add($resource, substr($compressed, 5), BROTLI_FLUSH);
$uncompressed .= brotli_uncompress_add($resource, '', BROTLI_FINISH);
echo $uncompressed, PHP_EOL; // Hello, World!
```