jdecool/twig-constant-accessor-bundle

Simplify access of your class constants in Twig

1.10.0 2024-05-02 18:38 UTC

Requires

• php: ^8.1
• symfony/dependency-injection: ^5.4|^6.0|^7.0
• symfony/framework-bundle: ^5.4|^6.0|^7.0
• symfony/twig-bundle: ^5.4|^6.0|^7.0
• twig/twig: ^2.4|^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.34
• matthiasnoback/symfony-config-test: ^5.0
• matthiasnoback/symfony-dependency-injection-test: ^5.0
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.5

MIT

• Jérémy DECOOL

• symfony
• twig
• constant

README

This bundle simplify access of your enum values or class constants in Twig.

Install it

Install extension using composer:

composer require jdecool/twig-constant-accessor-bundle

If you don't use Symfony Flex, you have to enabled the bundle in your config/bundles.php configuration:

<?php

return [
    // ...
    JDecool\Bundle\TwigConstantAccessorBundle\JDecoolTwigConstantAccessorBundle::class => ['all' => true],
];

Register the class you want to access constant in your configuration file :

twig_constant_accessor:
    classes:
        - AppBundle\Model\Foo
        - { class: 'AppBundle\Model\Bar' }
        - { class: 'AppBundle\Model\FooBar', alias: 'FooBarAlias' }
        - { class: 'AppBundle\Model\ConstantClass', matches: '/^RULE_/' } # matches accept an regexp compatible with the preg_match function

You can also register a class in your container configuration using the twig.constant_accessor tag :

services:
    my_service:
        class: Namespace\To\ServiceClass
        tags:
            - { name: twig.constant_accessor }

    my_collection:
        class: MyClass
        tags:
            - { name: twig.constant_accessor, alias: 'MyClassAlias' }

    filtered_constants:
        class: ConstantsClass
        tags:
            - { name: twig.constant_accessor, matches: '/^RULE_/' } # matches accept an regexp compatible with the preg_match function

Or you can use the #[AsTwigConstantAccessor] attribute on your class :

use JDecool\Bundle\TwigConstantAccessorBundle\Annotation\AsTwigConstantAccessor;

#[AsTwigConstantAccessor]
class MyClass
{
    // ...
}

After you can access your class constant in your templates :

{{ ServiceClass.MY_CONSTANT }}
{{ MyClassAlias.KEY }}

{% if 'value' == ServiceClass.My_CONSTANT %}Test is OK{% endif %}