rafalmasiarek / dashboard-kit-addon-compress
HTML output compression middleware for rafalmasiarek/dashboard-kit. Strips whitespace and comments while preserving script, pre and textarea blocks.
Package info
github.com/rafalmasiarek/php-dashboard-kit-addon-compress
pkg:composer/rafalmasiarek/dashboard-kit-addon-compress
Requires
- php: >=8.2
- rafalmasiarek/dashboard-kit: *
- slim/psr7: ^1
- slim/slim: ^4
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-11-17 23:37:12 UTC
README
HTML output compression middleware for rafalmasiarek/dashboard-kit.
Collapses whitespace and strips HTML comments from every text/html response. Sensitive blocks (<script>, <style>, <pre>, <textarea>) are preserved verbatim.
License
Business Source License 1.1.
Source available; commercial use restricted until 2099-01-01.
See LICENSE for full details.
For alternative licensing, contact us.
Authors
Installation
composer require rafalmasiarek/dashboard-kit-addon-compress
Requires PHP 8.2+, slim/slim ^4, and slim/psr7 ^1.
Usage
Configure the addon in Dashboard::create() under the compress key, then register it:
$dashboard = Dashboard::create(__DIR__ . '/../', [ // ... 'compress' => [ 'enabled' => true, 'exclude' => ['/api/'], ], ]); CompressAddon::register($dashboard->getApp(), $dashboard->getContainer());
Configuration options
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
bool |
true |
Set to false to disable compression entirely (e.g. on dev) |
exclude |
string[] |
[] |
Request paths matching any pattern pass through unmodified |
exclude supports two pattern types:
'exclude' => [ '/api/', // prefix match — any path starting with /api/ '~^/debug/~', // regex match — strings starting with ~ are treated as regexes ],
What gets compressed
- Whitespace between adjacent tags (
> <→><) - Runs of two or more whitespace characters collapsed to a single space
- HTML comments stripped (except IE conditional comments
<!--[if ...]>)
What is preserved
The following blocks are extracted before compression and restored afterwards — their content is never modified:
| Block | Reason |
|---|---|
<script>...</script> |
JavaScript is whitespace-sensitive |
<style>...</style> |
CSS is whitespace-sensitive |
<pre>...</pre> |
Preformatted text, whitespace is meaningful |
<textarea>...</textarea> |
User-visible whitespace |
Opting out of compression
Wrap any section of HTML with <!-- compress:off --> / <!-- compress:on --> to exclude it from compression:
<!-- compress:off --> <pre class="my-indented-block"> line one line two </pre> <!-- compress:on -->
The entire block (including the directive comments) is preserved byte-for-byte. Any <script> or <style> tags inside a compress:off block are also preserved as part of that block and are not separately extracted.
Content-type filtering
Only responses where Content-Type contains text/html are processed. JSON, redirects (empty body), binary assets, and all other response types pass through untouched.
Index
Classes
CompressAddon—rafalmasiarek\DashboardKitCompressHtmlCompressMiddleware—rafalmasiarek\DashboardKitCompress
CompressAddon
final class — rafalmasiarek\DashboardKitCompress\CompressAddon · source
Registers HTML output compression for a dashboard-kit application. Adds HtmlCompressMiddleware to the Slim application. Configuration is read from the 'compress' key of app.config in the container: Dashboard::create(DIR . '/../', [ 'compress' => [ 'enabled' => true, 'exclude' => ['/api/', '^/debug/'], ], ]);
| Method | Visibility | Returns | Summary |
|---|---|---|---|
register() |
public static | void |
Add the HTML compression middleware to the Slim application. |
register()
CompressAddon register()
public static function register(App $app, ContainerInterface $container): void
Add the HTML compression middleware to the Slim application.
| Param | Type | Description |
|---|---|---|
$app |
App |
Slim application instance. |
$container |
ContainerInterface |
PHP-DI container. |
HtmlCompressMiddleware
final class — rafalmasiarek\DashboardKitCompress\HtmlCompressMiddleware · source
Compresses HTML responses by collapsing whitespace and stripping comments. Blocks where whitespace is significant are extracted before compression and restored afterwards: <script>, <style>,
, <textarea>. Only responses with a text/html Content-Type are processed. All other responses (JSON, redirects, binary) pass through untouched.implements
MiddlewareInterface
| Property | Type | Visibility | Description |
|---|---|---|---|
$config |
array{enabled: bool, exclude: list<string>} |
private | Merged configuration. |
| Method | Visibility | Returns | Summary |
|---|---|---|---|
__construct() |
public | — | — |
process() |
public | ResponseInterface |
Process the request and compress the HTML response body. |
compress() |
private static | string |
Compress an HTML string. Steps: 1. Extract ... blocks (highest priority, content is preserved byte-for-byte including any tags inside). 2. Extract <script>, <style>, , <textarea> blocks into placeholders. 3. Strip HTML comments (IE conditional comments <!--[if ...]> are preserved). 4. Collapse whitespace between adjacent tags. 5. Collapse runs of whitespace within text/attribute content to a single space. 6. Remove whitespace at placeholder boundaries (gaps left by steps 4/5). 7. Restore all extracted blocks. |
__construct()
HtmlCompressMiddleware __construct()
public function __construct(array $config)
| Param | Type | Description |
|---|---|---|
$config |
array{enabled?: bool, exclude?: list<string>} |
enabled — set to false to disable compression entirely (e.g. on dev). exclude — list of path patterns to skip. Plain strings are matched as path prefixes; strings prefixed with ~ are treated as regexes (e.g. ' |
process()
HtmlCompressMiddleware process()
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
Process the request and compress the HTML response body.
| Param | Type | Description |
|---|---|---|
$request |
ServerRequestInterface |
— |
$handler |
RequestHandlerInterface |
— |
Returns: ResponseInterface
compress()
HtmlCompressMiddleware compress()
private static function compress(string $html): string
Compress an HTML string. Steps: 1. Extract ... blocks (highest priority, content is preserved byte-for-byte including any tags inside). 2. Extract <script>, <style>,
, <textarea> blocks into placeholders. 3. Strip HTML comments (IE conditional comments <!--[if ...]> are preserved). 4. Collapse whitespace between adjacent tags. 5. Collapse runs of whitespace within text/attribute content to a single space. 6. Remove whitespace at placeholder boundaries (gaps left by steps 4/5). 7. Restore all extracted blocks.
| Param | Type | Description |
|---|---|---|
$html |
string |
Raw HTML. |
Returns: string — Compressed HTML.