AbstractFileFolderConverter.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\TypeConverter;
 
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Resource\ResourceInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Domain\Model\File;
use ‪TYPO3\CMS\Extbase\Domain\Model\FileReference;
use ‪TYPO3\CMS\Extbase\Domain\Model\Folder;
use ‪TYPO3\CMS\Extbase\Property\Exception;
use ‪TYPO3\CMS\Extbase\Property\PropertyMappingConfigurationInterface;
 
abstract class ‪AbstractFileFolderConverter extends ‪AbstractTypeConverter
{
    protected ‪$expectedObjectType;
 
    protected ‪$fileFactory;
 
    public function ‪injectFileFactory(‪ResourceFactory ‪$fileFactory): void
    {
        $this->fileFactory = ‪$fileFactory;
    }
 
    public function ‪convertFrom(
        $source,
        string $targetType,
        array $convertedChildProperties = [],
        ‪PropertyMappingConfigurationInterface $configuration = null
    ): ‪File|‪FileReference|‪Folder {
        $object = $this->‪getOriginalResource($source);
        if (empty($this->expectedObjectType) || !$object instanceof $this->expectedObjectType) {
            throw new ‪Exception('Expected object of type "' . $this->expectedObjectType . '" but got ' . (is_object($object) ? get_class($object) : 'null'), 1342895975);
        }
        $subject = GeneralUtility::makeInstance($targetType);
        $subject->setOriginalResource($object);
        return $subject;
    }
 
    abstract protected function ‪getOriginalResource($source): ?ResourceInterface;
}