AbstractValidator.php

Go to the documentation of this file.

<?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 ‪TYPO3\CMS\Extbase\Error\Result;
use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;
use ‪TYPO3\CMS\Extbase\Validation\Error;
use ‪TYPO3\CMS\Extbase\Validation\Exception\InvalidValidationOptionsException;
 
abstract class ‪AbstractValidator implements ‪ValidatorInterface
{
    protected ‪$acceptsEmptyValues = true;
 
    protected ‪$supportedOptions = [];
 
    protected array ‪$options = [];
    protected ‪Result ‪$result;
 
    public function ‪setOptions(array ‪$options): void
    {
        $this->‪initializeDefaultOptions($options);
    }
 
    public function ‪validate(mixed $value): ‪Result
    {
        $this->result = new ‪Result();
        if ($this->acceptsEmptyValues === false || $this->‪isEmpty($value) === false) {
            $this->‪isValid($value);
        }
        return ‪$this->result;
    }
 
    abstract protected function ‪isValid(mixed $value): void;
 
    protected function ‪addError(string $message, int $code, array $arguments = [], string $title = ''): void
    {
        $this->result->addError(new Error($message, $code, $arguments, $title));
    }
 
    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);
    }
 
    public function ‪getOptions(): array
    {
        return ‪$this->options;
    }
 
    final protected function ‪isEmpty(mixed $value): bool
    {
        return $value === null || $value === '';
    }
 
    protected function ‪translateErrorMessage(string $translateKey, string $extensionName, array $arguments = []): string
    {
        return ‪LocalizationUtility::translate(
            $translateKey,
            $extensionName,
            $arguments
        ) ?? '';
    }
 
    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
        );
    }
}