PropertyMappingConfiguration.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\Property;
 
class ‪PropertyMappingConfiguration implements ‪PropertyMappingConfigurationInterface
{
    public const ‪PROPERTY_PATH_PLACEHOLDER = '*';
 
    protected ‪$configuration;
 
    protected ‪$subConfigurationForProperty = [];
 
    protected ‪$mapping = [];
 
    protected ‪$typeConverter;
 
    protected ‪$propertiesToBeMapped = [];
 
    protected ‪$propertiesToSkip = [];
 
    protected ‪$propertiesNotToBeMapped = [];
 
    protected ‪$skipUnknownProperties = false;
 
    protected ‪$mapUnknownProperties = false;
 
    public function ‪shouldMap($propertyName)
    {
        if (isset($this->propertiesNotToBeMapped[$propertyName])) {
            return false;
        }
 
        if (isset($this->propertiesToBeMapped[$propertyName])) {
            return true;
        }
 
        if (isset($this->subConfigurationForProperty[self::PROPERTY_PATH_PLACEHOLDER])) {
            return true;
        }
 
        return ‪$this->mapUnknownProperties;
    }
 
    public function ‪shouldSkip($propertyName)
    {
        return isset($this->propertiesToSkip[$propertyName]);
    }
 
    public function ‪allowAllProperties()
    {
        $this->mapUnknownProperties = true;
        return $this;
    }
 
    public function ‪allowProperties()
    {
        foreach (func_get_args() as $propertyName) {
            $this->propertiesToBeMapped[$propertyName] = $propertyName;
        }
        return $this;
    }
 
    public function ‪skipProperties()
    {
        foreach (func_get_args() as $propertyName) {
            $this->propertiesToSkip[$propertyName] = $propertyName;
        }
        return $this;
    }
 
    public function ‪allowAllPropertiesExcept()
    {
        $this->mapUnknownProperties = true;
 
        foreach (func_get_args() as $propertyName) {
            $this->propertiesNotToBeMapped[$propertyName] = $propertyName;
        }
        return $this;
    }
 
    public function ‪skipUnknownProperties()
    {
        $this->‪skipUnknownProperties = true;
        return $this;
    }
 
    public function ‪shouldSkipUnknownProperties()
    {
        return ‪$this->skipUnknownProperties;
    }
 
    public function ‪getConfigurationFor($propertyName)
    {
        if (isset($this->subConfigurationForProperty[$propertyName])) {
            return $this->subConfigurationForProperty[$propertyName];
        }
        if (isset($this->subConfigurationForProperty[self::PROPERTY_PATH_PLACEHOLDER])) {
            return $this->subConfigurationForProperty[‪self::PROPERTY_PATH_PLACEHOLDER];
        }
 
        return new self();
    }
 
    public function ‪getTargetPropertyName($sourcePropertyName)
    {
        if (isset($this->mapping[$sourcePropertyName])) {
            return $this->mapping[$sourcePropertyName];
        }
        return $sourcePropertyName;
    }
 
    public function ‪getConfigurationValue($typeConverterClassName, $key)
    {
        if (!isset($this->configuration[$typeConverterClassName][$key])) {
            return null;
        }
 
        return $this->configuration[$typeConverterClassName][$key];
    }
 
    public function ‪setMapping($sourcePropertyName, $targetPropertyName)
    {
        $this->mapping[$sourcePropertyName] = $targetPropertyName;
        return $this;
    }
 
    public function ‪setTypeConverterOptions(‪$typeConverter, array $options)
    {
        foreach ($this->‪getTypeConvertersWithParentClasses(‪$typeConverter) as ‪$typeConverter) {
            $this->configuration[‪$typeConverter] = $options;
        }
        return $this;
    }
 
    public function ‪setTypeConverterOption(‪$typeConverter, $optionKey, $optionValue)
    {
        foreach ($this->‪getTypeConvertersWithParentClasses(‪$typeConverter) as ‪$typeConverter) {
            $this->configuration[‪$typeConverter][$optionKey] = $optionValue;
        }
        return $this;
    }
 
    protected function ‪getTypeConvertersWithParentClasses(‪$typeConverter)
    {
        $typeConverterClasses = class_parents(‪$typeConverter);
        $typeConverterClasses = $typeConverterClasses ?: [];
        $typeConverterClasses[] = ‪$typeConverter;
        return $typeConverterClasses;
    }
 
    public function ‪forProperty($propertyPath)
    {
        $splittedPropertyPath = explode('.', $propertyPath);
        return $this->‪traverseProperties($splittedPropertyPath);
    }
 
    public function ‪traverseProperties(array $splittedPropertyPath)
    {
        if (empty($splittedPropertyPath)) {
            return $this;
        }
 
        $currentProperty = array_shift($splittedPropertyPath);
        if (!isset($this->subConfigurationForProperty[$currentProperty])) {
            $type = static::class;
            if (isset($this->subConfigurationForProperty[self::PROPERTY_PATH_PLACEHOLDER])) {
                $this->subConfigurationForProperty[$currentProperty] = clone $this->subConfigurationForProperty[‪self::PROPERTY_PATH_PLACEHOLDER];
            } else {
                $this->subConfigurationForProperty[$currentProperty] = new $type();
            }
        }
        return $this->subConfigurationForProperty[$currentProperty]->traverseProperties($splittedPropertyPath);
    }
 
    public function ‪getTypeConverter()
    {
        return ‪$this->typeConverter;
    }
 
    public function ‪setTypeConverter(‪TypeConverterInterface ‪$typeConverter)
    {
        $this->typeConverter = ‪$typeConverter;
        return $this;
    }
}