ApacheSolrForTypo3\Solr\System\Language\FrontendOverlayService

Complexity

Total Complexity

13

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Test Coverage

Coverage

96.97%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getLocalRecordUidFromOverlay()	0	13	4
A	__construct()	0	4	1
A	getUidOfOverlay()	0	24	5
A	getOverlay()	0	10	2
A	getRecord()	0	11	1

<?php

declare(strict_types=1);

/*
 * 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 ApacheSolrForTypo3\Solr\System\Language;

use ApacheSolrForTypo3\Solr\System\TCA\TCAService;
use Doctrine\DBAL\Driver\Exception as DBALDriverException;
use Doctrine\DBAL\Exception as DBALException;
use TYPO3\CMS\Core\Context\Exception\AspectNotFoundException;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;

/**
 * Class FrontendOverlayService
 */
class FrontendOverlayService
{
    /**
     * @var TCAService
     */
    protected $tcaService;

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

    /**
     * Relation constructor.
     * @param TCAService|null $tcaService
     * @param TypoScriptFrontendController|null $tsfe
     */
    public function __construct(TCAService $tcaService = null, TypoScriptFrontendController $tsfe = null)
    {
        $this->tcaService = $tcaService ?? GeneralUtility::makeInstance(TCAService::class);
        $this->tsfe = $tsfe;
    }

    /**
     * Return the translated record
     *
     * @param string $tableName
     * @param array $record
     * @return array
     * @throws AspectNotFoundException
     */
    public function getOverlay(string $tableName, array $record): ?array
    {
        $currentLanguageUid = $this->tsfe->getContext()->getPropertyFromAspect('language', 'id');

The method getContext() does not exist on null.

        if ($tableName === 'pages') {
            // @extensionScannerIgnoreLine
            return $this->tsfe->sys_page->getPageOverlay($record, $currentLanguageUid);
        }

        // @extensionScannerIgnoreLine
        return $this->tsfe->sys_page->getRecordOverlay($tableName, $record, $currentLanguageUid);
    }

    /**
     * When the record has an overlay we retrieve the uid of the translated record,
     * to resolve the relations from the translation.
     *
     * @param string $table
     * @param string $field
     * @param int $uid
     * @return int
     * @throws AspectNotFoundException
     * @throws DBALDriverException
     * @throws DBALException
     * @throws DBALException|\Doctrine\DBAL\DBALException
     */
    public function getUidOfOverlay(
        string $table,
        string $field,

The parameter $field is not used and could be removed.

        int $uid
    ): int {
        $contextsLanguageId = $this->tsfe->getContext()->getPropertyFromAspect('language', 'id');
        // when no language is set at all we do not need to overlay
        if ($contextsLanguageId === null) {
            return $uid;
        }
        // when no language is set we can return the passed recordUid
        if (!($contextsLanguageId > 0)) {
            return $uid;
        }

        $record = $this->getRecord($table, $uid);

        // when the overlay is not an array, we return the localRecordUid
        if (!is_array($record)) {
            return $uid;
        }

        $overlayUid = $this->getLocalRecordUidFromOverlay($table, $record);
        return ($overlayUid !== 0) ? $overlayUid : $uid;
    }

    /**
     * This method retrieves the _PAGES_OVERLAY_UID or _LOCALIZED_UID from the localized record.
     *
     * @param string $localTableName
     * @param array $originalRecord
     * @return int
     * @throws AspectNotFoundException
     */
    protected function getLocalRecordUidFromOverlay(string $localTableName, array $originalRecord): int
    {
        $overlayRecord = $this->getOverlay($localTableName, $originalRecord);

        // when there is a _PAGES_OVERLAY_UID | _LOCALIZED_UID in the overlay, we return it
        if ($localTableName === 'pages' && isset($overlayRecord['_PAGES_OVERLAY_UID'])) {
            return (int)$overlayRecord['_PAGES_OVERLAY_UID'];
        }
        if (isset($overlayRecord['_LOCALIZED_UID'])) {
            return (int)$overlayRecord['_LOCALIZED_UID'];
        }

        return 0;
    }

    /**
     * @param string $localTableName
     * @param int $localRecordUid
     * @return mixed
     * @throws DBALDriverException
     * @throws DBALException|\Doctrine\DBAL\DBALException
     */
    protected function getRecord(string $localTableName, int $localRecordUid)
    {
        /* @var QueryBuilder $queryBuilder */
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($localTableName);

        return $queryBuilder
            ->select('*')
            ->from($localTableName)
            ->where($queryBuilder->expr()->eq('uid', $localRecordUid))
            ->execute()
            ->fetchAssociative();
    }
}