TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,231 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/*
|
||||
* This file is part of the TYPO3 CMS project.
|
||||
*
|
||||
* It is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU General Public License, either version 2
|
||||
* of the License, or any later version.
|
||||
*
|
||||
* For the full copyright and license information, please read the
|
||||
* LICENSE.txt file that was distributed with this source code.
|
||||
*
|
||||
* The TYPO3 project - inspiring people to share!
|
||||
*/
|
||||
|
||||
namespace TYPO3\CMS\Extbase\Validation\Validator;
|
||||
|
||||
use Psr\Http\Message\ServerRequestInterface;
|
||||
use TYPO3\CMS\Core\Http\UploadedFile;
|
||||
use TYPO3\CMS\Core\Type\File\FileInfo;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Extbase\Error\Result;
|
||||
use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
|
||||
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
|
||||
use TYPO3\CMS\Extbase\Validation\Error;
|
||||
use TYPO3\CMS\Extbase\Validation\Exception\InvalidValidationOptionsException;
|
||||
|
||||
/**
|
||||
* Abstract validator. Mother af most validators.
|
||||
*/
|
||||
abstract class AbstractValidator implements ValidatorInterface
|
||||
{
|
||||
/**
|
||||
* Specifies whether this validator accepts empty values.
|
||||
*
|
||||
* If this is TRUE, the validators isValid() method is not called in case of an empty value
|
||||
* Note: A value is considered empty if it is NULL or an empty string!
|
||||
* By default, all validators except for NotEmpty and the Composite Validators accept empty values.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $acceptsEmptyValues = true;
|
||||
|
||||
/**
|
||||
* Contains an array of property names used for translation handling of error messages.
|
||||
*/
|
||||
protected array $translationOptions = ['message'];
|
||||
|
||||
/**
|
||||
* This contains the supported options, their default values, types and descriptions.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $supportedOptions = [];
|
||||
|
||||
protected array $options = [];
|
||||
protected Result $result;
|
||||
protected ?ServerRequestInterface $request = null;
|
||||
|
||||
public function setOptions(array $options): void
|
||||
{
|
||||
$this->initializeDefaultOptions($options);
|
||||
$this->initializeTranslationOptions($options);
|
||||
}
|
||||
|
||||
public function setRequest(?ServerRequestInterface $request): void
|
||||
{
|
||||
$this->request = $request;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given value is valid according to the validator, and returns
|
||||
* the error messages object which occurred.
|
||||
*
|
||||
* @param mixed $value The value that should be validated
|
||||
*/
|
||||
public function validate(mixed $value): Result
|
||||
{
|
||||
$this->result = new Result();
|
||||
if ($this->acceptsEmptyValues === false || $this->isEmpty($value) === false) {
|
||||
$this->isValid($value);
|
||||
}
|
||||
return $this->result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if $value is valid. If it is not valid, needs to add an error to result.
|
||||
*/
|
||||
abstract protected function isValid(mixed $value): void;
|
||||
|
||||
/**
|
||||
* Creates a new validation error object and adds it to $this->result
|
||||
*
|
||||
* @param string $message The error message
|
||||
* @param int $code The error code (a unix timestamp)
|
||||
* @param array $arguments Arguments to be replaced in message
|
||||
* @param string $title title of the error
|
||||
*/
|
||||
protected function addError(string $message, int $code, array $arguments = [], string $title = ''): void
|
||||
{
|
||||
$this->result->addError(new Error($message, $code, $arguments, $title));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new validation error object for a property and adds it to the proper sub result of $this->result
|
||||
*
|
||||
* @param string|array $propertyPath The property path (string or array)
|
||||
* @param string $message The error message
|
||||
* @param int $code The error code (a unix timestamp)
|
||||
* @param array $arguments Arguments to be replaced in message
|
||||
* @param string $title Title of the error
|
||||
*/
|
||||
protected function addErrorForProperty(string|array $propertyPath, string $message, int $code, array $arguments = [], string $title = ''): void
|
||||
{
|
||||
$propertyPath = is_array($propertyPath) ? implode('.', $propertyPath) : $propertyPath;
|
||||
$error = new Error($message, $code, $arguments, $title);
|
||||
$this->result->forProperty($propertyPath)->addError($error);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the options of this validator
|
||||
*/
|
||||
public function getOptions(): array
|
||||
{
|
||||
return $this->options;
|
||||
}
|
||||
|
||||
public function getRequest(): ?ServerRequestInterface
|
||||
{
|
||||
return $this->request;
|
||||
}
|
||||
|
||||
/**
|
||||
* TRUE if the given $value is NULL or an empty string ('')
|
||||
*/
|
||||
final protected function isEmpty(mixed $value): bool
|
||||
{
|
||||
return $value === null || $value === '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Translates an error message using LocalizationUtility::translate() method. If the translate key does not
|
||||
* start with 'LLL:' and if no extension name is provided, the original translate key is returned.
|
||||
*/
|
||||
protected function translateErrorMessage(
|
||||
string $translateKey,
|
||||
string $extensionName = '',
|
||||
array $arguments = []
|
||||
): string {
|
||||
if ($extensionName === '' && !str_starts_with($translateKey, 'LLL:')) {
|
||||
return $translateKey;
|
||||
}
|
||||
|
||||
return LocalizationUtility::translate(
|
||||
$translateKey,
|
||||
$extensionName,
|
||||
$arguments
|
||||
) ?? '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize default options.
|
||||
* @throws InvalidValidationOptionsException
|
||||
*/
|
||||
protected function initializeDefaultOptions(array $options): void
|
||||
{
|
||||
// check for options given but not supported
|
||||
if (($unsupportedOptions = array_diff_key($options, $this->supportedOptions)) !== []) {
|
||||
throw new InvalidValidationOptionsException('Unsupported validation option(s) found: ' . implode(', ', array_keys($unsupportedOptions)), 1379981890);
|
||||
}
|
||||
// check for required options being set
|
||||
array_walk(
|
||||
$this->supportedOptions,
|
||||
static function (array $supportedOptionData, string $supportedOptionName, array $options): void {
|
||||
if (isset($supportedOptionData[3]) && $supportedOptionData[3] === true && !array_key_exists($supportedOptionName, $options)) {
|
||||
throw new InvalidValidationOptionsException('Required validation option not set: ' . $supportedOptionName, 1379981891);
|
||||
}
|
||||
},
|
||||
$options
|
||||
);
|
||||
// merge with default values
|
||||
$this->options = array_merge(
|
||||
array_map(
|
||||
static fn(array $value): mixed => $value[0],
|
||||
$this->supportedOptions
|
||||
),
|
||||
$options
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that the provided value is either an instance of UploadedFile or an ObjectStorage containing only
|
||||
* UploadedFile instances.
|
||||
*/
|
||||
protected function ensureFileUploadTypes(mixed $value): void
|
||||
{
|
||||
if ($value instanceof UploadedFile) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ($value instanceof ObjectStorage) {
|
||||
foreach ($value as $uploadedFile) {
|
||||
if (!$uploadedFile instanceof UploadedFile) {
|
||||
throw new \InvalidArgumentException('Value to validate must be an ObjectStorage of TYPO3\\CMS\\Core\\Http\\UploadedFile', 1722763902);
|
||||
}
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
throw new \InvalidArgumentException('Value to validate must be a TYPO3\\CMS\\Core\\Http\\UploadedFile', 1712057926);
|
||||
}
|
||||
|
||||
protected function getFileInfo(string $filePath): FileInfo
|
||||
{
|
||||
return GeneralUtility::makeInstance(FileInfo::class, $filePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes all registered translation options with custom translation options from the given options array
|
||||
*/
|
||||
protected function initializeTranslationOptions(array $options): void
|
||||
{
|
||||
foreach ($this->translationOptions as $translationOption) {
|
||||
if (property_exists($this, $translationOption)) {
|
||||
$this->$translationOption = $options[$translationOption] ?? $this->$translationOption;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user