Argument.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Extbase\Mvc\Controller;
 
/*
 * 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\Error\Result;
use ‪TYPO3\CMS\Extbase\Property\Exception\TargetNotFoundException;
use ‪TYPO3\CMS\Extbase\Utility\TypeHandlingUtility;
 
class ‪Argument
{
    protected ‪$propertyMapper;
 
    protected ‪$propertyMappingConfiguration;
 
    protected ‪$name = '';
 
    protected ‪$shortName;
 
    protected ‪$dataType;
 
    protected ‪$isRequired = false;
 
    protected ‪$value;
 
    protected ‪$defaultValue;
 
    protected ‪$validator;
 
    protected ‪$validationResults;
 
    private ‪$hasBeenValidated = false;
 
    public function ‪injectPropertyMapper(\‪TYPO3\CMS\‪Extbase\Property\PropertyMapper ‪$propertyMapper)
    {
        $this->propertyMapper = ‪$propertyMapper;
    }
 
    public function ‪injectPropertyMappingConfiguration(‪MvcPropertyMappingConfiguration ‪$propertyMappingConfiguration)
    {
        $this->propertyMappingConfiguration = ‪$propertyMappingConfiguration;
    }
 
    public function ‪__construct(‪$name, ‪$dataType)
    {
        if (!is_string(‪$name)) {
            throw new \InvalidArgumentException('$name must be of type string, ' . gettype(‪$name) . ' given.', 1187951688);
        }
        if (‪$name === '') {
            throw new \InvalidArgumentException('$name must be a non-empty string.', 1232551853);
        }
        $this->name = ‪$name;
        $this->dataType = ‪TypeHandlingUtility::normalizeType(‪$dataType);
 
        $this->validationResults = new ‪Result();
    }
 
    public function ‪getName()
    {
        return ‪$this->name;
    }
 
    public function ‪setShortName(‪$shortName)
    {
        if (‪$shortName !== null && (!is_string(‪$shortName) || strlen(‪$shortName) !== 1)) {
            throw new \InvalidArgumentException('$shortName must be a single character or NULL', 1195824959);
        }
        $this->shortName = ‪$shortName;
        return $this;
    }
 
    public function ‪getShortName()
    {
        return ‪$this->shortName;
    }
 
    public function ‪getDataType()
    {
        return ‪$this->dataType;
    }
 
    public function ‪setRequired($required)
    {
        $this->‪isRequired = (bool)$required;
        return $this;
    }
 
    public function ‪isRequired()
    {
        return ‪$this->isRequired;
    }
 
    public function ‪setDefaultValue(‪$defaultValue)
    {
        $this->defaultValue = ‪$defaultValue;
        return $this;
    }
 
    public function ‪getDefaultValue()
    {
        return ‪$this->defaultValue;
    }
 
    public function ‪setValidator(\‪TYPO3\CMS\‪Extbase\Validation\Validator\‪ValidatorInterface ‪$validator)
    {
        $this->validator = ‪$validator;
        return $this;
    }
 
    public function ‪getValidator()
    {
        return ‪$this->validator;
    }
 
    public function ‪setValue($rawValue)
    {
        if ($rawValue === null) {
            $this->value = null;
            return $this;
        }
        if (is_object($rawValue) && $rawValue instanceof $this->dataType) {
            $this->value = $rawValue;
            return $this;
        }
        try {
            $this->value = $this->propertyMapper->convert($rawValue, $this->dataType, $this->propertyMappingConfiguration);
        } catch (TargetNotFoundException $e) {
            // for optional arguments no exeption is thrown.
            if ($this->‪isRequired()) {
                throw $e;
            }
        }
        $this->validationResults->merge($this->propertyMapper->getMessages());
        return $this;
    }
 
    public function ‪getValue()
    {
        if ($this->value === null) {
            return ‪$this->defaultValue;
        }
        return ‪$this->value;
    }
 
    public function ‪getPropertyMappingConfiguration()
    {
        return ‪$this->propertyMappingConfiguration;
    }
 
    public function ‪isValid(): bool
    {
        return !$this->‪validate()->‪hasErrors();
    }
 
    public function ‪getValidationResults()
    {
        trigger_error(
            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 v10.0.',
            E_USER_DEPRECATED
        );
 
        return $this->‪validate();
    }
 
    public function ‪__toString()
    {
        return (string)‪$this->value;
    }
 
    public function ‪validate(): \‪TYPO3\CMS\‪Extbase\Error\Result
    {
        if ($this->hasBeenValidated) {
            return ‪$this->validationResults;
        }
 
        if ($this->validator !== null) {
            $validationMessages = $this->validator->validate($this->value);
            $this->validationResults->‪merge($validationMessages);
        }
 
        $this->hasBeenValidated = true;
        return ‪$this->validationResults;
    }
}