284 lines
12 KiB
PHP
284 lines
12 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This file is part of the Symfony package.
|
||
|
|
*
|
||
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
|
||
|
|
namespace Symfony\Component\Form;
|
||
|
|
|
||
|
|
use Symfony\Component\Form\Exception\BadMethodCallException;
|
||
|
|
use Symfony\Component\Form\Exception\LogicException;
|
||
|
|
use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
|
||
|
|
use Twig\Environment;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Renders a form into HTML using a rendering engine.
|
||
|
|
*
|
||
|
|
* @author Bernhard Schussek <bschussek@gmail.com>
|
||
|
|
*/
|
||
|
|
class FormRenderer implements FormRendererInterface
|
||
|
|
{
|
||
|
|
public const CACHE_KEY_VAR = 'unique_block_prefix';
|
||
|
|
|
||
|
|
private array $blockNameHierarchyMap = [];
|
||
|
|
private array $hierarchyLevelMap = [];
|
||
|
|
private array $variableStack = [];
|
||
|
|
|
||
|
|
public function __construct(
|
||
|
|
private FormRendererEngineInterface $engine,
|
||
|
|
private ?CsrfTokenManagerInterface $csrfTokenManager = null,
|
||
|
|
) {
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getEngine(): FormRendererEngineInterface
|
||
|
|
{
|
||
|
|
return $this->engine;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function setTheme(FormView $view, mixed $themes, bool $useDefaultThemes = true): void
|
||
|
|
{
|
||
|
|
$this->engine->setTheme($view, $themes, $useDefaultThemes);
|
||
|
|
}
|
||
|
|
|
||
|
|
public function renderCsrfToken(string $tokenId): string
|
||
|
|
{
|
||
|
|
if (null === $this->csrfTokenManager) {
|
||
|
|
throw new BadMethodCallException('CSRF tokens can only be generated if a CsrfTokenManagerInterface is injected in FormRenderer::__construct(). Try running "composer require symfony/security-csrf".');
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->csrfTokenManager->getToken($tokenId)->getValue();
|
||
|
|
}
|
||
|
|
|
||
|
|
public function renderBlock(FormView $view, string $blockName, array $variables = []): string
|
||
|
|
{
|
||
|
|
$resource = $this->engine->getResourceForBlockName($view, $blockName);
|
||
|
|
|
||
|
|
if (!$resource) {
|
||
|
|
throw new LogicException(sprintf('No block "%s" found while rendering the form.', $blockName));
|
||
|
|
}
|
||
|
|
|
||
|
|
$viewCacheKey = $view->vars[self::CACHE_KEY_VAR];
|
||
|
|
|
||
|
|
// The variables are cached globally for a view (instead of for the
|
||
|
|
// current suffix)
|
||
|
|
if (!isset($this->variableStack[$viewCacheKey])) {
|
||
|
|
$this->variableStack[$viewCacheKey] = [];
|
||
|
|
|
||
|
|
// The default variable scope contains all view variables, merged with
|
||
|
|
// the variables passed explicitly to the helper
|
||
|
|
$scopeVariables = $view->vars;
|
||
|
|
|
||
|
|
$varInit = true;
|
||
|
|
} else {
|
||
|
|
// Reuse the current scope and merge it with the explicitly passed variables
|
||
|
|
$scopeVariables = end($this->variableStack[$viewCacheKey]);
|
||
|
|
|
||
|
|
$varInit = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Merge the passed with the existing attributes
|
||
|
|
if (isset($variables['attr']) && isset($scopeVariables['attr'])) {
|
||
|
|
$variables['attr'] = array_replace($scopeVariables['attr'], $variables['attr']);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Merge the passed with the exist *label* attributes
|
||
|
|
if (isset($variables['label_attr']) && isset($scopeVariables['label_attr'])) {
|
||
|
|
$variables['label_attr'] = array_replace($scopeVariables['label_attr'], $variables['label_attr']);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Do not use array_replace_recursive(), otherwise array variables
|
||
|
|
// cannot be overwritten
|
||
|
|
$variables = array_replace($scopeVariables, $variables);
|
||
|
|
|
||
|
|
$this->variableStack[$viewCacheKey][] = $variables;
|
||
|
|
|
||
|
|
// Do the rendering
|
||
|
|
$html = $this->engine->renderBlock($view, $resource, $blockName, $variables);
|
||
|
|
|
||
|
|
// Clear the stack
|
||
|
|
array_pop($this->variableStack[$viewCacheKey]);
|
||
|
|
|
||
|
|
if ($varInit) {
|
||
|
|
unset($this->variableStack[$viewCacheKey]);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $html;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function searchAndRenderBlock(FormView $view, string $blockNameSuffix, array $variables = []): string
|
||
|
|
{
|
||
|
|
$renderOnlyOnce = 'row' === $blockNameSuffix || 'widget' === $blockNameSuffix;
|
||
|
|
|
||
|
|
if ($renderOnlyOnce && $view->isRendered()) {
|
||
|
|
// This is not allowed, because it would result in rendering same IDs multiple times, which is not valid.
|
||
|
|
throw new BadMethodCallException(sprintf('Field "%s" has already been rendered, save the result of previous render call to a variable and output that instead.', $view->vars['name']));
|
||
|
|
}
|
||
|
|
|
||
|
|
// The cache key for storing the variables and types
|
||
|
|
$viewCacheKey = $view->vars[self::CACHE_KEY_VAR];
|
||
|
|
$viewAndSuffixCacheKey = $viewCacheKey.$blockNameSuffix;
|
||
|
|
|
||
|
|
// In templates, we have to deal with two kinds of block hierarchies:
|
||
|
|
//
|
||
|
|
// +---------+ +---------+
|
||
|
|
// | Theme B | -------> | Theme A |
|
||
|
|
// +---------+ +---------+
|
||
|
|
//
|
||
|
|
// form_widget -------> form_widget
|
||
|
|
// ^
|
||
|
|
// |
|
||
|
|
// choice_widget -----> choice_widget
|
||
|
|
//
|
||
|
|
// The first kind of hierarchy is the theme hierarchy. This allows to
|
||
|
|
// override the block "choice_widget" from Theme A in the extending
|
||
|
|
// Theme B. This kind of inheritance needs to be supported by the
|
||
|
|
// template engine and, for example, offers "parent()" or similar
|
||
|
|
// functions to fall back from the custom to the parent implementation.
|
||
|
|
//
|
||
|
|
// The second kind of hierarchy is the form type hierarchy. This allows
|
||
|
|
// to implement a custom "choice_widget" block (no matter in which theme),
|
||
|
|
// or to fallback to the block of the parent type, which would be
|
||
|
|
// "form_widget" in this example (again, no matter in which theme).
|
||
|
|
// If the designer wants to explicitly fallback to "form_widget" in their
|
||
|
|
// custom "choice_widget", for example because they only want to wrap
|
||
|
|
// a <div> around the original implementation, they can call the
|
||
|
|
// widget() function again to render the block for the parent type.
|
||
|
|
//
|
||
|
|
// The second kind is implemented in the following blocks.
|
||
|
|
if (!isset($this->blockNameHierarchyMap[$viewAndSuffixCacheKey])) {
|
||
|
|
// INITIAL CALL
|
||
|
|
// Calculate the hierarchy of template blocks and start on
|
||
|
|
// the bottom level of the hierarchy (= "_<id>_<section>" block)
|
||
|
|
$blockNameHierarchy = [];
|
||
|
|
foreach ($view->vars['block_prefixes'] as $blockNamePrefix) {
|
||
|
|
$blockNameHierarchy[] = $blockNamePrefix.'_'.$blockNameSuffix;
|
||
|
|
}
|
||
|
|
$hierarchyLevel = \count($blockNameHierarchy) - 1;
|
||
|
|
|
||
|
|
$hierarchyInit = true;
|
||
|
|
} else {
|
||
|
|
// RECURSIVE CALL
|
||
|
|
// If a block recursively calls searchAndRenderBlock() again, resume rendering
|
||
|
|
// using the parent type in the hierarchy.
|
||
|
|
$blockNameHierarchy = $this->blockNameHierarchyMap[$viewAndSuffixCacheKey];
|
||
|
|
$hierarchyLevel = $this->hierarchyLevelMap[$viewAndSuffixCacheKey] - 1;
|
||
|
|
|
||
|
|
$hierarchyInit = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// The variables are cached globally for a view (instead of for the
|
||
|
|
// current suffix)
|
||
|
|
if (!isset($this->variableStack[$viewCacheKey])) {
|
||
|
|
$this->variableStack[$viewCacheKey] = [];
|
||
|
|
|
||
|
|
// The default variable scope contains all view variables, merged with
|
||
|
|
// the variables passed explicitly to the helper
|
||
|
|
$scopeVariables = $view->vars;
|
||
|
|
|
||
|
|
$varInit = true;
|
||
|
|
} else {
|
||
|
|
// Reuse the current scope and merge it with the explicitly passed variables
|
||
|
|
$scopeVariables = end($this->variableStack[$viewCacheKey]);
|
||
|
|
|
||
|
|
$varInit = false;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Load the resource where this block can be found
|
||
|
|
$resource = $this->engine->getResourceForBlockNameHierarchy($view, $blockNameHierarchy, $hierarchyLevel);
|
||
|
|
|
||
|
|
// Update the current hierarchy level to the one at which the resource was
|
||
|
|
// found. For example, if looking for "choice_widget", but only a resource
|
||
|
|
// is found for its parent "form_widget", then the level is updated here
|
||
|
|
// to the parent level.
|
||
|
|
$hierarchyLevel = $this->engine->getResourceHierarchyLevel($view, $blockNameHierarchy, $hierarchyLevel);
|
||
|
|
|
||
|
|
// The actually existing block name in $resource
|
||
|
|
$blockName = $blockNameHierarchy[$hierarchyLevel];
|
||
|
|
|
||
|
|
// Escape if no resource exists for this block
|
||
|
|
if (!$resource) {
|
||
|
|
if (\count($blockNameHierarchy) !== \count(array_unique($blockNameHierarchy))) {
|
||
|
|
throw new LogicException(sprintf('Unable to render the form because the block names array contains duplicates: "%s".', implode('", "', array_reverse($blockNameHierarchy))));
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new LogicException(sprintf('Unable to render the form as none of the following blocks exist: "%s".', implode('", "', array_reverse($blockNameHierarchy))));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Merge the passed with the existing attributes
|
||
|
|
if (isset($variables['attr']) && isset($scopeVariables['attr'])) {
|
||
|
|
$variables['attr'] = array_replace($scopeVariables['attr'], $variables['attr']);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Merge the passed with the exist *label* attributes
|
||
|
|
if (isset($variables['label_attr']) && isset($scopeVariables['label_attr'])) {
|
||
|
|
$variables['label_attr'] = array_replace($scopeVariables['label_attr'], $variables['label_attr']);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Do not use array_replace_recursive(), otherwise array variables
|
||
|
|
// cannot be overwritten
|
||
|
|
$variables = array_replace($scopeVariables, $variables);
|
||
|
|
|
||
|
|
// In order to make recursive calls possible, we need to store the block hierarchy,
|
||
|
|
// the current level of the hierarchy and the variables so that this method can
|
||
|
|
// resume rendering one level higher of the hierarchy when it is called recursively.
|
||
|
|
//
|
||
|
|
// We need to store these values in maps (associative arrays) because within a
|
||
|
|
// call to widget() another call to widget() can be made, but for a different view
|
||
|
|
// object. These nested calls should not override each other.
|
||
|
|
$this->blockNameHierarchyMap[$viewAndSuffixCacheKey] = $blockNameHierarchy;
|
||
|
|
$this->hierarchyLevelMap[$viewAndSuffixCacheKey] = $hierarchyLevel;
|
||
|
|
|
||
|
|
// We also need to store the variables for the view so that we can render other
|
||
|
|
// blocks for the same view using the same variables as in the outer block.
|
||
|
|
$this->variableStack[$viewCacheKey][] = $variables;
|
||
|
|
|
||
|
|
// Do the rendering
|
||
|
|
$html = $this->engine->renderBlock($view, $resource, $blockName, $variables);
|
||
|
|
|
||
|
|
// Clear the stack
|
||
|
|
array_pop($this->variableStack[$viewCacheKey]);
|
||
|
|
|
||
|
|
// Clear the caches if they were filled for the first time within
|
||
|
|
// this function call
|
||
|
|
if ($hierarchyInit) {
|
||
|
|
unset($this->blockNameHierarchyMap[$viewAndSuffixCacheKey], $this->hierarchyLevelMap[$viewAndSuffixCacheKey]);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($varInit) {
|
||
|
|
unset($this->variableStack[$viewCacheKey]);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($renderOnlyOnce) {
|
||
|
|
$view->setRendered();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $html;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function humanize(string $text): string
|
||
|
|
{
|
||
|
|
return ucfirst(strtolower(trim(preg_replace(['/([A-Z])/', '/[_\s]+/'], ['_$1', ' '], $text))));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @internal
|
||
|
|
*/
|
||
|
|
public function encodeCurrency(Environment $environment, string $text, string $widget = ''): string
|
||
|
|
{
|
||
|
|
if ('UTF-8' === $charset = $environment->getCharset()) {
|
||
|
|
$text = htmlspecialchars($text, \ENT_QUOTES | \ENT_SUBSTITUTE, 'UTF-8');
|
||
|
|
} else {
|
||
|
|
$text = htmlentities($text, \ENT_QUOTES | \ENT_SUBSTITUTE, 'UTF-8');
|
||
|
|
$text = iconv('UTF-8', $charset, $text);
|
||
|
|
$widget = iconv('UTF-8', $charset, $widget);
|
||
|
|
}
|
||
|
|
|
||
|
|
return str_replace('{{ widget }}', $widget, $text);
|
||
|
|
}
|
||
|
|
}
|