ExtLocalconfFactory.php

Go to the documentation of this file.

<?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 ‪TYPO3\CMS\Core\Configuration\Extension;
 
use ‪TYPO3\CMS\Core\Cache\Frontend\PhpFrontend;
use ‪TYPO3\CMS\Core\Package\Cache\PackageDependentCacheIdentifier;
use TYPO3\CMS\Core\Package\PackageManager;
 
final class ‪ExtLocalconfFactory
{
    public function ‪__construct(
        private readonly PackageManager $packageManager,
        private readonly ‪PhpFrontend $codeCache,
    ) {}
 
    public function ‪load(): void
    {
        $cacheIdentifier = $this->‪getExtLocalconfCacheIdentifier();
        $hasCache = $this->codeCache->require($cacheIdentifier) !== false;
        if (!$hasCache) {
            $this->‪loadSingleExtLocalconfFiles();
            $this->‪createCacheEntry();
        }
    }
 
    public function ‪loadUncached(): void
    {
        $this->‪loadSingleExtLocalconfFiles();
    }
 
    public function ‪createCacheEntry(): void
    {
        $phpCodeToCache = [];
        // Set same globals as in loadSingleExtLocalconfFiles()
        $phpCodeToCache[] = '';
        // Iterate through loaded extensions and add ext_localconf content
        foreach ($this->packageManager->getActivePackages() as $package) {
            $extensionKey = $package->getPackageKey();
            $extLocalconfPath = $package->getPackagePath() . 'ext_localconf.php';
            if (@file_exists($extLocalconfPath)) {
                // Include a header per extension to make the cache file more readable
                $phpCodeToCache[] = '';
                // Add ext_localconf.php content of extension
                $phpCodeToCache[] = 'namespace {';
                $phpCodeToCache[] = trim((string)file_get_contents($extLocalconfPath));
                $phpCodeToCache[] = '}';
                $phpCodeToCache[] = '';
                $phpCodeToCache[] = '';
            }
        }
        $phpCodeToCache = implode(LF, $phpCodeToCache);
        // Remove all start and ending php tags from content, and remove strict_types=1 declaration.
        $phpCodeToCache = preg_replace('/<\\?php|\\?>/is', '', $phpCodeToCache);
        $phpCodeToCache = preg_replace('/declare\\s?+\\(\\s?+strict_types\\s?+=\\s?+1\\s?+\\);/is', '', (string)$phpCodeToCache);
        $this->codeCache->set($this->‪getExtLocalconfCacheIdentifier(), $phpCodeToCache);
    }
 
    private function ‪loadSingleExtLocalconfFiles(): void
    {
        foreach ($this->packageManager->getActivePackages() as $package) {
            $extLocalconfPath = $package->getPackagePath() . 'ext_localconf.php';
            if (file_exists($extLocalconfPath)) {
                require $extLocalconfPath;
            }
        }
    }
 
    private function ‪getExtLocalconfCacheIdentifier(): string
    {
        return (new ‪PackageDependentCacheIdentifier($this->packageManager))->withPrefix('ext_localconf')->toString();
    }
}