ConfigGenerator Class Reference

Public Member Functions
	__construct (Random $random, DeploymentConfig $deploymentConfig, ConfigDataFactory $configDataFactory=null, CryptKeyGeneratorInterface $cryptKeyGenerator=null)
	createCryptConfig (array $data)
	createSessionConfig (array $data)
	createDefinitionsConfig (array $data)
	createDbConfig (array $data)
	createResourceConfig ()
	createXFrameConfig ()
	createModeConfig ()
	createCacheHostsConfig (array $data)

Protected Attributes
	$deploymentConfig
	$random

Detailed Description

Creates deployment config data based on user input array this class introduced to break down Magento\Setup\Model\ConfigOptionsList::createConfig

Definition at line 22 of file ConfigGenerator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Random	$random,
		DeploymentConfig	$deploymentConfig,
		ConfigDataFactory	$configDataFactory = null,
		CryptKeyGeneratorInterface	$cryptKeyGenerator = null
	)

Constructor

Parameters

Random	$random	Deprecated since 100.2.0
DeploymentConfig	$deploymentConfig
ConfigDataFactory | null	$configDataFactory
CryptKeyGeneratorInterface | null	$cryptKeyGenerator

Definition at line 72 of file ConfigGenerator.php.

      {
        $this->random = $random;
        $this->deploymentConfig = $deploymentConfig;
        $this->configDataFactory = $configDataFactory ?? ObjectManager::getInstance()->get(ConfigDataFactory::class);
        $this->cryptKeyGenerator = $cryptKeyGenerator ?? ObjectManager::getInstance()->get(CryptKeyGenerator::class);
    }

Member Function Documentation

createCacheHostsConfig()

createCacheHostsConfig

(

array

$data

)

Creates cache hosts config data

Parameters

array

$data

Returns

ConfigData

Definition at line 239 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        if (isset($data[ConfigOptionsListConstants::INPUT_KEY_CACHE_HOSTS])) {
            $hosts = explode(',', $data[ConfigOptionsListConstants::INPUT_KEY_CACHE_HOSTS]);

            $hosts = array_map(
                function ($hostData) {
                    $hostDataParts = explode(':', trim($hostData));

                    $tmp = ['host' => $hostDataParts[0]];

                    if (isset($hostDataParts[1])) {
                        $tmp['port'] = $hostDataParts[1];
                    }

                    return $tmp;
                },
                $hosts
            );

            $configData->set(ConfigOptionsListConstants::CONFIG_PATH_CACHE_HOSTS, $hosts);
        }

        $configData->setOverrideWhenSave(true);
        return $configData;
    }

createCryptConfig()

createCryptConfig

(

array

$data

)

Creates encryption key config data

Parameters

array

$data

Returns

ConfigData

Definition at line 89 of file ConfigGenerator.php.

    {
        $currentKey = $this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);

        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        // Use given key if set, else use current
        $key = $data[ConfigOptionsListConstants::INPUT_KEY_ENCRYPTION_KEY] ?? $currentKey;

        // If there is no key given or currently set, generate a new one
        $key = $key ?? $this->cryptKeyGenerator->generate();

        // Chaining of ".. ?? .." is not used to keep it simpler to understand

        $configData->set(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY, $key);

        return $configData;
    }

createDbConfig()

createDbConfig

(

array

$data

)

Creates db config data

Parameters

array

$data

Returns

ConfigData

Definition at line 147 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        $optional = [
            ConfigOptionsListConstants::INPUT_KEY_DB_HOST,
            ConfigOptionsListConstants::INPUT_KEY_DB_NAME,
            ConfigOptionsListConstants::INPUT_KEY_DB_USER,
            ConfigOptionsListConstants::INPUT_KEY_DB_PASSWORD,
            ConfigOptionsListConstants::INPUT_KEY_DB_MODEL,
            ConfigOptionsListConstants::INPUT_KEY_DB_ENGINE,
            ConfigOptionsListConstants::INPUT_KEY_DB_INIT_STATEMENTS,
        ];

        if (isset($data[ConfigOptionsListConstants::INPUT_KEY_DB_PREFIX])) {
            $configData->set(
                ConfigOptionsListConstants::CONFIG_PATH_DB_PREFIX,
                $data[ConfigOptionsListConstants::INPUT_KEY_DB_PREFIX]
            );
        }

        $dbConnectionPrefix = ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT . '/';

        foreach ($optional as $key) {
            if (isset($data[$key])) {
                $configData->set($dbConnectionPrefix . self::$paramMap[$key], $data[$key]);
            }
        }

        $currentStatus = $this->deploymentConfig->get($dbConnectionPrefix . ConfigOptionsListConstants::KEY_ACTIVE);

        if ($currentStatus === null) {
            $configData->set($dbConnectionPrefix . ConfigOptionsListConstants::KEY_ACTIVE, '1');
        }

        return $configData;
    }

createDefinitionsConfig()

createDefinitionsConfig

(

array

$data

)

Creates definitions config data

Parameters

array

$data

Returns

ConfigData

Deprecated:

2.2.0 @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 136 of file ConfigGenerator.php.

    {
        return null;
    }

createModeConfig()

createModeConfig

(

)

Create default entry for mode config option

Returns

ConfigData

Definition at line 222 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        if ($this->deploymentConfig->get(State::PARAM_MODE) === null) {
            $configData->set(State::PARAM_MODE, State::MODE_DEFAULT);
        }

        return $configData;
    }

createResourceConfig()

createResourceConfig

(

)

Creates resource config data

Returns

ConfigData

Definition at line 190 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        if ($this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_RESOURCE_DEFAULT_SETUP) === null) {
            $configData->set(ConfigOptionsListConstants::CONFIG_PATH_RESOURCE_DEFAULT_SETUP, 'default');
        }

        return $configData;
    }

createSessionConfig()

createSessionConfig

(

array

$data

)

Creates session config data

Parameters

array

$data

Returns

ConfigData

Definition at line 114 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        if (isset($data[ConfigOptionsListConstants::INPUT_KEY_SESSION_SAVE])) {
            $configData->set(
                ConfigOptionsListConstants::CONFIG_PATH_SESSION_SAVE,
                $data[ConfigOptionsListConstants::INPUT_KEY_SESSION_SAVE]
            );
        }

        return $configData;
    }

createXFrameConfig()

createXFrameConfig

(

)

Creates x-frame-options header config data

Returns

ConfigData

Definition at line 206 of file ConfigGenerator.php.

    {
        $configData = $this->configDataFactory->create(ConfigFilePool::APP_ENV);

        if ($this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_X_FRAME_OPT) === null) {
            $configData->set(ConfigOptionsListConstants::CONFIG_PATH_X_FRAME_OPT, 'SAMEORIGIN');
        }

        return $configData;
    }

Field Documentation

$deploymentConfig

$deploymentConfig

protected

Definition at line 46 of file ConfigGenerator.php.

$random

$random

protected

Definition at line 52 of file ConfigGenerator.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/ConfigGenerator.php