lochmueller / autoloader

Classes/Loader/ContextSensitiveHelps.php

<?php

/**
 * ContextSensitiveHelp (CSH) based on smart objects.
 */
declare(strict_types=1);

namespace HDNET\Autoloader\Loader;

use HDNET\Autoloader\Loader;
use HDNET\Autoloader\LoaderInterface;
use HDNET\Autoloader\Localization\LanguageHandler;
use HDNET\Autoloader\Service\SmartObjectInformationService;
use HDNET\Autoloader\SmartObjectRegister;
use HDNET\Autoloader\Utility\ClassNamingUtility;
use HDNET\Autoloader\Utility\ModelUtility;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * ContextSensitiveHelp (CSH) based on smart objects.
 */
class ContextSensitiveHelps implements LoaderInterface
{
    /**
     * Get all the complex data for the loader.
     * This return value will be cached and stored in the database
     * There is no file monitoring for this cache.
     *
     * @param Loader $loader
     * @param int    $type
     *
     * @return array
     */
    public function prepareLoader(Loader $loader, int $type): array
    {
        if (LoaderInterface::EXT_TABLES !== $type) {
            return [];
        }
        $modelInformation = $this->findTableAndModelInformationForExtension($loader->getExtensionKey());

        $loaderInformation = [];
        foreach ($modelInformation as $information) {
            $table = $information['table'];
            $path = $this->checkCshValues(
                $loader->getExtensionKey(),
                $information['table'],
                $information['properties']
            );
            if (null !== $path) {
                $loaderInformation[$table] = $path;
            }
        }

        return $loaderInformation;
    }

    /**
     * Run the loading process for the ext_tables.php file.
     *
     * @param Loader $loader
     * @param array  $loaderInformation
     */
    public function loadExtensionTables(Loader $loader, array $loaderInformation)
    {
        foreach ($loaderInformation as $table => $path) {
            ExtensionManagementUtility::addLLrefForTCAdescr($table, $path);
        }
    }

    /**
     * Run the loading process for the ext_localconf.php file.
     *
     * @param \HDNET\Autoloader\Loader $loader
     * @param array                    $loaderInformation
     *
     * @internal param \HDNET\Autoloader\Loader $autoLoader
     */
    public function loadExtensionConfiguration(Loader $loader, array $loaderInformation)
    {
    }

    /**
     * Find table and model information for the given extension key.
     *
     * @param string $extensionKey
     *
     * @return array
     */
    protected function findTableAndModelInformationForExtension($extensionKey)
    {
        $information = [];
        $register = SmartObjectRegister::getRegister();
        foreach ($register as $class) {
            $parts = ClassNamingUtility::explodeObjectModelName($class);
            if (GeneralUtility::camelCaseToLowerCaseUnderscored($parts['extensionName']) === $extensionKey && '' === ModelUtility::getTableNameByModelReflectionAnnotation($class)) {
                $modelInformation = SmartObjectInformationService::getInstance()
                    ->getCustomModelFieldTca($class);

                $information[] = [
                    'table' => ModelUtility::getTableNameByModelName($class),
                    'properties' => \array_keys($modelInformation),
                ];
            }
        }

        return $information;
    }

    /**
     * Check if the given file is already existing.
     *
     * @param string $extensionKey
     * @param string $table
     * @param array  $properties
     *
     * @return string|null
     */
    protected function checkCshValues($extensionKey, $table, array $properties)
    {
        $baseFileName = 'locallang_csh_' . $table;
        /** @var LanguageHandler $languageHandler */
        $languageHandler = GeneralUtility::makeInstance(LanguageHandler::class);
        foreach ($properties as $property) {
            $default = '';
            $languageHandler->handle($property . '.alttitle', $extensionKey, $default, null, $baseFileName);

null is of type null, but the function expects a array.

        }

        $checkPath = ['xlf', 'xml'];
        foreach ($checkPath as $extension) {
            $path = 'EXT:' . $extensionKey . '/Resources/Private/Language/' . $baseFileName . '.' . $extension;
            if (\is_file(GeneralUtility::getFileAbsFileName($path))) {
                return $path;
            }
        }
    }
}