FilesContentObject.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Frontend\ContentObject;

/*
 * 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!
 */

use TYPO3\CMS\Core\TypoScript\TypoScriptService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Frontend\Resource\FileCollector;

class FilesContentObject extends AbstractContentObject
{
    public function render($conf = [])
    {
        if (!empty($conf['if.']) && !$this->cObj->checkIf($conf['if.'])) {
            return '';
        }
        // Store the original "currentFile" within a variable so it can be re-applied later-on
        $originalFileInContentObject = $this->cObj->getCurrentFile();

        $fileCollector = $this->findAndSortFiles($conf);
        $fileObjects = $fileCollector->getFiles();
        $availableFileObjectCount = count($fileObjects);

        // optionSplit applied to conf to allow different settings per file
        $splitConf = GeneralUtility::makeInstance(TypoScriptService::class)
            ->explodeConfigurationForOptionSplit($conf, $availableFileObjectCount);

        $start = 0;
        if (!empty($conf['begin'])) {
            $start = (int)$conf['begin'];
        }
        if (!empty($conf['begin.'])) {
            $start = (int)$this->cObj->stdWrap($start, $conf['begin.']);
        }
        $start = MathUtility::forceIntegerInRange($start, 0, $availableFileObjectCount);

        $limit = $availableFileObjectCount;
        if (!empty($conf['maxItems'])) {
            $limit = (int)$conf['maxItems'];
        }
        if (!empty($conf['maxItems.'])) {
            $limit = (int)$this->cObj->stdWrap($limit, $conf['maxItems.']);
        }

        $end = MathUtility::forceIntegerInRange($start + $limit, $start, $availableFileObjectCount);

        if (isset($GLOBALS['TSFE'])) {
            $GLOBALS['TSFE']->register['FILES_COUNT'] = min($limit, $availableFileObjectCount);
        }
        $fileObjectCounter = 0;
        $keys = array_keys($fileObjects);

        $content = '';
        for ($i = $start; $i < $end; $i++) {
            $key = $keys[$i];
            $fileObject = $fileObjects[$key];

            if (isset($GLOBALS['TSFE'])) {
                $GLOBALS['TSFE']->register['FILE_NUM_CURRENT'] = $fileObjectCounter;
            }
            $this->cObj->setCurrentFile($fileObject);
            $content .= $this->cObj->cObjGetSingle($splitConf[$key]['renderObj'], $splitConf[$key]['renderObj.']);
            $fileObjectCounter++;
        }

        // Reset current file within cObj to the original file after rendering output of FILES
        // so e.g. stdWrap is not working on the last current file applied, thus avoiding side-effects
        $this->cObj->setCurrentFile($originalFileInContentObject);

        return $this->cObj->stdWrap($content, $conf['stdWrap.']);
    }

    protected function findAndSortFiles(array $conf)
    {
        $fileCollector = $this->getFileCollector();

        // Getting the files
        if ($conf['references'] || $conf['references.']) {
            /*
            The TypoScript could look like this:
            # all items related to the page.media field:
            references {
                table = pages
                uid.data = page:uid
                fieldName = media
            }
            # or: sys_file_references with uid 27:
            references = 27
             */
            $referencesUidList = $this->cObj->stdWrapValue('references', $conf);
            $referencesUids = GeneralUtility::intExplode(',', $referencesUidList, true);
            $fileCollector->addFileReferences($referencesUids);

            if (!empty($conf['references.'])) {
                $this->addFileReferences($conf, (array)$this->cObj->data, $fileCollector);
            }
        }

        if ($conf['files'] || $conf['files.']) {
            /*
            The TypoScript could look like this:
            # with sys_file UIDs:
            files = 12,14,15# using stdWrap:
            files.field = some_field
             */
            $fileUids = GeneralUtility::intExplode(',', $this->cObj->stdWrapValue('files', $conf), true);
            $fileCollector->addFiles($fileUids);
        }

        if ($conf['collections'] || $conf['collections.']) {
            $collectionUids = GeneralUtility::intExplode(',', $this->cObj->stdWrapValue('collections', $conf), true);
            $fileCollector->addFilesFromFileCollections($collectionUids);
        }

        if ($conf['folders'] || $conf['folders.']) {
            $folderIdentifiers = GeneralUtility::trimExplode(',', $this->cObj->stdWrapValue('folders', $conf));
            $fileCollector->addFilesFromFolders($folderIdentifiers, !empty($conf['folders.']['recursive']));
        }

        // Enable sorting for multiple fileObjects
        $sortingProperty = '';
        if ($conf['sorting'] || $conf['sorting.']) {
            $sortingProperty = $this->cObj->stdWrapValue('sorting', $conf);
        }
        if ($sortingProperty !== '') {
            $sortingDirection = isset($conf['sorting.']['direction']) ? $conf['sorting.']['direction'] : '';
            if (isset($conf['sorting.']['direction.'])) {
                $sortingDirection = $this->cObj->stdWrap($sortingDirection, $conf['sorting.']['direction.']);
            }
            $fileCollector->sort($sortingProperty, $sortingDirection);
        }

        return $fileCollector;
    }

    protected function addFileReferences(array $configuration, array $element, FileCollector $fileCollector)
    {

        // It's important that this always stays "fieldName" and not be renamed to "field" as it would otherwise collide with the stdWrap key of that name
        $referencesFieldName = $this->cObj->stdWrapValue('fieldName', $configuration['references.']);

        // If no reference fieldName is set, there's nothing to do
        if (empty($referencesFieldName)) {
            return;
        }

        $currentId = !empty($element['uid']) ? $element['uid'] : 0;
        $tableName = $this->cObj->getCurrentTable();

        // Fetch the references of the default element
        $referencesForeignTable = $this->cObj->stdWrapValue('table', $configuration['references.'], $tableName);
        $referencesForeignUid = $this->cObj->stdWrapValue('uid', $configuration['references.'], $currentId);

        $pageRepository = $this->getPageRepository();
        // Fetch element if definition has been modified via TypoScript
        if ($referencesForeignTable !== $tableName || $referencesForeignUid !== $currentId) {
            $element = $pageRepository->getRawRecord(
                $referencesForeignTable,
                $referencesForeignUid,
                '*',
                false
            );

            $pageRepository->versionOL($referencesForeignTable, $element, true);
            if ($referencesForeignTable === 'pages') {
                $element = $pageRepository->getPageOverlay($element);
            } else {
                $element = $pageRepository->getRecordOverlay(
                    $referencesForeignTable,
                    $element,
                    $GLOBALS['TSFE']->sys_language_content,
                    $GLOBALS['TSFE']->sys_language_contentOL
                );
            }
        }

        if (is_array($element)) {
            $fileCollector->addFilesFromRelation($referencesForeignTable, $referencesFieldName, $element);
        }
    }

    protected function getPageRepository()
    {
        return $GLOBALS['TSFE']->sys_page;
    }

    protected function getFileCollector()
    {
        return GeneralUtility::makeInstance(FileCollector::class);
    }
}