InArrayValidator.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\Domain\Validator;

/*
 * 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!
 */

use TYPO3\CMS\Core\Charset\CharsetConverter;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class InArrayValidator extends AbstractValidator
{
    protected $supportedOptions = [
        'element' => ['', 'The name of the element', 'string', true],
        'errorMessage' => ['', 'The error message', 'array', true],
        'array' => ['', 'The array values from the wizard configuration (array = test1,test2)', 'string', false],
        'array.' => ['', 'The array values from the documented configuration', 'array', false],
        'strict' => ['', 'Compare types', 'boolean', false],
        'ignorecase' => ['', 'Ignore cases', 'boolean', false]
    ];

    protected $charsetConverter;

    public function __construct(array $options)
    {
        parent::__construct($options);
        if (!empty($this->options['ignorecase'])) {
            $this->charsetConverter = GeneralUtility::makeInstance(CharsetConverter::class);
        }
    }

    const LOCALISATION_OBJECT_NAME = 'tx_form_system_validate_inarray';

    public function isValid($value)
    {
        if (empty($value)) {
            return;
        }

        if (is_string($value)) {
            $value = [$value];
        }

        $allowedOptionsArray = [];
        if (!empty($this->options['array']) && is_string($this->options['array'])) {
            $allowedOptionsArray = GeneralUtility::trimExplode(',', $this->options['array'], true);
        } elseif (!empty($this->options['array.']) && is_array($this->options['array.'])) {
            $allowedOptionsArray = $this->options['array.'];
        }

        if (!empty($this->options['ignorecase'])) {
            foreach ($value as &$incomingArrayValue) {
                $incomingArrayValue = $this->charsetConverter->conv_case('utf-8', $incomingArrayValue, 'toLower');
            }
            foreach ($allowedOptionsArray as &$option) {
                $option = $this->charsetConverter->conv_case('utf-8', $option, 'toLower');
            }
        }

        foreach ($value as $incomingArrayValue) {
            if (!in_array($incomingArrayValue, $allowedOptionsArray, !empty($this->options['strict']))) {
                $this->addError(
                    $this->renderMessage(
                        $this->options['errorMessage'][0],
                        $this->options['errorMessage'][1],
                        'error'
                    ),
                    1442002594
                );
            }
        }
    }
}