App\Twig\Extension\RoutingExtension

Complexity

Total Complexity

9

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getFunctions()	0	6	1
A	getAttributeIf()	0	7	2
A	getControllerFqcn()	0	24	4
A	getAriaCurrentPageIf()	0	3	1

<?php

declare(strict_types=1);

namespace App\Twig\Extension;

use Symfony\Component\Routing\RouterInterface;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

use function Symfony\Component\String\u;

/**
 * Routing related stuff.
 *
 * @see RoutingExtensionTest
 */
final class RoutingExtension extends AbstractExtension
{
    /**
     * @var array<int, string>|null
     */
    private ?array $controllers = null;

    public function __construct(
        private readonly RouterInterface $router,
    ) {
    }

    public function getFunctions(): array
    {
        return [
            new TwigFunction('ctrl_fqcn', $this->getControllerFqcn(...)),
            new TwigFunction('attr_if', $this->getAttributeIf(...)),
            new TwigFunction('aria_current_page_if', $this->getAriaCurrentPageIf(...)),
        ];
    }

    /**
     * This function returns a complete controller FQCN from a short name.
     * If you have multiple controllers/actions with the same name, you can include
     * the parent namespace to select the good one like the last examples below.
     *
     * @example ComposerAction      --> App\Controller\ComposerAction
     * @example Product\ListAction  --> App\Controller\Product\ListAction
     * @example Category\ListAction --> App\Controller\Category\ListAction
     *
     * @return class-string
     */
    public function getControllerFqcn(string $ctrlShortname): string
    {
        if ($this->controllers === null) {
            $this->controllers = array_unique(array_map(
                static fn ($value) => u($value)->trimSuffix('::__invoke')->toString(),
                array_keys($this->router->getRouteCollection()->getAliases())
            ));
        }

        foreach ($this->controllers as $controller) {
            /** @var class-string $controller */
            if (u($controller)->endsWith($ctrlShortname)) {
                return $controller;
            }
        }

        // If all your ADR controllers live in the "App\Controller\" namespace,
        // then you probably don't need all the code above, just use:
        //
        // return  'App\\Controller\\'. $ctrlShortname;
        //
        // If the route is not found, then Twig raises a "RouteNotFoundException".

        throw new \InvalidArgumentException('No controller found for the "'.$ctrlShortname.'" shortname.');
    }

    /**
     * Returns an HTML attribute with a given value only if a condition is met.
     *
     * @see templates/base.html.twig
     */
    public function getAttributeIf(bool $condition, string $attribute, string $value): string
    {
        if (!$condition) {
            return '';
        }

        return \sprintf(' %s="%s"', $attribute, $value);
    }

    public function getAriaCurrentPageIf(bool $condition): string
    {
        return $this->getAttributeIf($condition, 'aria-current', 'page');
    }
}