百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
P

php-ext-brotli

> 编程语言
开源

适用于 PHP 的 Brotli 扩展

200 stars0 点赞1 次浏览
访问官网GitHub

工具介绍

适用于 PHP 的 Brotli 扩展

Brotli Extension for PHP

This extension allows Brotli compression.

Documentation for Brotli can be found at » 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 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 11 PHP_INI_ALL
brotli.output_compression_exclude_types "" PHP_INI_ALL
brotli.output_compression_dict "" 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 BROTLI_COMPRESS_LEVEL_DEFAULT (11).

  • brotli.output_compression_exclude_types string

    The extension contains a built-in list of non-compressible MIME types. The list can be found in the phpinfo() output. If something is missing, more MIME types can be added with this ini setting.

    Comma-separated list of MIME types that should not be compressed by the transparent output handler.

    Supports exact MIME type matches and wildcard family matches. A wildcard entry must use the type/* form.

    Example (both of these are already in the built-in list):

    ini
    brotli.output_compression_exclude_types="video/*,application/pdf"

    This is useful for already-compressed binary formats where additional Brotli compression usually provides little benefit.

    A token prefixed with ! negates a match: it makes the extension compress that MIME type even if it is in the built-in exclusion list. Negation also supports exact matches and type/* wildcards. Since ! is a special character in php.ini, values that use it must be quoted.

    ini
    brotli.output_compression_exclude_types="!image/png"

    Within the same list, if a MIME type matches multiple tokens, the last matching token wins, regardless of whether it is positive or negative (the same precedence rule .gitignore uses). This allows patterns such as:

    ini
    brotli.output_compression_exclude_types="image/*,!image/png"

    which excludes all image/* types except image/png, since the negation is listed after the wildcard.

    Negation only applies within this setting: if it doesn't produce a definitive match for the current MIME type, the built-in list is still consulted. The built-in list's contents can be seen in the phpinfo() output.

  • brotli.output_compression_dict string

    Specifies the path to the compressed dictionary file to be used by the output handler.

    can be used when BROTLI_DICTIONARY_SUPPORT is enabled

Constant

Name Description
BROTLI_GENERIC Generic compress mode value
BROTLI_TEXT Text compress mode value
BROTLI_FONT Font compress mode value
BROTLI_COMPRESS_LEVEL_MIN Minimal compress level value
BROTLI_COMPRESS_LEVEL_MAX Maximal compress level value
BROTLI_COMPRESS_LEVEL_DEFAULT Default compress level value
BROTLI_PROCESS Incremental process mode value
BROTLI_FLUSH Incremental produce mode value
BROTLI_FINISH Incremental finalize mode value
BROTLI_DICTIONARY_SUPPORT Dictionary support value

BROTLI_DICTIONARY_SUPPORT must be enabled with brotli library version 1.1.0 or higher

dictionary only work from compression level 5 or higher note

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

php
brotli_compress ( string $data, int $level = BROTLI_COMPRESS_LEVEL_DEFAULT, int $mode = BROTLI_GENERIC, string|null $dict = null ): string|false

This function compress a string.

Parameters

  • data

    The data to compress.

  • level

    The higher the level, 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).

  • dict

    The dictionary data.

    can be used when BROTLI_DICTIONARY_SUPPORT is enabled

Return Values

The compressed string or FALSE if an error occurred.


brotli_uncompress — Uncompress a compressed string

Description

php
brotli_uncompress ( string $data, string|null $dict = null ): string|false

This function uncompress a compressed string.

Parameters

  • data

    The data compressed by brotli_compress().

  • dict

    The dictionary data.

    can be used when BROTLI_DICTIONARY_SUPPORT is enabled

Return Values

The original uncompressed data or FALSE on error.


brotli_compress_init — Initialize an incremental compress context

Description

php
brotli_compress_init ( int $level = BROTLI_COMPRESS_LEVEL_DEFAULT, int $mode = BROTLI_GENERIC, string|null $dict = null ): Brotli\Compress\Context|false

Initialize an incremental compress context.

Parameters

  • level

    The higher the level, 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).

  • dict

    The dictionary data.

    can be used when BROTLI_DICTIONARY_SUPPORT is enabled

Return Values

Returns a Brotli\Compress\Context instance on success, or FALSE on failure.


brotli_compress_add — Incrementally compress data

Description

php
brotli_compress_add ( Brotli\Compress\Context $context, string $data, $mode = BROTLI\_FLUSH ): string|false

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

php
brotli_uncompress_init ( string|null $dict = null ): Brotli\UnCompress\Context|false

Initialize an incremental uncompress context.

Parameters

  • dict

    The dictionary data.

    can be used when BROTLI_DICTIONARY_SUPPORT is enabled

Return Values

Returns a Brotli\UnCompress\Context instance on success, or FALSE on failure.


brotli_uncompress_add — Incrementally uncompress data

Description

php
brotli_uncompress_add ( Brotli\UnCompress\Context $context, string $data, $mode = BROTLI\_FLUSH ): string|false

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

…

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:///path/to/data.br", $data);
readfile("compress.brotli:///path/to/data.br");

Incrementally

…

Dictionary

…

Experimental: Compression Dictionary Transport support

must be specified headers.

  • Accept-Encoding: dcb
  • Available-Dictionary: ::

Issues· 12 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

C

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月18日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言