Classes/Collectors/Configuration.php
<?php
/**
* kreXX: Krumo eXXtended
*
* kreXX is a debugging tool, which displays structured information
* about any PHP object. It is a nice replacement for print_r() or var_dump()
* which are used by a lot of PHP developers.
*
* kreXX is a fork of Krumo, which was originally written by:
* Kaloyan K. Tsvetkov <kaloyan@kaloyan.info>
*
* @author
* brainworXX GmbH <info@brainworxx.de>
*
* @license
* http://opensource.org/licenses/LGPL-2.1
*
* GNU Lesser General Public License Version 2.1
*
* kreXX Copyright (C) 2014-2024 Brainworxx GmbH
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or (at
* your option) any later version.
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
declare(strict_types=1);
namespace Brainworxx\Includekrexx\Collectors;
use Brainworxx\Includekrexx\Plugins\Typo3\ConstInterface;
use Brainworxx\Krexx\Service\Config\ConfigConstInterface;
use Brainworxx\Krexx\Service\Config\From\File;
use Brainworxx\Krexx\Service\Plugin\SettingsGetter;
use Psr\Log\LogLevel;
/**
* Collect the current configuration for the backend module.
*/
class Configuration extends AbstractCollector implements ConfigConstInterface, ConstInterface
{
/**
* Assign the kreXX configuration for the view.
*
* @param \TYPO3\CMS\Fluid\View\AbstractTemplateView|\TYPO3\CMS\Backend\Template\ModuleTemplate $view
*/
public function assignData($view): void
{
if (!$this->hasAccess) {
// No access.
return;
}
$view->assign('config', $this->retrieveConfiguration());
$view->assign('dropdown', $this->retrieveDropDowns());
}
/**
* Retrieve the values for the drop-downs.
*
* @return string[][]
* The values for the drop-downs.
*/
protected function retrieveDropDowns(): array
{
// Adding the dropdown values.
$dropdown = ['skins' => []];
foreach ($this->pool->config->getSkinList() as $skin) {
$dropdown['skins'][$skin] = $skin;
}
$dropdown[static::SETTING_DESTINATION] = [
static::VALUE_BROWSER => static::translate(static::VALUE_BROWSER),
static::VALUE_FILE => static::translate(static::VALUE_FILE),
static::VALUE_BROWSER_IMMEDIATELY => static::translate(static::VALUE_BROWSER_IMMEDIATELY),
];
$dropdown['bool'] = [
static::VALUE_TRUE => static::translate(static::VALUE_TRUE),
static::VALUE_FALSE => static::translate(static::VALUE_FALSE),
];
$dropdown['loglevel'] = [
LogLevel::DEBUG => static::translate('loglevel.debug'),
LogLevel::INFO => static::translate('loglevel.info'),
LogLevel::NOTICE => static::translate('loglevel.notice'),
LogLevel::WARNING => static::translate('loglevel.warning'),
LogLevel::ERROR => static::translate('loglevel.error'),
LogLevel::CRITICAL => static::translate('loglevel.critical'),
LogLevel::ALERT => static::translate('loglevel.alert'),
LogLevel::EMERGENCY => static::translate('loglevel.emergency'),
];
$dropdown['languages'] = $this->pool->config->getLanguageList();
return $dropdown;
}
/**
* Retrieve the ini configuration, like the method name implies.
*
* @return string[][]
* The configuration array for the view
*/
protected function retrieveConfiguration(): array
{
$pathParts = pathinfo($this->pool->config->getPathToConfigFile());
$filePath = $pathParts[static::PATHINFO_DIRNAME] . DIRECTORY_SEPARATOR .
$pathParts[static::PATHINFO_FILENAME] . '.';
/** @var File $iniReader */
$iniReader = $this->pool->createClass(File::class)->loadFile($filePath);
$fallbackOverwrites = SettingsGetter::getNewFallbackValues();
$config = [];
/**
* @var string $settingsName
* @var string[] $fallback
*/
foreach ($this->pool->config->feConfigFallback as $settingsName => $fallback) {
// Stitch together the settings in the template.
$group = $fallback[static::SECTION];
$config[$settingsName] = [];
$config[$settingsName][static::SETTINGS_NAME] = $settingsName;
$config[$settingsName][static::SETTINGS_VALUE] = $iniReader->getConfigFromFile($group, $settingsName);
$config[$settingsName][static::SETTINGS_USE_FACTORY_SETTINGS] = false;
$config[$settingsName][static::SETTINGS_FALLBACK] =
$fallbackOverwrites[$settingsName] ?? $fallback[static::SETTINGS_VALUE];
$this->applyFallbackToConfig($config, $settingsName, $fallback);
}
return $config;
}
/**
* Check if we have a value.
*
* If not, we need to load the factory settings. We also need to set the
* info, if we are using the factory settings, at all.
*
* @param string[][] $config
* The configuration array, so far.
* @param string $settingsName
* The name of the setting we are processing right now.
* @param string[] $fallback
* The fallback values.
*/
protected function applyFallbackToConfig(array &$config, string $settingsName, array $fallback): void
{
// Check if we have a value. If not, we need to load the factory
// settings. We also need to set the info, if we are using the
// factory settings, at all.
if ($config[$settingsName][static::SETTINGS_VALUE] !== null) {
// We have a setting, and are not afraid to use it.
return;
}
// Check if we have a value from the last time a user has saved
// the settings.
$config[$settingsName][static::SETTINGS_USE_FACTORY_SETTINGS] = true;
$config[$settingsName][static::SETTINGS_VALUE] = $this->userUc[$settingsName] ??
$fallback[static::SETTINGS_VALUE];
// Assign the mode-class.
if (in_array($settingsName, $this->expertOnly, true)) {
$config[$settingsName][static::SETTINGS_MODE] = 'expert';
}
}
}