respect-validation/library/Rules/Charset.php
Henrique Moody 94ddfcd0bd
Create named constructor to create Result
The constructor of `Result` has many arguments, but that's not the
primary reason why I'm making this change. I want to change the
constructor, and it will become more complicated, so having this named
constructor will be useful in the next refactoring.

With this change, I also made the `id` mandatory. That made the
constructor look neater and most to promote almost all properties to the
constructor.

Another change was removing the `fromAdjacent` method, which was quite
confusing. I created the `asAdjacentOf` method, which is a bit clearer.
If anything, it makes all static methods named constructors. It will be
a bit more verbose, but more intuitive.
2025-12-26 22:34:43 +01:00

57 lines
1.6 KiB
PHP

<?php
/*
* Copyright (c) Alexandre Gomes Gaigalas <alganet@gmail.com>
* SPDX-License-Identifier: MIT
*/
declare(strict_types=1);
namespace Respect\Validation\Rules;
use Attribute;
use Respect\Validation\Exceptions\InvalidRuleConstructorException;
use Respect\Validation\Message\Template;
use Respect\Validation\Result;
use Respect\Validation\Rule;
use function array_diff;
use function array_merge;
use function array_values;
use function count;
use function in_array;
use function mb_detect_encoding;
use function mb_list_encodings;
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
#[Template(
'{{subject}} must only contain characters from the {{charset|raw}} charset',
'{{subject}} must not contain any characters from the {{charset|raw}} charset',
)]
final readonly class Charset implements Rule
{
/** @var non-empty-array<string> */
private array $charset;
public function __construct(string $charset, string ...$charsets)
{
$available = mb_list_encodings();
$charsets = array_merge([$charset], $charsets);
$diff = array_diff($charsets, $available);
if (count($diff) > 0) {
throw new InvalidRuleConstructorException('Invalid charset provided: %s', array_values($diff));
}
$this->charset = $charsets;
}
public function evaluate(mixed $input): Result
{
return Result::of(
in_array(mb_detect_encoding($input, $this->charset, true), $this->charset),
$input,
$this,
['charset' => $this->charset],
);
}
}