FileCollector.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\Frontend\Resource;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\LinkHandling\LinkService;
use ‪TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection;
use ‪TYPO3\CMS\Core\Resource\Exception;
use ‪TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException;
use ‪TYPO3\CMS\Core\Resource\FileCollectionRepository;
use ‪TYPO3\CMS\Core\Resource\FileInterface;
use ‪TYPO3\CMS\Core\Resource\FileRepository;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FileCollector implements \Countable, LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    protected array ‪$files = [];
 
    public function ‪__construct(
        protected readonly ‪ResourceFactory $resourceFactory,
        protected readonly ‪FileCollectionRepository $fileCollectionRepository,
        protected readonly ‪FileRepository $fileRepository,
    ) {
    }
 
    public function ‪addFiles(array $fileUids = []): void
    {
        foreach ($fileUids as $fileUid) {
            try {
                $this->‪addFileObject($this->resourceFactory->getFileObject($fileUid));
            } catch (‪Exception $e) {
                $this->logger->warning(
                    'The file with uid  "' . $fileUid
                    . '" could not be found and won\'t be included in frontend output',
                    ['exception' => $e]
                );
            }
        }
    }
 
    public function ‪addFilesFromRelation(string $relationTable, string $relationField, array $referenceRecord): void
    {
        $fileReferences = $this->‪getFileReferences($relationTable, $relationField, $referenceRecord);
        if (!empty($fileReferences)) {
            $this->‪addFileObjects($fileReferences);
        }
    }
 
    public function ‪addFileReferences(array $fileReferenceUids = []): void
    {
        foreach ($fileReferenceUids as $fileReferenceUid) {
            $fileObject = $this->resourceFactory->getFileReferenceObject((int)$fileReferenceUid);
            if (!$fileObject instanceof ‪FileInterface) {
                continue;
            }
            $this->‪addFileObject($fileObject);
        }
    }
 
    public function ‪addFilesFromFileCollections(array $fileCollectionUids = []): void
    {
        foreach ($fileCollectionUids as $fileCollectionUid) {
            $this->‪addFilesFromFileCollection((int)$fileCollectionUid);
        }
    }
 
    public function ‪addFilesFromFileCollection(int $fileCollectionUid): void
    {
        if ($fileCollectionUid <= 0) {
            return;
        }
        try {
            $fileCollection = $this->fileCollectionRepository->findByUid($fileCollectionUid);
            if ($fileCollection instanceof ‪AbstractFileCollection) {
                $fileCollection->loadContents();
                ‪$files = $fileCollection->getItems();
                $this->‪addFileObjects($files);
            }
        } catch (‪Exception $e) {
            $this->logger->warning(
                'The file-collection with uid  "' . $fileCollectionUid
                . '" could not be found or contents could not be loaded and won\'t be included in frontend output.',
                ['exception' => $e]
            );
        }
    }
 
    public function ‪addFilesFromFolders(array $folderIdentifiers, bool $recursive = false): void
    {
        foreach ($folderIdentifiers as $folderIdentifier) {
            $this->‪addFilesFromFolder($folderIdentifier, $recursive);
        }
    }
 
    public function ‪addFilesFromFolder(string $folderIdentifier, bool $recursive = false): void
    {
        if ($folderIdentifier) {
            try {
                if (str_starts_with($folderIdentifier, 't3://folder')) {
                    // a t3://folder link to a folder in FAL
                    $linkService = GeneralUtility::makeInstance(LinkService::class);
                    $data = $linkService->resolveByStringRepresentation($folderIdentifier);
                    $folder = $data['folder'];
                } else {
                    $folder = $this->resourceFactory->getFolderObjectFromCombinedIdentifier($folderIdentifier);
                }
                if ($folder instanceof ‪Folder) {
                    ‪$files = $folder->getFiles(0, 0, ‪Folder::FILTER_MODE_USE_OWN_AND_STORAGE_FILTERS, $recursive);
                    $this->‪addFileObjects(array_values(‪$files));
                }
            } catch (‪Exception $e) {
                $this->logger->warning('The folder with identifier "{folder}" could not be found and won\'t be included in frontend output', [
                    'folder' => $folderIdentifier,
                    'exception' => $e,
                ]);
            }
        }
    }
 
    public function ‪sort(string $sortingProperty = '', string $sortingOrder = 'ascending'): void
    {
        if ($sortingProperty !== '' && ‪count($this->files) > 1) {
            @usort(
                $this->files,
                static function (
                    ‪FileInterface $a,
                    ‪FileInterface $b
                ) use ($sortingProperty) {
                    if ($a->‪hasProperty($sortingProperty) && $b->‪hasProperty($sortingProperty)) {
                        return strnatcasecmp($a->getProperty($sortingProperty), $b->getProperty($sortingProperty));
                    }
                    return 0;
                }
            );
 
            switch (strtolower($sortingOrder)) {
                case 'descending':
                case 'desc':
                    $this->files = array_reverse($this->files);
                    break;
                case 'random':
                case 'rand':
                    shuffle($this->files);
                    break;
            }
        }
    }
 
    public function ‪addFileObject(‪FileInterface $file): void
    {
        $this->files[] = $file;
    }
 
    public function ‪addFileObjects(array ‪$files): void
    {
        $this->files = array_merge($this->files, ‪$files);
    }
 
    public function ‪getFiles(): array
    {
        return ‪$this->files;
    }
 
    public function ‪count(): int
    {
        return ‪count($this->files);
    }
 
    protected function ‪getFileReferences(string $tableName, string $fieldName, array $element): array
    {
        $currentId = !empty($element['uid']) ? (int)$element['uid'] : 0;
 
        // Fetch the references of the default element
        try {
            $references = $this->fileRepository->findByRelation($tableName, $fieldName, $currentId);
        } catch (‪FileDoesNotExistException $e) {
            return [];
        } catch (\InvalidArgumentException $e) {
            $this->logger->error('{exception_message}: table: {table}, field: {field}, currentId: {current_id}', [
                'table' => $tableName,
                'field' => $fieldName,
                'currentId' => $currentId,
                'exception' => $e,
            ]);
            return [];
        }
 
        $localizedId = null;
        if (isset($element['_LOCALIZED_UID'])) {
            $localizedId = $element['_LOCALIZED_UID'];
        } elseif (isset($element['_PAGES_OVERLAY_UID'])) {
            $localizedId = $element['_PAGES_OVERLAY_UID'];
        }
 
        $isTableLocalizable = (
            !empty(‪$GLOBALS['TCA'][$tableName]['ctrl']['languageField'])
            && !empty(‪$GLOBALS['TCA'][$tableName]['ctrl']['transOrigPointerField'])
        );
        if ($isTableLocalizable && $localizedId !== null) {
            $localizedReferences = $this->fileRepository->findByRelation($tableName, $fieldName, (int)$localizedId);
            $references = $localizedReferences;
        }
 
        return $references;
    }
}