silent/twig-const-resolver

This package is abandoned and no longer maintained. No replacement package was suggested.

Simple Twig plugin to resolve constant on template cache build

1.1.1 2015-10-21 19:21 UTC

Requires

• php: >=5.6.0
• twig/twig: ~1.0

Requires (Dev)

• phpunit/phpunit: ~5.0.0
• satooshi/php-coveralls: ~0.6.0

MIT

• templating
• twig
• extension
• constant

README

Simple Twig plugin to resolve constant on template cache build.

Why

For example we have something like this:

{% if usertype == constant('Users::TYPE_TROLL') %}
    Bye-bye
{% else %}
    Hello!
{% endif %}

Without this extension Twig will compile it in something like this:

if (((isset($context["usertype"]) ? $context["usertype"] : null) == twig_constant("Users::TYPE_TROLL"))) {
    // twig_constant will be evaluated in runtime
    echo "Bye-bye";
} else {
    echo "Hello";
}

It will be compiled even if you have no constant with that name. So you will get an error in production.

With this extension you can avoid this types of errors cause it will evaluate constants at the build step, so this template will be compiled in something like this:

if (((isset($context["usertype"]) ? $context["usertype"] : null) == Users::TYPE_TROLL)) {
    // constant is resolved at the build step (Users::TYPE_TROLL)
    echo "Bye-bye";
} else {
    echo "Hello";
}

Also in evaluation mode it can be compiled in something like this:

if (((isset($context["usertype"]) ? $context["usertype"] : null) == 2)) {
    // constant is resolved and evaluated at the build step (Users::TYPE_TROLL => 2)
    echo "Bye-bye";
} else {
    echo "Hello";
}

Installation

The extension is installable via composer:

{
    "require": {
        "silent/twig-const-resolver": "~1.1"
    }
}

Setup

$twig->addExtension(
    /**
     * @param $evaluate bool Evaluate consts (default: false)
     */
    new \silent\Twig\ConstantResolverExtension\Extension()
);