README

CakePHP 4, HTML Minify Plugin

Installation

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ~.

composer require wyrihaximus/minify-html

Bootstrap

Plugins are loaded in your application’s bootstrap() function:

// In src/Application.php
use Cake\Http\BaseApplication;
use WyriHaximus\MinifyHtml\Plugin as MinifyHtmlPlugin;

class Application extends BaseApplication {
    public function bootstrap()
    {
        parent::bootstrap();

        // Load the minify html plugin by class name
        $this->addPlugin(MinifyHtmlPlugin::class);
    }
}

Usage

After loading this plugin in your bootstrap.php the helper can be enabled in the AppView by loading the WyriHaximus/MinifyHtml.MinifyHtml helper like the example below:

class AppView extends View
{
    public function initialize(): void
    {
        $this->loadHelper('WyriHaximus/MinifyHtml.MinifyHtml');
    }
}

Note on debug

When debug mode is on nothing will be minified.

Usage in other plugins

dereuromark/cakephp-cache

To use MinifyHtml instead of dereuromark/cakephp-cache's own HTML minifier. Set the compress configuration option to:

'\WyriHaximus\MinifyHtml\compress'

Configuration

All configuration is namespaced, just as this plugin into WyriHaximus.MinifyHtml. The following options are available:

debugOverride (bool) Defaults to false. Everwrite debug and minify when debug it on. factory (string) Defaults to WyriHaximus\HtmlCompress\Factory::constructFastest. Speficy a parser factory, constructFastest, construct, and constructSmallest are build in.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

wyrihaximus / minify-html

Maintainers

Details