How is the app/etc/config.php file generated by the \Magento\Setup\Model\Installer::createModulesConfig()?

dmitry_fedyuk (Dmitrii Fediuk) April 9, 2016, 12:39am 1

The exact code point

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L381-L381


$this->deploymentConfigWriter->saveConfig([ConfigFilePool::APP_CONFIG => ['modules' => $result]], true);

How is it called?

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Console/Command/UpgradeCommand.php#L63-L76


/**
 * {@inheritdoc}
 */
protected function execute(InputInterface $input, OutputInterface $output)
{
    $keepGenerated = $input->getOption(self::INPUT_KEY_KEEP_GENERATED);
    $installer = $this->installerFactory->create(new ConsoleLogger($output));
    $installer->updateModulesSequence($keepGenerated);
    $installer->installSchema();
    $installer->installDataFixtures();
    if (!$keepGenerated) {
        $output->writeln('<info>Please re-run Magento compile command</info>');
    }
}

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L938-L946


/**
 * Updates modules in deployment configuration
 *
 * @param bool $keepGeneratedFiles Cleanup generated classes and view files and reset ObjectManager
 * @return void
 */
public function updateModulesSequence($keepGeneratedFiles = false)
{
    $this->assertDeploymentConfigExists();

Details: How does \Magento\Setup\Model\Installer.php::assertDeploymentConfigExists() work?

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L948-L955


    $this->cleanCaches();


    if (!$keepGeneratedFiles) {
        $this->cleanupGeneratedFiles();
    }
    $this->log->log('Updating modules:');
    $this->createModulesConfig([]);
}

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L350-L360


/**
 * Creates modules deployment configuration segment
 *
 * @param \ArrayObject|array $request
 * @param bool $dryRun
 * @return array
 * @throws \LogicException
 */
private function createModulesConfig($request, $dryRun = false)
{
    $all = array_keys($this->moduleLoader->load());

Details: How does \Magento\Framework\Module\ModuleList\Loader::load() work?

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L361-L361


$deploymentConfig = $this->deploymentConfigReader->load();

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L362-L363


$currentModules = isset($deploymentConfig[ConfigOptionsListConstants::KEY_MODULES])
    ? $deploymentConfig[ConfigOptionsListConstants::KEY_MODULES] : [] ;

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L364-L364


$enable = $this->readListOfModules($all, $request, self::ENABLE_MODULES);

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L52-L55


/**#@+
 * Parameters for enabling/disabling modules
 */
const ENABLE_MODULES = 'enable_modules';

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L386-L395


/**
 * Determines list of modules from request based on list of all modules
 *
 * @param string[] $all
 * @param array $request
 * @param string $key
 * @return string[]
 * @throws \LogicException
 */
private function readListOfModules($all, $request, $key)

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L396-L411


{
    $result = [];
    if (!empty($request[$key])) {
        if ($request[$key] == 'all') {
            $result = $all;
        } else {
            $result = explode(',', $request[$key]);
            foreach ($result as $module) {
                if (!in_array($module, $all)) {
                    throw new \LogicException("Unknown module in the requested list: '{$module}'");
                }
            }
        }
    }
    return $result;
}

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L365-L365


$disable = $this->readListOfModules($all, $request, self::DISABLE_MODULES);

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L366-L379


$result = [];
foreach ($all as $module) {
    if ((isset($currentModules[$module]) && !$currentModules[$module])) {
        $result[$module] = 0;
    } else {
        $result[$module] = 1;
    }
    if (in_array($module, $disable)) {
        $result[$module] = 0;
    }
    if (in_array($module, $enable)) {
        $result[$module] = 1;
    }
}

github.com

magento/magento2/blob/ec436ce/setup/src/Magento/Setup/Model/Installer.php#L380-L382


if (!$dryRun) {
    $this->deploymentConfigWriter->saveConfig([ConfigFilePool::APP_CONFIG => ['modules' => $result]], true);
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Writer.php#L89-L98


/**
 * Saves config
 *
 * @param array $data
 * @param bool $override
 * @return void
 */
public function saveConfig(array $data, $override = false)
{
    $paths = $this->configFilePool->getPaths();

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Writer.php#L100-L120


foreach ($data as $fileKey => $config) {
    if (isset($paths[$fileKey])) {


        if ($this->filesystem->getDirectoryWrite(DirectoryList::CONFIG)->isExist($paths[$fileKey])) {
            $currentData = $this->reader->load($fileKey);
            if ($override) {
                $config = array_merge($currentData, $config);
            } else {
                $config = array_replace_recursive($currentData, $config);
            }
        }


        $contents = $this->formatter->format($config);
        $this->filesystem->getDirectoryWrite(DirectoryList::CONFIG)->writeFile($paths[$fileKey], $contents);
        if (function_exists('opcache_invalidate')) {
            opcache_invalidate(
                $this->filesystem->getDirectoryRead(DirectoryList::CONFIG)->getAbsolutePath($paths[$fileKey])
            );
        }
    }
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Writer.php#L121-L122


    $this->deploymentConfig->resetData();
}

How does \Magento\Framework\Module\ModuleList\Loader::load() work?

How to place a new tab after the standard tabs on the frontend product view?

How is the app/etc/config.php file generated by the \Magento\Framework\Module\Status::setIsEnabled()?

How and when is the app/etc/config.php file generated?

Magento 2 has no ability to order an event's obververs execution

dmitry_fedyuk (Dmitrii Fediuk) April 9, 2016, 12:43am 2

See also: