AbstractValidator.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\Extbase\Utility\LocalizationUtility;
use TYPO3\CMS\Form\Utility\FormUtility;

abstract class AbstractValidator extends \TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
{
    const LOCALISATION_OBJECT_NAME = 'tx_form_system_validate';

    protected $formUtility;

    protected $rawArgument;

    protected $supportedOptions = [
        'element' => ['', 'The name of the element', 'string', true],
        'errorMessage' => ['', 'The error message', 'array', true],
    ];

    protected $acceptsEmptyValues = false;

    public function setRawArgument($rawArgument)
    {
        $this->rawArgument = $rawArgument;
    }

    public function setFormUtility(FormUtility $formUtility)
    {
        $this->formUtility = $formUtility;
    }

    public function substituteMarkers($message)
    {
        return $message;
    }

    public function getLocalLanguageLabel($type = '')
    {
        $label = static::LOCALISATION_OBJECT_NAME . '.' . $type;
        $message = LocalizationUtility::translate($label, 'form');
        return $message;
    }

    public function renderMessage($message = null, $type = null, $messageType = 'message')
    {
        $message = $this->formUtility->renderItem(
            $message,
            $type,
            $this->getLocalLanguageLabel($messageType)
        );
        return $this->substituteMarkers($message);
    }
}