‪TYPO3CMS  10.4
ArrayConverter.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
5 /*
6  * This file is part of the TYPO3 CMS project.
7  *
8  * It is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License, either version 2
10  * of the License, or any later version.
11  *
12  * For the full copyright and license information, please read the
13  * LICENSE.txt file that was distributed with this source code.
14  *
15  * The TYPO3 project - inspiring people to share!
16  */
17 
19 
23 
28 {
29  public const ‪CONFIGURATION_DELIMITER = 'delimiter';
30  public const ‪CONFIGURATION_REMOVE_EMPTY_VALUES = 'removeEmptyValues';
31  public const ‪CONFIGURATION_LIMIT = 'limit';
32 
36  protected ‪$sourceTypes = ['array', 'string'];
37 
41  protected ‪$targetType = 'array';
42 
46  protected ‪$priority = 10;
47 
56  public function ‪canConvertFrom($source, string ‪$targetType): bool
57  {
58  return is_string($source) || is_array($source);
59  }
60 
72  public function ‪convertFrom($source, string ‪$targetType, array $convertedChildProperties = [], ‪PropertyMappingConfigurationInterface $configuration = null)
73  {
74  if (!is_string($source)) {
75  return $source;
76  }
77  if ($source === '') {
78  return [];
79  }
80  if ($configuration === null) {
81  return $source;
82  }
83  $delimiter = $configuration->getConfigurationValue(self::class, self::CONFIGURATION_DELIMITER);
84  $removeEmptyValues = $configuration->getConfigurationValue(self::class, self::CONFIGURATION_REMOVE_EMPTY_VALUES) ?? false;
85  $limit = $configuration->getConfigurationValue(self::class, self::CONFIGURATION_LIMIT) ?? 0;
86  if (!is_string($delimiter)) {
87  throw new TypeConverterException('No delimiter configured for ' . self::class . ' and non-empty value given.', 1582877555);
88  }
89  $source = ‪GeneralUtility::trimExplode($delimiter, $source, $removeEmptyValues, $limit);
90 
91  return $source;
92  }
93 }
‪TYPO3\CMS\Extbase\Property\Exception\TypeConverterException
Definition: TypeConverterException.php:26
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\$targetType
‪string $targetType
Definition: ArrayConverter.php:39
‪TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface
Definition: PropertyMappingConfigurationInterface.php:22
‪TYPO3\CMS\Extbase\Property\TypeConverter
Definition: AbstractFileCollectionConverter.php:18
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\CONFIGURATION_LIMIT
‪const CONFIGURATION_LIMIT
Definition: ArrayConverter.php:31
‪TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode
‪static string[] trimExplode($delim, $string, $removeEmptyValues=false, $limit=0)
Definition: GeneralUtility.php:1059
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\canConvertFrom
‪bool canConvertFrom($source, string $targetType)
Definition: ArrayConverter.php:53
‪TYPO3\CMS\Extbase\Property\TypeConverter\AbstractTypeConverter
Definition: AbstractTypeConverter.php:34
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter
Definition: ArrayConverter.php:28
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\CONFIGURATION_DELIMITER
‪const CONFIGURATION_DELIMITER
Definition: ArrayConverter.php:29
‪TYPO3\CMS\Core\Utility\GeneralUtility
Definition: GeneralUtility.php:46
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\$priority
‪int $priority
Definition: ArrayConverter.php:43
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\CONFIGURATION_REMOVE_EMPTY_VALUES
‪const CONFIGURATION_REMOVE_EMPTY_VALUES
Definition: ArrayConverter.php:30
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\$sourceTypes
‪string[] $sourceTypes
Definition: ArrayConverter.php:35
‪TYPO3\CMS\Extbase\Property\TypeConverter\ArrayConverter\convertFrom
‪array string convertFrom($source, string $targetType, array $convertedChildProperties=[], PropertyMappingConfigurationInterface $configuration=null)
Definition: ArrayConverter.php:69