9.5/_records_content_object_8php_source.html

<?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\Database\RelationHandler;

use ‪TYPO3\CMS\Core\TimeTracker\TimeTracker;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Frontend\Category\Collection\CategoryCollection;

use ‪TYPO3\CMS\Frontend\Page\PageRepository;


class ‪RecordsContentObject extends ‪AbstractContentObject

{

    protected ‪$itemArray = [];


    protected ‪$data = [];


    public function ‪render($conf = [])

    {

        // Reset items and data

        $this->itemArray = [];

        $this->data = [];


        $theValue = '';

        $originalRec = ‪$GLOBALS['TSFE']->currentRecord;

        // If the currentRecord is set, we register, that this record has invoked this function.

        // It's should not be allowed to do this again then!!

        if ($originalRec) {

            ++‪$GLOBALS['TSFE']->recordRegister[$originalRec];

        }


        $tables = isset($conf['tables.']) ? $this->cObj->stdWrap($conf['tables'], $conf['tables.']) : $conf['tables'];

        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.'])) {

                foreach ($conf['conf.'] as $key => $value) {

                    if (substr($key, -1) !== '.' && !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 = isset($conf['source.']) ? $this->cObj->stdWrap($conf['source'], $conf['source.']) : $conf['source'];

            $categories = isset($conf['categories.']) ? $this->cObj->stdWrap($conf['categories'], $conf['categories.']) : $conf['categories'];

            if ($source) {

                $this->collectRecordsFromSource($source, $tablesArray);

            } elseif ($categories) {

                $relationField = isset($conf['categories.']['relation.']) ? $this->cObj->stdWrap($conf['categories.']['relation'], $conf['categories.']['relation.']) : $conf['categories.']['relation'];

                $this->‪collectRecordsFromCategories($categories, $tablesArray, $relationField);

            }

            $itemArrayCount = count($this->itemArray);

            if ($itemArrayCount > 0) {

                ‪$cObj = GeneralUtility::makeInstance(ContentObjectRenderer::class);

                ‪$cObj->‪setParent($this->cObj->data, $this->cObj->currentRecord);

                $this->cObj->currentRecordNumber = 0;

                $this->cObj->currentRecordTotal = $itemArrayCount;

                foreach ($this->itemArray as $val) {

                    $row = $this->data[$val['table']][$val['id']];

                    // Perform overlays if necessary (records coming from category collections are already overlaid)

                    if ($source) {

                        // Versioning preview

                        $this->‪getPageRepository()->‪versionOL($val['table'], $row);

                        // Language overlay

                        if (is_array($row)) {

                            $row = $this->‪getPageRepository()->‪getLanguageOverlay($val['table'], $row);

                        }

                    }

                    // Might be unset during the overlay process

                    if (is_array($row)) {

                        $dontCheckPid = isset($conf['dontCheckPid.']) ? $this->cObj->stdWrap($conf['dontCheckPid'], $conf['dontCheckPid.']) : $conf['dontCheckPid'];

                        if (!$dontCheckPid) {

                            $row = $this->cObj->checkPid($row['pid']) ? $row : '';

                        }

                        if ($row && !‪$GLOBALS['TSFE']->recordRegister[$val['table'] . ':' . $val['id']]) {

                            $renderObjName = $conf['conf.'][$val['table']] ?: '<' . $val['table'];

                            $renderObjKey = $conf['conf.'][$val['table']] ? 'conf.' . $val['table'] : '';

                            $renderObjConf = $conf['conf.'][$val['table'] . '.'];

                            $this->cObj->currentRecordNumber++;

                            ‪$cObj->parentRecordNumber = $this->cObj->currentRecordNumber;

                            ‪$GLOBALS['TSFE']->currentRecord = $val['table'] . ':' . $val['id'];

                            $this->cObj->lastChanged($row['tstamp']);

                            ‪$cObj->‪start($row, $val['table']);

                            $tmpValue = ‪$cObj->‪cObjGetSingle($renderObjName, $renderObjConf, $renderObjKey);

                            $theValue .= $tmpValue;

                        }

                    }

                }

            }

        }

        $wrap = isset($conf['wrap.']) ? $this->cObj->stdWrap($conf['wrap'], $conf['wrap.']) : $conf['wrap'];

        if ($wrap) {

            $theValue = $this->cObj->wrap($theValue, $wrap);

        }

        if (isset($conf['stdWrap.'])) {

            $theValue = $this->cObj->stdWrap($theValue, $conf['stdWrap.']);

        }

        // Restore

        ‪$GLOBALS['TSFE']->currentRecord = $originalRec;

        if ($originalRec) {

            --‪$GLOBALS['TSFE']->recordRegister[$originalRec];

        }

        return $theValue;

    }


    protected function collectRecordsFromSource($source, array $tables)

    {

        $loadDB = GeneralUtility::makeInstance(RelationHandler::class);

        $loadDB->setFetchAllFields(true);

        $loadDB->start($source, implode(',', $tables));

        foreach ($loadDB->tableArray as $table => $v) {

            if (isset(‪$GLOBALS['TCA'][$table])) {

                $loadDB->additionalWhere[$table] = $this->‪getPageRepository()->‪enableFields($table);

            }

        }

        $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->‪getTimeTracker()->‪setTSlogMessage($message, 2);

                }

            }

            // 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;

                }

            }

        }

    }


    protected function ‪getTimeTracker()

    {

        return GeneralUtility::makeInstance(TimeTracker::class);

    }


    protected function ‪getPageRepository(): ‪PageRepository

    {

        return ‪$GLOBALS['TSFE']->sys_page ?: GeneralUtility::makeInstance(PageRepository::class);

    }

}