FilesProcessor.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\Frontend\DataProcessing;
 
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use ‪TYPO3\CMS\Frontend\ContentObject\DataProcessorInterface;
use ‪TYPO3\CMS\Frontend\Resource\FileCollector;
 
class ‪FilesProcessor implements ‪DataProcessorInterface
{
    public function ‪process(‪ContentObjectRenderer $cObj, array $contentObjectConfiguration, array $processorConfiguration, array $processedData)
    {
        if (isset($processorConfiguration['if.']) && !$cObj->‪checkIf($processorConfiguration['if.'])) {
            return $processedData;
        }
 
        // gather data
        $fileCollector = GeneralUtility::makeInstance(FileCollector::class);
 
        // references / relations
        if (
            (isset($processorConfiguration['references']) && $processorConfiguration['references'])
            || (isset($processorConfiguration['references.']) && $processorConfiguration['references.'])
        ) {
            $referencesUidList = $cObj->‪stdWrapValue('references', $processorConfiguration);
            $referencesUids = ‪GeneralUtility::intExplode(',', $referencesUidList, true);
            $fileCollector->addFileReferences($referencesUids);
 
            if (!empty($processorConfiguration['references.'])) {
                $referenceConfiguration = $processorConfiguration['references.'];
                $relationField = $cObj->‪stdWrapValue('fieldName', $referenceConfiguration);
 
                // If no reference fieldName is set, there's nothing to do
                if (!empty($relationField)) {
                    // Fetch the references of the default element
                    $relationTable = $cObj->‪stdWrapValue('table', $referenceConfiguration, $cObj->‪getCurrentTable());
                    if (!empty($relationTable)) {
                        $fileCollector->addFilesFromRelation($relationTable, $relationField, $cObj->data);
                    }
                }
            }
        }
 
        // files
        $files = $cObj->‪stdWrapValue('files', $processorConfiguration);
        if ($files) {
            $files = ‪GeneralUtility::intExplode(',', (string)$files, true);
            $fileCollector->addFiles($files);
        }
 
        // collections
        $collections = $cObj->‪stdWrapValue('collections', $processorConfiguration);
        if (!empty($collections)) {
            $collections = ‪GeneralUtility::trimExplode(',', (string)$collections, true);
            $fileCollector->addFilesFromFileCollections($collections);
        }
 
        // folders
        $folders = $cObj->‪stdWrapValue('folders', $processorConfiguration);
        if (!empty($folders)) {
            $folders = ‪GeneralUtility::trimExplode(',', (string)$folders, true);
            $fileCollector->addFilesFromFolders($folders, !empty($processorConfiguration['folders.']['recursive']));
        }
 
        // make sure to sort the files
        $sortingProperty = $cObj->‪stdWrapValue('sorting', $processorConfiguration);
        if ($sortingProperty) {
            $sortingDirection = $cObj->‪stdWrapValue(
                'direction',
                $processorConfiguration['sorting.'] ?? [],
                'ascending'
            );
 
            $fileCollector->sort($sortingProperty, $sortingDirection);
        }
 
        // set the files into a variable, default "files"
        $targetVariableName = $cObj->‪stdWrapValue('as', $processorConfiguration, 'files');
        $processedData[$targetVariableName] = $fileCollector->getFiles();
 
        return $processedData;
    }
}