src/TwigView.php - master - jagepard/Rudra-View

src/TwigView.php
84 строки3 KB
Jagepard
add Override
03 июл 2026, 22:10
03 июл 2026, 22:10cbd9eb1
<?php declare(strict_types=1);

/**
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * @author  Korotkov Danila (Jagepard) <jagepard@yandex.ru>
 * @license https://mozilla.org/MPL/2.0/  MPL-2.0
 */

namespace Rudra\View;

use Twig\Environment;
use Twig\Loader\FilesystemLoader;
use Rudra\Exceptions\RuntimeException;

class TwigView implements ViewInterface
{
    private Environment $twig;
    private string $cachePath;
    private string $prefix;

    /**
     * Configures paths for working with Twig templates and caching.
     * Checks the existence of the template directory, sets basic parameters,
     * and initializes the Twig environment with caching enabled.
     * 
     * @param string $extension Currently unused, reserved for future use
     * @throws RuntimeException
     */
    #[\Override]
    public function setup(string $viewPath, string $prefix = '', string $extension = 'twig'): void
    {
        if (!is_dir($viewPath)) {
            throw new RuntimeException("The template directory does not exist: {$viewPath}");
        }

        $this->prefix = $prefix;

        $basePath = dirname(__DIR__, 4);
        $this->cachePath = $basePath . '/storage/cache/twig';

        if (!is_dir($this->cachePath)) {
            mkdir($this->cachePath, 0777, true);
        }

        $loader = new FilesystemLoader($viewPath);
        $this->twig = new Environment($loader, [
            'cache' => $this->cachePath,
            'auto_reload' => true,
            'debug' => false,
        ]);
    }

    /**
     * Renders a Twig template at the specified path, substituting the passed data.
     * If `$path` is an array, the first element is used as the template name,
     * and the rendered result is returned (external caching may be applied if needed).
     */
    #[\Override]
    public function view(string|array $path, array $data = []): string|false
    {
        if (is_array($path)) {
            $output = $this->twig->render($path[0] . '.twig', $data);
            // External named caching is possible, but usually not required — Twig caches compilation itself.
            return $output;
        }

        return $this->twig->render($path . '.twig', $data);
    }

    /**
     * Page-level caching is not supported in TwigView, as Twig handles template compilation caching internally.
     * This method throws an exception to indicate that HTTP-level or application-level caching should be used instead.
     * 
     * @throws RuntimeException
     */
    #[\Override]
    public function cache(array $path, bool $fullPage = false): ?string
    {
        throw new RuntimeException('Caching via cache() is not supported in TwigView. Use HTTP-level caching instead.');
    }
}