AbstractCompositeValidator.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Validation\Exception\InvalidValidationOptionsException;
use ‪TYPO3\CMS\Extbase\Validation\Exception\NoSuchValidatorException;
 
abstract class ‪AbstractCompositeValidator implements ‪ObjectValidatorInterface, \Countable
{
    protected ‪$supportedOptions = [];
 
    protected ‪$options = [];
 
    protected ‪$validators;
 
    protected ‪$validatedInstancesContainer;
 
    public function ‪__construct(array ‪$options = [])
    {
        // 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)), 1339079804);
        }
 
        // check for required options being set
        array_walk(
            $this->supportedOptions,
            function ($supportedOptionData, $supportedOptionName, ‪$options) {
                if (isset($supportedOptionData[3]) && !array_key_exists($supportedOptionName, ‪$options)) {
                    throw new ‪InvalidValidationOptionsException('Required validation option not set: ' . $supportedOptionName, 1339163922);
                }
            },
            ‪$options
        );
 
        // merge with default values
        $this->options = array_merge(
            array_map(
                function ($value) {
                    return $value[0];
                },
                ‪$this->supportedOptions
            ),
            ‪$options
        );
        $this->validators = new \SplObjectStorage();
    }
 
    public function ‪addValidator(‪ValidatorInterface ‪$validator)
    {
        if (‪$validator instanceof ‪ObjectValidatorInterface) {
            // @todo: provide bugfix as soon as it is fixed in TYPO3.Flow (https://forge.typo3.org/issues/48093)
            ‪$validator->setValidatedInstancesContainer = ‪$this->validatedInstancesContainer;
        }
        $this->validators->attach(‪$validator);
    }
 
    public function ‪removeValidator(ValidatorInterface ‪$validator)
    {
        if (!$this->validators->contains(‪$validator)) {
            throw new NoSuchValidatorException('Cannot remove validator because its not in the conjunction.', 1207020177);
        }
        $this->validators->detach(‪$validator);
    }
 
    public function ‪count()
    {
        return ‪count($this->validators);
    }
 
    public function ‪getValidators()
    {
        return ‪$this->validators;
    }
 
    public function ‪getOptions()
    {
        return ‪$this->options;
    }
 
    public function ‪setValidatedInstancesContainer(\SplObjectStorage ‪$validatedInstancesContainer)
    {
        $this->validatedInstancesContainer = ‪$validatedInstancesContainer;
    }
}