Ocubom Twig HTML Extension

A custom suite of Twig filters for HTML manipulation

Explore the docs »

Report Bug · Request Feature

Contents

• About TwigHtmlExtension
• Getting Started
  • Installation
  • Usage
• Roadmap
• Contributing
• Authorship
• License

About TwigHtmlExtension

TwigHtmlExtension is a custom suite of Twig filters for HTML manipulation.

This suite started as an internal class based on nochso/html-compress-twig to allow the use of wyrihaximus/html-compress with Twig 3.0. This class used to be embedded into several projects. Over time, each project adapted its version slightly, leading to fragmented development and difficult maintenance. Therefore, the development is unified in this extension which is made public in case it is useful for other projects.

Getting Started

Installation

Just use composer to add the dependency:

composer require ocubom/twig-html-extension

Or add the dependency manually:

1. Update composer.json file with the lines:

   {
       "require": {
           "ocubom/twig-html-extension": "^1.0.0"
       }
   }

2. And update the dependencies:

   composer update "ocubom/twig-html-extension"

Usage

Just register the Twig extension:

$twig = new \Twig\Environment();
$twig->addExtension(new \Ocubom\Twig\Extension\HtmlExtension());
$thig->addRuntimeLoader(use Twig\RuntimeLoader\FactoryRuntimeLoader([
    \Ocubom\Twig\Extension\HtmlAttributesRuntime::class => function() {
        return new \Ocubom\Twig\Extension\HtmlAttributesRuntime();
    },
    \Ocubom\Twig\Extension\HtmlCompressRuntime::class => function() {
        return new \Ocubom\Twig\Extension\HtmlCompressRuntime();
    },
]));

// You can also dynamically create a RuntimeLoader 
$twig->addRuntimeLoader(new class() implements RuntimeLoaderInterface {
    public function load($class)
    {
        if (\Ocubom\Twig\Extension\HtmlAttributesRuntime::class === $class) {
            return new \Ocubom\Twig\Extension\HtmlAttributesRuntime();
        }
        
        if (\Ocubom\Twig\Extension\HtmlCompressRuntime::class === $class) {
            return new \Ocubom\Twig\Extension\HtmlCompressRuntime();
        }
        
        return null;
    }
});

For more examples, please refer to the Documentation.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/your-feature).
3. Commit your Changes (git commit -m 'Add your-feature').
4. Push to the Branch (git push origin feature/your-feature).
5. Open a Pull Request.

Authorship

• Oscar Cubo Medina — https://ocubom.github.io

See also the list of contributors who participated in this project.

License

Distributed under the MIT License. See LICENSE for more information.