130 lines
4.0 KiB
PHP
130 lines
4.0 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin;
|
|
|
|
use PhpMyAdmin\Container\ContainerBuilder;
|
|
use PhpMyAdmin\Html\Generator;
|
|
use PhpMyAdmin\Html\MySQLDocumentation;
|
|
use PhpMyAdmin\Theme\ThemeManager;
|
|
use PhpMyAdmin\Twig\I18nExtension;
|
|
use PhpMyAdmin\Twig\MessageExtension;
|
|
use PhpMyAdmin\Twig\PmaGlobalVariable;
|
|
use PhpMyAdmin\Utils\Gis;
|
|
use RuntimeException;
|
|
use Throwable;
|
|
use Twig\Environment;
|
|
use Twig\Error\LoaderError;
|
|
use Twig\Error\RuntimeError;
|
|
use Twig\Error\SyntaxError;
|
|
use Twig\Extension\AttributeExtension;
|
|
use Twig\Extension\DebugExtension;
|
|
use Twig\Loader\FilesystemLoader;
|
|
use Twig\RuntimeLoader\ContainerRuntimeLoader;
|
|
use Twig\TemplateWrapper;
|
|
|
|
/**
|
|
* Handle front end templating
|
|
*/
|
|
class Template
|
|
{
|
|
/**
|
|
* Twig environment
|
|
*/
|
|
private static Environment|null $twig = null;
|
|
|
|
public const TEMPLATES_FOLDER = ROOT_PATH . 'resources/templates';
|
|
|
|
public function __construct(private readonly Config $config)
|
|
{
|
|
}
|
|
|
|
public static function getTwigEnvironment(string|null $cacheDir, bool $isDevEnv): Environment
|
|
{
|
|
/* Twig expects false when cache is not configured */
|
|
if ($cacheDir === null) {
|
|
$cacheDir = false;
|
|
}
|
|
|
|
$loader = new FilesystemLoader(self::TEMPLATES_FOLDER);
|
|
$twig = new Environment($loader, ['auto_reload' => true, 'cache' => $cacheDir]);
|
|
|
|
$twig->addRuntimeLoader(new ContainerRuntimeLoader(ContainerBuilder::getContainer()));
|
|
|
|
if ($isDevEnv) {
|
|
$twig->enableDebug();
|
|
$twig->enableStrictVariables();
|
|
$twig->addExtension(new DebugExtension());
|
|
} else {
|
|
$twig->disableDebug();
|
|
$twig->disableStrictVariables();
|
|
}
|
|
|
|
$twig->addGlobal('pma', new PmaGlobalVariable());
|
|
$twig->addExtension(new AttributeExtension(Core::class));
|
|
$twig->addExtension(new AttributeExtension(FlashMessenger::class));
|
|
$twig->addExtension(new AttributeExtension(Generator::class));
|
|
$twig->addExtension(new AttributeExtension(Gis::class));
|
|
$twig->addExtension(new I18nExtension());
|
|
$twig->addExtension(new AttributeExtension(MessageExtension::class));
|
|
$twig->addExtension(new AttributeExtension(MySQLDocumentation::class));
|
|
$twig->addExtension(new AttributeExtension(Sanitize::class));
|
|
$twig->addExtension(new AttributeExtension(ThemeManager::class));
|
|
$twig->addExtension(new AttributeExtension(Transformations::class));
|
|
$twig->addExtension(new AttributeExtension(Url::class));
|
|
$twig->addExtension(new AttributeExtension(Util::class));
|
|
|
|
return $twig;
|
|
}
|
|
|
|
/**
|
|
* Loads a template.
|
|
*
|
|
* @param string $templateName Template path name
|
|
*
|
|
* @throws LoaderError
|
|
* @throws RuntimeError
|
|
* @throws SyntaxError
|
|
*/
|
|
private function load(string $templateName): TemplateWrapper
|
|
{
|
|
if (self::$twig === null) {
|
|
$isDevEnv = $this->config->config->environment === 'development';
|
|
self::$twig = self::getTwigEnvironment(CACHE_DIR . 'twig', $isDevEnv);
|
|
}
|
|
|
|
try {
|
|
return self::$twig->load($templateName . '.twig');
|
|
} catch (RuntimeException) { // @phpstan-ignore-line thrown by Twig\Cache\FilesystemCache
|
|
/* Retry with disabled cache */
|
|
self::$twig->setCache(false);
|
|
|
|
return self::$twig->load($templateName . '.twig');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $template Template path name
|
|
* @param mixed[] $data Associative array of template variables
|
|
*
|
|
* @throws Throwable
|
|
* @throws LoaderError
|
|
* @throws RuntimeError
|
|
* @throws SyntaxError
|
|
*/
|
|
public function render(string $template, array $data = []): string
|
|
{
|
|
return $this->load($template)->render($data);
|
|
}
|
|
|
|
public function disableCache(): void
|
|
{
|
|
if (self::$twig === null) {
|
|
self::$twig = self::getTwigEnvironment(null, false);
|
|
}
|
|
|
|
self::$twig->setCache(false);
|
|
}
|
|
}
|
