mirror of
https://github.com/Respect/Validation.git
synced 2026-03-16 15:25:45 +01:00
5b00d69766Currently, the templates that a user provides when running `assert()` can significantly impact how the message is displayed. Because of this, the formatters become complex as they all need to handle similar conditions to format results. This commit changes this behaviour, letting only the `InterpolationRenderer` handle the templates. This makes the code simpler and allows people to use the `InterpolationRenderer` directly, without needing to figure out how to handle templates. Thinking about it further, I believe handling templates is a concern for the `Renderer` anyway, and this will open the way to other improvements using the renderer. I also removed the exception that is thrown when the template is not a string, because I think that after validation has failed, we should not throw any other exceptions, as that could cause unexpected errors for users.
110 lines
2.9 KiB
PHP
110 lines
2.9 KiB
PHP
<?php
|
|
|
|
/*
|
|
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Respect\Validation\Message\Formatter;
|
|
|
|
use ReflectionClass;
|
|
use Respect\Validation\Message\Template;
|
|
use Respect\Validation\Path;
|
|
use Respect\Validation\Result;
|
|
use Respect\Validation\Rule;
|
|
|
|
use function array_reduce;
|
|
use function array_reverse;
|
|
use function is_array;
|
|
use function is_string;
|
|
|
|
final class TemplateResolver
|
|
{
|
|
/** @var array<string, array<Template>> */
|
|
private array $templates = [];
|
|
|
|
/** @param array<string|int, mixed> $templates */
|
|
public function getGivenTemplate(Result $result, array $templates): string|null
|
|
{
|
|
if ($result->hasCustomTemplate()) {
|
|
return $result->template;
|
|
}
|
|
|
|
if ($result->path !== null) {
|
|
$templates = $this->filterByPath($result->path, $templates);
|
|
}
|
|
|
|
foreach ([$result->path?->value, $result->name?->value, $result->id->value, '__root__'] as $key) {
|
|
if ($key === null || !isset($templates[$key])) {
|
|
continue;
|
|
}
|
|
|
|
if (is_string($templates[$key])) {
|
|
return $templates[$key];
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public function getRuleTemplate(Result $result): string
|
|
{
|
|
foreach ($this->extractTemplates($result->rule) as $template) {
|
|
if ($template->id !== $result->template) {
|
|
continue;
|
|
}
|
|
|
|
if ($result->hasInvertedMode) {
|
|
return $template->inverted;
|
|
}
|
|
|
|
return $template->default;
|
|
}
|
|
|
|
return $result->template;
|
|
}
|
|
|
|
/** @return array<Template> */
|
|
private function extractTemplates(Rule $rule): array
|
|
{
|
|
if (!isset($this->templates[$rule::class])) {
|
|
$reflection = new ReflectionClass($rule);
|
|
foreach ($reflection->getAttributes(Template::class) as $attribute) {
|
|
$this->templates[$rule::class][] = $attribute->newInstance();
|
|
}
|
|
}
|
|
|
|
return $this->templates[$rule::class] ?? [];
|
|
}
|
|
|
|
/**
|
|
* @param array<string|int> $nodes
|
|
*
|
|
* @return non-empty-array<string|int>
|
|
*/
|
|
private function getNodes(Path $path, array $nodes = []): array
|
|
{
|
|
$nodes[] = $path->value;
|
|
if ($path->parent !== null) {
|
|
return $this->getNodes($path->parent, $nodes);
|
|
}
|
|
|
|
return $nodes;
|
|
}
|
|
|
|
/**
|
|
* @param array<string|int, mixed> $templates
|
|
*
|
|
* @return array<string|int, mixed>
|
|
*/
|
|
private function filterByPath(Path $path, array $templates): array
|
|
{
|
|
return array_reduce(
|
|
array_reverse($this->getNodes($path)),
|
|
static fn(array $carry, $node) => isset($carry[$node]) && is_array($carry[$node]) ? $carry[$node] : $carry,
|
|
$templates,
|
|
);
|
|
}
|
|
}
|