Relation::sortByKeyInIN() - Code Metrics - Inspection of "[TASK] Fix Scrutinizer issues" - TYPO3-Solr/ext-solr - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — task/2976_TYPO3.11_compatibili... ( 9f9205...0f123d )

by Rafael

created 2022-01-23 20:33 UTC

Relation::sortByKeyInIN() A

↳ Parent: Relation

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	9
ccs	7
cts	7
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	3
crap	2

<?php

namespace ApacheSolrForTypo3\Solr\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 ApacheSolrForTypo3\Solr\System\Language\FrontendOverlayService;
use ApacheSolrForTypo3\Solr\System\TCA\TCAService;
use Doctrine\DBAL\Exception as DBALException;
use Doctrine\DBAL\Driver\Statement;
use ReflectionClass;
use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Database\RelationHandler;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\AbstractContentObject;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;

/**
 * A content object (cObj) to resolve relations between database records
 *
 * Configuration options:
 *
 * localField: the record's field to use to resolve relations
 * foreignLabelField: Usually the label field to retrieve from the related records is determined automatically using TCA, using this option the desired field can be specified explicitly
 * multiValue: whether to return related records suitable for a multi value field
 * singleValueGlue: when not using multiValue, the related records need to be concatenated using a glue string, by default this is ", ". Using this option a custom glue can be specified. The custom value must be wrapped by pipe (|) characters.
 * relationTableSortingField: field in a mm relation table to sort by, usually "sorting"
 * enableRecursiveValueResolution: if the specified remote table's label field is a relation to another table, the value will be resolved by following the relation recursively.
 * removeEmptyValues: Removes empty values when resolving relations, defaults to TRUE
 * removeDuplicateValues: Removes duplicate values
 *
 * @author Ingo Renner <[email protected]>
 */
class Relation extends AbstractContentObject
{
    public const CONTENT_OBJECT_NAME = 'SOLR_RELATION';

    /**
     * Content object configuration
     *
     * @var array
     */
    protected array $configuration = [];

    /**
     * @var TCAService
     */
    protected TCAService $tcaService;

    /**
     * @var FrontendOverlayService
     */
    protected FrontendOverlayService $frontendOverlayService;

    /**
     * @var TypoScriptFrontendController|null
     */
    protected ?TypoScriptFrontendController $typoScriptFrontendController = null;

    /**
     * Relation constructor.
     * @param TCAService|null $tcaService
     * @param FrontendOverlayService|null $frontendOverlayService
     */
    public function __construct(
        ContentObjectRenderer $cObj,
        TCAService $tcaService = null,
        FrontendOverlayService $frontendOverlayService = null
    ) {
        parent::__construct($cObj);
        $this->configuration['enableRecursiveValueResolution'] = 1;
        $this->configuration['removeEmptyValues'] = 1;
        $this->tcaService = $tcaService ?? GeneralUtility::makeInstance(TCAService::class);
        $this->typoScriptFrontendController = $this->getProtectedTsfeObjectFromContentObjectRenderer($cObj);
        $this->frontendOverlayService = $frontendOverlayService ?? GeneralUtility::makeInstance(FrontendOverlayService::class, $this->tcaService, $this->typoScriptFrontendController);
    }

    /**
     * Executes the SOLR_RELATION content object.
     *
     * Resolves relations between records. Currently, supported relations are
     * TYPO3-style m:n relations.
     * May resolve single value and multi value relations.
     *
     * @inheritDoc
     *
     * @throws AspectNotFoundException
     */
    public function render($conf = [])
    {
        $this->configuration = array_merge($this->configuration, $conf);

        $relatedItems = $this->getRelatedItems($this->cObj);

        if (!empty($this->configuration['removeDuplicateValues'])) {
            $relatedItems = array_unique($relatedItems);
        }

        if (empty($conf['multiValue'])) {
            // single value, need to concatenate related items
            $singleValueGlue = !empty($conf['singleValueGlue']) ? trim($conf['singleValueGlue'], '|') : ', ';
            $result = implode($singleValueGlue, $relatedItems);
        } else {
            // multi value, need to serialize as content objects must return strings
            $result = serialize($relatedItems);
        }

        return $result;
    }

    /**
     * Gets the related items of the current record's configured field.
     *
     * @param ContentObjectRenderer $parentContentObject parent content object
     *
     * @return array Array of related items, values already resolved from related records
     *
     * @throws AspectNotFoundException
     */
    protected function getRelatedItems(ContentObjectRenderer $parentContentObject): array
    {
        list($table, $uid) = explode(':', $parentContentObject->currentRecord);
        $uid = (int) $uid;
        $field = $this->configuration['localField'];

        if (!$this->tcaService->/** @scrutinizer ignore-call */ getHasConfigurationForField($table, $field)) {
            return [];
        }

        $overlayUid = $this->frontendOverlayService->/** @scrutinizer ignore-call */ getUidOfOverlay($table, $field, $uid);
        $fieldTCA = $this->tcaService->getConfigurationForField($table, $field);

        if (isset($fieldTCA['config']['MM']) && trim($fieldTCA['config']['MM']) !== '') {
            $relatedItems = $this->getRelatedItemsFromMMTable($table, $overlayUid, $fieldTCA);
        } else {
            $relatedItems = $this->getRelatedItemsFromForeignTable($table, $overlayUid, $fieldTCA, $parentContentObject);
        }

        return $relatedItems;
    }

    /**
     * Gets the related items from a table using the n:m relation.
     *
     * @param string $localTableName Local table name
     * @param int $localRecordUid Local record uid
     * @param array $localFieldTca The local table's TCA
     * @return array Array of related items, values already resolved from related records
     *
     * @throws AspectNotFoundException
     * @throws DBALException
     */
    protected function getRelatedItemsFromMMTable(string $localTableName, int $localRecordUid, array $localFieldTca): array
    {
        $relatedItems = [];
        $foreignTableName = $localFieldTca['config']['foreign_table'];
        $foreignTableTca = $this->tcaService->getTableConfiguration($foreignTableName);
        $foreignTableLabelField = $this->resolveForeignTableLabelField($foreignTableTca);
        $mmTableName = $localFieldTca['config']['MM'];

        // Remove the first option of foreignLabelField for recursion
        if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
            $foreignTableLabelFieldArr = explode('.', $this->configuration['foreignLabelField']);
            unset($foreignTableLabelFieldArr[0]);
            $this->configuration['foreignLabelField'] = implode('.', $foreignTableLabelFieldArr);
        }

        $relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
        $relationHandler->start('', $foreignTableName, $mmTableName, $localRecordUid, $localTableName, $localFieldTca['config']);
        $selectUids = $relationHandler->tableArray[$foreignTableName];
        if (!is_array($selectUids) || count($selectUids) <= 0) {
            return $relatedItems;
        }

        $relatedRecords = $this->getRelatedRecords($foreignTableName, ...$selectUids);
        foreach ($relatedRecords as $record) {
            if (isset($foreignTableTca['columns'][$foreignTableLabelField]['config']['foreign_table'])
                && $this->configuration['enableRecursiveValueResolution']
            ) {
                if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
                    $foreignTableLabelFieldArr = explode('.', $this->configuration['foreignLabelField']);
                    unset($foreignTableLabelFieldArr[0]);
                    $this->configuration['foreignLabelField'] = implode('.', $foreignTableLabelFieldArr);
                }

                $this->configuration['localField'] = $foreignTableLabelField;

                $contentObject = GeneralUtility::makeInstance(ContentObjectRenderer::class);
                $contentObject->start($record, $foreignTableName);

                return $this->getRelatedItems($contentObject);
            } else {
                if ($this->getLanguageUid() > 0) {
                    $record = $this->frontendOverlayService->getOverlay($foreignTableName, $record);
                }
                $relatedItems[] = $record[$foreignTableLabelField];
            }
        }

        return $relatedItems;
    }

    /**
     * Resolves the field to use as the related item's label depending on TCA
     * and TypoScript configuration
     *
     * @param array $foreignTableTca The foreign table's TCA
     *
     * @return string|null The field to use for the related item's label
     */
    protected function resolveForeignTableLabelField(array $foreignTableTca): ?string
    {
        $foreignTableLabelField = $foreignTableTca['ctrl']['label'] ?? null;

        // when foreignLabelField is not enabled we can return directly
        if (empty($this->configuration['foreignLabelField'] ?? null)) {
            return $foreignTableLabelField;
        }

        if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
            list($foreignTableLabelField) = explode('.', $this->configuration['foreignLabelField'], 2);
        } else {
            $foreignTableLabelField = $this->configuration['foreignLabelField'];
        }

        return $foreignTableLabelField;
    }

    /**
     * Gets the related items from a table using a 1:n relation.
     *
     * @param string $localTableName Local table name
     * @param int $localRecordUid Local record uid
     * @param array $localFieldTca The local table's TCA
     * @param ContentObjectRenderer $parentContentObject parent content object
     * @return array Array of related items, values already resolved from related records
     *
     * @throws AspectNotFoundException
     * @throws DBALException
     */
    protected function getRelatedItemsFromForeignTable(
        string                $localTableName,
        int                   $localRecordUid,
        array                 $localFieldTca,
        ContentObjectRenderer $parentContentObject
    ): array {
        $relatedItems = [];
        $foreignTableName = $localFieldTca['config']['foreign_table'];
        $foreignTableTca = $this->tcaService->getTableConfiguration($foreignTableName);
        $foreignTableLabelField = $this->resolveForeignTableLabelField($foreignTableTca);

        /** @var $relationHandler RelationHandler */
        $relationHandler = GeneralUtility::makeInstance(RelationHandler::class);

        $itemList = $parentContentObject->data[$this->configuration['localField']] ?? '';

        $relationHandler->start($itemList, $foreignTableName, '', $localRecordUid, $localTableName, $localFieldTca['config']);
        $selectUids = $relationHandler->tableArray[$foreignTableName];

        if (!is_array($selectUids) || count($selectUids) <= 0) {
            return $relatedItems;
        }

        $relatedRecords = $this->getRelatedRecords($foreignTableName, ...$selectUids);

        foreach ($relatedRecords as $relatedRecord) {
            $resolveRelatedValue = $this->resolveRelatedValue(
                $relatedRecord,
                $foreignTableTca,
                $foreignTableLabelField,
                $parentContentObject,
                $foreignTableName
            );
            if (!empty($resolveRelatedValue) || !$this->configuration['removeEmptyValues']) {
                $relatedItems[] = $resolveRelatedValue;
            }
        }

        return $relatedItems;
    }

    /**
     * Resolves the value of the related field. If the related field's value is
     * a relation itself, this method takes care of resolving it recursively.
     *
     * @param array $relatedRecord Related record as array
     * @param array $foreignTableTca TCA of the related table
     * @param string $foreignTableLabelField Field name of the foreign label field
     * @param ContentObjectRenderer $parentContentObject cObject
     * @param string $foreignTableName Related record table name
     *
     * @return string
     *
     * @throws AspectNotFoundException
     * @throws DBALException
     */
    protected function resolveRelatedValue(
        array $relatedRecord,
        $foreignTableTca,
        $foreignTableLabelField,
        ContentObjectRenderer $parentContentObject,
        $foreignTableName = ''
    ): string {
        if ($this->getLanguageUid() > 0 && !empty($foreignTableName)) {
            $relatedRecord = $this->frontendOverlayService->getOverlay($foreignTableName, $relatedRecord);
        }

        $value = $relatedRecord[$foreignTableLabelField];

        if (
            !empty($foreignTableName)
            && isset($foreignTableTca['columns'][$foreignTableLabelField]['config']['foreign_table'])
            && $this->configuration['enableRecursiveValueResolution']
        ) {
            // backup
            $backupRecord = $parentContentObject->data;
            $backupConfiguration = $this->configuration;

            // adjust configuration for next level
            $this->configuration['localField'] = $foreignTableLabelField;
            $parentContentObject->data = $relatedRecord;
            if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
                list(, $this->configuration['foreignLabelField']) = explode(
                    '.',
                    $this->configuration['foreignLabelField'],
                    2
                );
            } else {
                $this->configuration['foreignLabelField'] = '';
            }

            // recursion
            $relatedItemsFromForeignTable = $this->getRelatedItemsFromForeignTable(
                $foreignTableName,
                $relatedRecord['uid'],
                $foreignTableTca['columns'][$foreignTableLabelField],
                $parentContentObject
            );
            $value = array_pop($relatedItemsFromForeignTable);

            // restore
            $this->configuration = $backupConfiguration;
            $parentContentObject->data = $backupRecord;
        }

        return $parentContentObject->stdWrap($value, $this->configuration) ?? '';
    }

    /**
     * Return records via relation.
     *
     * @param string $foreignTable The table to fetch records from.
     * @param int ...$uids The uids to fetch from table.
     * @return array
     *
     * @throws DBALException
     */
    protected function getRelatedRecords(string $foreignTable, int ...$uids): array
    {
        /** @var QueryBuilder $queryBuilder */
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($foreignTable);
        $queryBuilder->select('*')
            ->from($foreignTable)
            ->where(/** @scrutinizer ignore-type */ $queryBuilder->expr()->in('uid', $uids));
        if (isset($this->configuration['additionalWhereClause'])) {
            $queryBuilder->andWhere($this->configuration['additionalWhereClause']);
        }
        $statement = $queryBuilder->execute();

        return $this->sortByKeyInIN($statement, 'uid', ...$uids);
    }

    /**
     * Sorts the result set by key in array for IN values.
     *   Simulates MySqls ORDER BY FIELD(fieldname, COPY_OF_IN_FOR_WHERE)
     *   Example: SELECT * FROM a_table WHERE field_name IN (2, 3, 4) SORT BY FIELD(field_name, 2, 3, 4)
     *
     *
     * @param Statement $statement
     * @param string $columnName
     * @param array $arrayWithValuesForIN
     * @return array
     */
    protected function sortByKeyInIN(Statement $statement, string $columnName, ...$arrayWithValuesForIN): array
    {
        $records = [];
        while ($record = $statement->fetchAssociative()) {
            $indexNumber = array_search($record[$columnName], $arrayWithValuesForIN);
            $records[$indexNumber] = $record;
        }
        ksort($records);
        return $records;
    }

    /**
     * Returns current language id fetched from object properties chain TSFE->context->language aspect->id.
     *
     * @return int
     * @throws AspectNotFoundException
     */
    protected function getLanguageUid(): int
    {
        return (int)$this->typoScriptFrontendController->/** @scrutinizer ignore-call */ getContext()->getPropertyFromAspect('language', 'id');
    }

    /**
     * Returns inaccessible {@link ContentObjectRenderer::typoScriptFrontendController} via reflection.
     *
     * The TypoScriptFrontendController object must be delegated to the whole object aggregation on indexing stack,
     * to be able to use Contexts properties and proceed indexing request.
     *
     * @param ContentObjectRenderer $cObj
     * @return TypoScriptFrontendController|null
     */
    protected function getProtectedTsfeObjectFromContentObjectRenderer(ContentObjectRenderer $cObj): ?TypoScriptFrontendController
    {
        $reflection = new ReflectionClass($cObj);
        $property = $reflection->getProperty('typoScriptFrontendController');
        $property->setAccessible(true);
        return $property->getValue($cObj);
    }
}


1		<?php
2
3		namespace ApacheSolrForTypo3\Solr\ContentObject;
4
5		/*
6		* This file is part of the TYPO3 CMS project.
7		*
8		* It is free software; you can redistribute it and/or modify it under
9		* the terms of the GNU General Public License, either version 2
10		* of the License, or any later version.
11		*
12		* For the full copyright and license information, please read the
13		* LICENSE.txt file that was distributed with this source code.
14		*
15		* The TYPO3 project - inspiring people to share!
16		*/
17
18		use ApacheSolrForTypo3\Solr\System\Language\FrontendOverlayService;
19		use ApacheSolrForTypo3\Solr\System\TCA\TCAService;
20		use Doctrine\DBAL\Exception as DBALException;
21		use Doctrine\DBAL\Driver\Statement;
22		use ReflectionClass;
23		use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
24		use TYPO3\CMS\Core\Database\ConnectionPool;
25		use TYPO3\CMS\Core\Database\Query\QueryBuilder;
26		use TYPO3\CMS\Core\Database\RelationHandler;
27		use TYPO3\CMS\Core\Utility\GeneralUtility;
28		use TYPO3\CMS\Frontend\ContentObject\AbstractContentObject;
29		use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
30		use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
31
32		/**
33		* A content object (cObj) to resolve relations between database records
34		*
35		* Configuration options:
36		*
37		* localField: the record's field to use to resolve relations
38		* foreignLabelField: Usually the label field to retrieve from the related records is determined automatically using TCA, using this option the desired field can be specified explicitly
39		* multiValue: whether to return related records suitable for a multi value field
40		* singleValueGlue: when not using multiValue, the related records need to be concatenated using a glue string, by default this is ", ". Using this option a custom glue can be specified. The custom value must be wrapped by pipe (\|) characters.
41		* relationTableSortingField: field in a mm relation table to sort by, usually "sorting"
42		* enableRecursiveValueResolution: if the specified remote table's label field is a relation to another table, the value will be resolved by following the relation recursively.
43		* removeEmptyValues: Removes empty values when resolving relations, defaults to TRUE
44		* removeDuplicateValues: Removes duplicate values
45		*
46		* @author Ingo Renner <[email protected]>
47		*/
48		class Relation extends AbstractContentObject
49		{
50		public const CONTENT_OBJECT_NAME = 'SOLR_RELATION';
51
52		/**
53		* Content object configuration
54		*
55		* @var array
56		*/
57		protected array $configuration = [];
58
59		/**
60		* @var TCAService
61		*/
62		protected TCAService $tcaService;
63
64		/**
65		* @var FrontendOverlayService
66		*/
67		protected FrontendOverlayService $frontendOverlayService;
68
69		/**
70		* @var TypoScriptFrontendController\|null
71		*/
72		protected ?TypoScriptFrontendController $typoScriptFrontendController = null;
73
74		/**
75		* Relation constructor.
76		* @param TCAService\|null $tcaService
77		* @param FrontendOverlayService\|null $frontendOverlayService
78		*/
79	13	public function __construct(
80		ContentObjectRenderer $cObj,
81		TCAService $tcaService = null,
82		FrontendOverlayService $frontendOverlayService = null
83		) {
84	13	parent::__construct($cObj);
85	13	$this->configuration['enableRecursiveValueResolution'] = 1;
86	13	$this->configuration['removeEmptyValues'] = 1;
87	13	$this->tcaService = $tcaService ?? GeneralUtility::makeInstance(TCAService::class);
88	13	$this->typoScriptFrontendController = $this->getProtectedTsfeObjectFromContentObjectRenderer($cObj);
89	13	$this->frontendOverlayService = $frontendOverlayService ?? GeneralUtility::makeInstance(FrontendOverlayService::class, $this->tcaService, $this->typoScriptFrontendController);
90	13	}
91
92		/**
93		* Executes the SOLR_RELATION content object.
94		*
95		* Resolves relations between records. Currently, supported relations are
96		* TYPO3-style m:n relations.
97		* May resolve single value and multi value relations.
98		*
99		* @inheritDoc
100		*
101		* @throws AspectNotFoundException
102		*/
103	13	public function render($conf = [])
104		{
105	13	$this->configuration = array_merge($this->configuration, $conf);
106
107	13	$relatedItems = $this->getRelatedItems($this->cObj);
108
109	13	if (!empty($this->configuration['removeDuplicateValues'])) {
110		$relatedItems = array_unique($relatedItems);
111		}
112
113	13	if (empty($conf['multiValue'])) {
114		// single value, need to concatenate related items
115	2	$singleValueGlue = !empty($conf['singleValueGlue']) ? trim($conf['singleValueGlue'], '\|') : ', ';
116	2	$result = implode($singleValueGlue, $relatedItems);
117		} else {
118		// multi value, need to serialize as content objects must return strings
119	11	$result = serialize($relatedItems);
120		}
121
122	13	return $result;
123		}
124
125		/**
126		* Gets the related items of the current record's configured field.
127		*
128		* @param ContentObjectRenderer $parentContentObject parent content object
129		*
130		* @return array Array of related items, values already resolved from related records
131		*
132		* @throws AspectNotFoundException
133		*/
134	13	protected function getRelatedItems(ContentObjectRenderer $parentContentObject): array
135		{
136	13	list($table, $uid) = explode(':', $parentContentObject->currentRecord);
137	13	$uid = (int) $uid;
138	13	$field = $this->configuration['localField'];
139
140	13	if (!$this->tcaService->/** @scrutinizer ignore-call */ getHasConfigurationForField($table, $field)) {
141		return [];
142		}
143
144	13	$overlayUid = $this->frontendOverlayService->/** @scrutinizer ignore-call */ getUidOfOverlay($table, $field, $uid);
145	13	$fieldTCA = $this->tcaService->getConfigurationForField($table, $field);
146
147	13	if (isset($fieldTCA['config']['MM']) && trim($fieldTCA['config']['MM']) !== '') {
148	10	$relatedItems = $this->getRelatedItemsFromMMTable($table, $overlayUid, $fieldTCA);
149		} else {
150	3	$relatedItems = $this->getRelatedItemsFromForeignTable($table, $overlayUid, $fieldTCA, $parentContentObject);
151		}
152
153	13	return $relatedItems;
154		}
155
156		/**
157		* Gets the related items from a table using the n:m relation.
158		*
159		* @param string $localTableName Local table name
160		* @param int $localRecordUid Local record uid
161		* @param array $localFieldTca The local table's TCA
162		* @return array Array of related items, values already resolved from related records
163		*
164		* @throws AspectNotFoundException
165		* @throws DBALException
166		*/
167	10	protected function getRelatedItemsFromMMTable(string $localTableName, int $localRecordUid, array $localFieldTca): array
168		{
169	10	$relatedItems = [];
170	10	$foreignTableName = $localFieldTca['config']['foreign_table'];
171	10	$foreignTableTca = $this->tcaService->getTableConfiguration($foreignTableName);
172	10	$foreignTableLabelField = $this->resolveForeignTableLabelField($foreignTableTca);
173	10	$mmTableName = $localFieldTca['config']['MM'];
174
175		// Remove the first option of foreignLabelField for recursion
176	10	if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
177		$foreignTableLabelFieldArr = explode('.', $this->configuration['foreignLabelField']);
178		unset($foreignTableLabelFieldArr[0]);
179		$this->configuration['foreignLabelField'] = implode('.', $foreignTableLabelFieldArr);
180		}
181
182	10	$relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
183	10	$relationHandler->start('', $foreignTableName, $mmTableName, $localRecordUid, $localTableName, $localFieldTca['config']);
184	10	$selectUids = $relationHandler->tableArray[$foreignTableName];
185	10	if (!is_array($selectUids) \|\| count($selectUids) <= 0) {
186	2	return $relatedItems;
187		}
188
189	10	$relatedRecords = $this->getRelatedRecords($foreignTableName, ...$selectUids);
190	10	foreach ($relatedRecords as $record) {
191	10	if (isset($foreignTableTca['columns'][$foreignTableLabelField]['config']['foreign_table'])
192	10	&& $this->configuration['enableRecursiveValueResolution']
193		) {
194		if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
195		$foreignTableLabelFieldArr = explode('.', $this->configuration['foreignLabelField']);
196		unset($foreignTableLabelFieldArr[0]);
197		$this->configuration['foreignLabelField'] = implode('.', $foreignTableLabelFieldArr);
198		}
199
200		$this->configuration['localField'] = $foreignTableLabelField;
201
202		$contentObject = GeneralUtility::makeInstance(ContentObjectRenderer::class);
203		$contentObject->start($record, $foreignTableName);
204
205		return $this->getRelatedItems($contentObject);
206		} else {
207	10	if ($this->getLanguageUid() > 0) {
208	7	$record = $this->frontendOverlayService->getOverlay($foreignTableName, $record);
209		}
210	10	$relatedItems[] = $record[$foreignTableLabelField];
211		}
212		}
213
214	10	return $relatedItems;
215		}
216
217		/**
218		* Resolves the field to use as the related item's label depending on TCA
219		* and TypoScript configuration
220		*
221		* @param array $foreignTableTca The foreign table's TCA
222		*
223		* @return string\|null The field to use for the related item's label
224		*/
225	13	protected function resolveForeignTableLabelField(array $foreignTableTca): ?string
226		{
227	13	$foreignTableLabelField = $foreignTableTca['ctrl']['label'] ?? null;
228
229		// when foreignLabelField is not enabled we can return directly
230	13	if (empty($this->configuration['foreignLabelField'] ?? null)) {
231	11	return $foreignTableLabelField;
232		}
233
234	4	if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
235	2	list($foreignTableLabelField) = explode('.', $this->configuration['foreignLabelField'], 2);
236		} else {
237	4	$foreignTableLabelField = $this->configuration['foreignLabelField'];
238		}
239
240	4	return $foreignTableLabelField;
241		}
242
243		/**
244		* Gets the related items from a table using a 1:n relation.
245		*
246		* @param string $localTableName Local table name
247		* @param int $localRecordUid Local record uid
248		* @param array $localFieldTca The local table's TCA
249		* @param ContentObjectRenderer $parentContentObject parent content object
250		* @return array Array of related items, values already resolved from related records
251		*
252		* @throws AspectNotFoundException
253		* @throws DBALException
254		*/
255	3	protected function getRelatedItemsFromForeignTable(
256		string $localTableName,
257		int $localRecordUid,
258		array $localFieldTca,
259		ContentObjectRenderer $parentContentObject
260		): array {
261	3	$relatedItems = [];
262	3	$foreignTableName = $localFieldTca['config']['foreign_table'];
263	3	$foreignTableTca = $this->tcaService->getTableConfiguration($foreignTableName);
264	3	$foreignTableLabelField = $this->resolveForeignTableLabelField($foreignTableTca);
265
266		/** @var $relationHandler RelationHandler */
267	3	$relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
268
269	3	$itemList = $parentContentObject->data[$this->configuration['localField']] ?? '';
270
271	3	$relationHandler->start($itemList, $foreignTableName, '', $localRecordUid, $localTableName, $localFieldTca['config']);
272	3	$selectUids = $relationHandler->tableArray[$foreignTableName];
273
274	3	if (!is_array($selectUids) \|\| count($selectUids) <= 0) {
275		return $relatedItems;
276		}
277
278	3	$relatedRecords = $this->getRelatedRecords($foreignTableName, ...$selectUids);
279
280	3	foreach ($relatedRecords as $relatedRecord) {
281	3	$resolveRelatedValue = $this->resolveRelatedValue(
282	3	$relatedRecord,
283		$foreignTableTca,
284		$foreignTableLabelField,
285		$parentContentObject,
286		$foreignTableName
287		);
288	3	if (!empty($resolveRelatedValue) \|\| !$this->configuration['removeEmptyValues']) {
289	3	$relatedItems[] = $resolveRelatedValue;
290		}
291		}
292
293	3	return $relatedItems;
294		}
295
296		/**
297		* Resolves the value of the related field. If the related field's value is
298		* a relation itself, this method takes care of resolving it recursively.
299		*
300		* @param array $relatedRecord Related record as array
301		* @param array $foreignTableTca TCA of the related table
302		* @param string $foreignTableLabelField Field name of the foreign label field
303		* @param ContentObjectRenderer $parentContentObject cObject
304		* @param string $foreignTableName Related record table name
305		*
306		* @return string
307		*
308		* @throws AspectNotFoundException
309		* @throws DBALException
310		*/
311	3	protected function resolveRelatedValue(
312		array $relatedRecord,
313		$foreignTableTca,
314		$foreignTableLabelField,
315		ContentObjectRenderer $parentContentObject,
316		$foreignTableName = ''
317		): string {
318	3	if ($this->getLanguageUid() > 0 && !empty($foreignTableName)) {
319	3	$relatedRecord = $this->frontendOverlayService->getOverlay($foreignTableName, $relatedRecord);
320		}
321
322	3	$value = $relatedRecord[$foreignTableLabelField];
323
324		if (
325	3	!empty($foreignTableName)
326	3	&& isset($foreignTableTca['columns'][$foreignTableLabelField]['config']['foreign_table'])
327	3	&& $this->configuration['enableRecursiveValueResolution']
328		) {
329		// backup
330	2	$backupRecord = $parentContentObject->data;
331	2	$backupConfiguration = $this->configuration;
332
333		// adjust configuration for next level
334	2	$this->configuration['localField'] = $foreignTableLabelField;
335	2	$parentContentObject->data = $relatedRecord;
336	2	if (strpos($this->configuration['foreignLabelField'], '.') !== false) {
337	2	list(, $this->configuration['foreignLabelField']) = explode(
338	2	'.',
339	2	$this->configuration['foreignLabelField'],
340	2	2
341		);
342		} else {
343	2	$this->configuration['foreignLabelField'] = '';
344		}
345
346		// recursion
347	2	$relatedItemsFromForeignTable = $this->getRelatedItemsFromForeignTable(
348	2	$foreignTableName,
349	2	$relatedRecord['uid'],
350	2	$foreignTableTca['columns'][$foreignTableLabelField],
351		$parentContentObject
352		);
353	2	$value = array_pop($relatedItemsFromForeignTable);
354
355		// restore
356	2	$this->configuration = $backupConfiguration;
357	2	$parentContentObject->data = $backupRecord;
358		}
359
360	3	return $parentContentObject->stdWrap($value, $this->configuration) ?? '';
361		}
362
363		/**
364		* Return records via relation.
365		*
366		* @param string $foreignTable The table to fetch records from.
367		* @param int ...$uids The uids to fetch from table.
368		* @return array
369		*
370		* @throws DBALException
371		*/
372	13	protected function getRelatedRecords(string $foreignTable, int ...$uids): array
373		{
374		/** @var QueryBuilder $queryBuilder */
375	13	$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($foreignTable);
376	13	$queryBuilder->select('*')
377	13	->from($foreignTable)
378	13	->where(/** @scrutinizer ignore-type */ $queryBuilder->expr()->in('uid', $uids));
379	13	if (isset($this->configuration['additionalWhereClause'])) {
380	2	$queryBuilder->andWhere($this->configuration['additionalWhereClause']);
381		}
382	13	$statement = $queryBuilder->execute();
383
384	13	return $this->sortByKeyInIN($statement, 'uid', ...$uids);
385		}
386
387		/**
388		* Sorts the result set by key in array for IN values.
389		* Simulates MySqls ORDER BY FIELD(fieldname, COPY_OF_IN_FOR_WHERE)
390		* Example: SELECT * FROM a_table WHERE field_name IN (2, 3, 4) SORT BY FIELD(field_name, 2, 3, 4)
391		*
392		*
393		* @param Statement $statement
394		* @param string $columnName
395		* @param array $arrayWithValuesForIN
396		* @return array
397		*/
398	13	protected function sortByKeyInIN(Statement $statement, string $columnName, ...$arrayWithValuesForIN): array
399		{
400	13	$records = [];
401	13	while ($record = $statement->fetchAssociative()) {
402	13	$indexNumber = array_search($record[$columnName], $arrayWithValuesForIN);
403	13	$records[$indexNumber] = $record;
404		}
405	13	ksort($records);
406	13	return $records;
407		}
408
409		/**
410		* Returns current language id fetched from object properties chain TSFE->context->language aspect->id.
411		*
412		* @return int
413		* @throws AspectNotFoundException
414		*/
415	13	protected function getLanguageUid(): int
416		{
417	13	return (int)$this->typoScriptFrontendController->/** @scrutinizer ignore-call */ getContext()->getPropertyFromAspect('language', 'id');
418		}
419
420		/**
421		* Returns inaccessible {@link ContentObjectRenderer::typoScriptFrontendController} via reflection.
422		*
423		* The TypoScriptFrontendController object must be delegated to the whole object aggregation on indexing stack,
424		* to be able to use Contexts properties and proceed indexing request.
425		*
426		* @param ContentObjectRenderer $cObj
427		* @return TypoScriptFrontendController\|null
428		*/
429	13	protected function getProtectedTsfeObjectFromContentObjectRenderer(ContentObjectRenderer $cObj): ?TypoScriptFrontendController
430		{
431	13	$reflection = new ReflectionClass($cObj);
432	13	$property = $reflection->getProperty('typoScriptFrontendController');
433	13	$property->setAccessible(true);
434	13	return $property->getValue($cObj);
435		}
436		}
437

TYPO3-Solr / ext-solr

Push — task/2976_TYPO3.11_compatibili... ( 9f9205...0f123d )

Relation::sortByKeyInIN() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like