rules_overview.md

3 Rules Overview

NoTwigMissingVariableRule

Variable "%s" is used in template but missing in render() method

• class: Reveal\RevealTwig\Rules\NoTwigMissingVariableRule

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

final class SomeController extends AbstractController
{
    public function __invoke()
    {
        return $this->render(__DIR__ . '/some_file.twig', [
            'non_existing_variable' => 'value',
        ]);
    }
}

❌

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

final class SomeController extends AbstractController
{
    public function __invoke()
    {
        return $this->render(__DIR__ . '/some_file.twig', [
            'existing_variable' => 'value',
        ]);
    }
}

👍

NoTwigRenderUnusedVariableRule

Passed "%s" variable is not used in the template

• class: Reveal\RevealTwig\Rules\NoTwigRenderUnusedVariableRule

use Twig\Environment;

$environment = new Environment();
$environment->render(__DIR__ . '/some_file.twig', [
    'unused_variable' => 'value',
]);

❌

use Twig\Environment;

$environment = new Environment();
$environment->render(__DIR__ . '/some_file.twig', [
    'used_variable' => 'value',
]);

👍

TwigCompleteCheckRule

Complete analysis of PHP code generated from Twig template

• class: Reveal\RevealTwig\Rules\TwigCompleteCheckRule

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

final class SomeController extends AbstractController
{
    public function __invoke()
    {
        return $this->render(__DIR__ . '/some_file.twig', [
            'some' => new SomeObject()
        ]);
    }
}

// some_file.twig
{{ some.non_existing_method }}

❌

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

final class SomeController extends AbstractController
{
    public function __invoke()
    {
        return $this->render(__DIR__ . '/some_file.twig', [
            'some' => new SomeObject()
        ]);
    }
}

// some_file.twig
{{ some.existing_method }}

👍