RecordsContentObject.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\ContentObject;
 
use Psr\Log\LogLevel;
use ‪TYPO3\CMS\Core\Database\RelationHandler;
use ‪TYPO3\CMS\Core\TimeTracker\TimeTracker;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Frontend\Category\Collection\CategoryCollection;
 
class ‪RecordsContentObject extends ‪AbstractContentObject
{
    protected ‪$itemArray = [];
 
    protected ‪$data = [];
 
    public function ‪__construct(
        private readonly ‪TimeTracker $timeTracker,
    ) {}
 
    public function ‪render($conf = [])
    {
        // Reset items and data
        $this->itemArray = [];
        $this->data = [];
        $frontendController = $this->‪getTypoScriptFrontendController();
 
        $theValue = '';
        $originalRec = $frontendController->currentRecord;
        // If the currentRecord is set, we register that this record has invoked this function.
        // It should not be allowed to do this again then.
        if ($originalRec) {
            if (!($frontendController->recordRegister[$originalRec] ?? false)) {
                $frontendController->recordRegister[$originalRec] = 0;
            }
            ++$frontendController->recordRegister[$originalRec];
        }
 
        $tables = (string)$this->cObj->stdWrapValue('tables', $conf ?? []);
        if ($tables !== '') {
            $tablesArray = array_unique(‪GeneralUtility::trimExplode(',', $tables, true));
            // Add tables which have a configuration (note that this may create duplicate entries)
            if (is_array($conf['conf.'] ?? false)) {
                foreach ($conf['conf.'] as $key => $value) {
                    if (!str_ends_with($key, '.') && !in_array($key, $tablesArray)) {
                        $tablesArray[] = $key;
                    }
                }
            }
 
            // Get the data, depending on collection method.
            // Property "source" is considered more precise and thus takes precedence over "categories"
            $source = (string)$this->cObj->stdWrapValue('source', $conf ?? []);
            $categories = (string)$this->cObj->stdWrapValue('categories', $conf ?? []);
            if ($source !== '') {
                $this->‪collectRecordsFromSource($source, $tablesArray);
            } elseif ($categories !== '') {
                $relationField = (string)$this->cObj->stdWrapValue('relation', $conf['categories.'] ?? []);
                $this->‪collectRecordsFromCategories($categories, $tablesArray, $relationField);
            }
            if (!empty($this->itemArray)) {
                ‪$cObj = GeneralUtility::makeInstance(ContentObjectRenderer::class, $frontendController);
                ‪$cObj->‪setParent($this->cObj->data, $this->cObj->currentRecord);
                $this->cObj->currentRecordNumber = 0;
                $pageRepository = $this->‪getPageRepository();
                foreach ($this->itemArray as $val) {
                    $row = $this->data[$val['table']][$val['id']] ?? null;
                    if ($row === null) {
                        continue;
                    }
                    // Perform overlays if necessary (records coming from category collections are already overlaid)
                    if ($source) {
                        // Versioning preview
                        $pageRepository->versionOL($val['table'], $row);
                        // Language overlay
                        if (is_array($row)) {
                            $row = $pageRepository->getLanguageOverlay($val['table'], $row);
                        }
                    }
                    // Might be unset during the overlay process
                    if (is_array($row)
                        && $this->‪isRecordsPageAccessible($val['table'], $row, $conf ?? [])
                        && !($frontendController->recordRegister[$val['table'] . ':' . $val['id']] ?? false)
                    ) {
                        $renderObjName = ($conf['conf.'][$val['table']] ?? false) ? $conf['conf.'][$val['table']] : '<' . $val['table'];
                        $renderObjKey = ($conf['conf.'][$val['table']] ?? false) ? 'conf.' . $val['table'] : '';
                        $renderObjConf = ($conf['conf.'][$val['table'] . '.'] ?? false) ? $conf['conf.'][$val['table'] . '.'] : [];
                        $this->cObj->currentRecordNumber++;
                        ‪$cObj->parentRecordNumber = $this->cObj->currentRecordNumber;
                        $frontendController->currentRecord = $val['table'] . ':' . $val['id'];
                        $this->cObj->‪lastChanged($row['tstamp'] ?? 0);
                        ‪$cObj->‪setRequest($this->request);
                        ‪$cObj->‪start($row, $val['table']);
                        $tmpValue = ‪$cObj->‪cObjGetSingle($renderObjName, $renderObjConf, $renderObjKey);
                        $theValue .= $tmpValue;
                    }
                }
            }
        }
        $wrap = $this->cObj->stdWrapValue('wrap', $conf);
        if ($wrap) {
            $theValue = $this->cObj->wrap($theValue, $wrap);
        }
        if (isset($conf['stdWrap.'])) {
            $theValue = $this->cObj->stdWrap($theValue, $conf['stdWrap.']);
        }
        // Restore
        $frontendController->currentRecord = $originalRec;
        if ($originalRec) {
            --$frontendController->recordRegister[$originalRec];
        }
        return $theValue;
    }
 
    protected function ‪isRecordsPageAccessible(string $table, array $row, array $conf): bool
    {
        $pageId = (int)($table === 'pages' ? $row['uid'] : $row['pid']);
        if ($pageId === $this->request->getAttribute('frontend.page.information')->getId()) {
            // Access to current page has already been checked before rendering this content object.
            return true;
        }
        if ($this->cObj->stdWrapValue('dontCheckPid', $conf)) {
            return true;
        }
        $validPageId = $this->‪getPageRepository()->filterAccessiblePageIds([$pageId]);
        return $validPageId !== [];
    }
 
    protected function ‪collectRecordsFromSource($source, array $tables)
    {
        $loadDB = GeneralUtility::makeInstance(RelationHandler::class);
        $loadDB->start($source, implode(',', $tables));
        foreach ($loadDB->tableArray as $table => $v) {
            if (isset(‪$GLOBALS['TCA'][$table])) {
                $constraints = $this->‪getPageRepository()->getDefaultConstraints($table);
                if ($constraints !== []) {
                    $loadDB->additionalWhere[$table] = implode(' AND ', $constraints);
                }
            }
        }
        $this->data = $loadDB->getFromDB();
        reset($loadDB->itemArray);
        $this->itemArray = $loadDB->itemArray;
    }
 
    protected function ‪collectRecordsFromCategories($selectedCategories, array $tables, $relationField)
    {
        $selectedCategories = array_unique(‪GeneralUtility::intExplode(',', $selectedCategories, true));
 
        // Loop on all selected tables
        foreach ($tables as $table) {
            // Get the records for each selected category
            $tableRecords = [];
            $categoriesPerRecord = [];
            foreach ($selectedCategories as $aCategory) {
                try {
                    $collection = ‪CategoryCollection::load(
                        $aCategory,
                        true,
                        $table,
                        $relationField
                    );
                    if ($collection->count() > 0) {
                        // Add items to the collection of records for the current table
                        foreach ($collection as $item) {
                            $tableRecords[$item['uid']] = $item;
                            // Keep track of all categories a given item belongs to
                            if (!isset($categoriesPerRecord[$item['uid']])) {
                                $categoriesPerRecord[$item['uid']] = [];
                            }
                            $categoriesPerRecord[$item['uid']][] = $aCategory;
                        }
                    }
                } catch (\Exception $e) {
                    $message = sprintf(
                        'Could not get records for category id %d. Error: %s (%d)',
                        $aCategory,
                        $e->getMessage(),
                        $e->getCode()
                    );
                    $this->timeTracker->setTSlogMessage($message, LogLevel::WARNING);
                }
            }
            // Store the resulting records into the itemArray and data results array
            if (!empty($tableRecords)) {
                $this->data[$table] = [];
                foreach ($tableRecords as ‪$record) {
                    $this->itemArray[] = [
                        'id' => ‪$record['uid'],
                        'table' => $table,
                    ];
                    // Add to the record the categories it belongs to
                    ‪$record['_categories'] = implode(',', $categoriesPerRecord[‪$record['uid']]);
                    $this->data[$table][‪$record['uid']] = ‪$record;
                }
            }
        }
    }
}