How does \Magento\Framework\App\DeploymentConfig::load() work?

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

Contexts:

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig.php#L117-L132


/**
 * Loads the configuration data
 *
 * @return void
 */
private function load()
{
    if (null === $this->data) {
        $this->data = $this->reader->load();
        if ($this->overrideData) {
            $this->data = array_replace($this->data, $this->overrideData);
        }
        // flatten data for config retrieval using get()
        $this->flatData = $this->flattenParams($this->data);
    }
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Reader.php#L78-L87


/**
 * Loads the configuration file
 *
 * @param string $fileKey
 * @return array
 * @throws \Exception
 */
public function load($fileKey = null)
{
    $path = $this->dirList->getPath(DirectoryList::CONFIG);

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/Filesystem/DirectoryList.php#L23-L26


/**
 * Initial configuration of the application
 */
const CONFIG = 'etc';

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Reader.php#L88-L96


$fileDriver = $this->driverPool->getDriver(DriverPool::FILE);
$result = [];
if ($fileKey) {
    $filePath = $path . '/' . $this->configFilePool->getPath($fileKey);
    if ($fileDriver->isExists($filePath)) {
        $result = include $filePath;
    }
} else {
    $configFiles = $this->configFilePool->getPaths();

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/Config/File/ConfigFilePool.php#L37-L45


/**
 * Returns application config files
 *
 * @return array
 */
public function getPaths()
{
    return $this->applicationConfigFiles;
}

github.com

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


$allFilesData = [];
$result = [];
foreach (array_keys($configFiles) as $fileKey) {
    $configFile = $path . '/' . $this->configFilePool->getPath($fileKey);

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig/Reader.php#L101-L105


if ($fileDriver->isExists($configFile)) {
    $fileData = include $configFile;
} else {
    continue;
}

github.com

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


            $allFilesData[$configFile] = $fileData;
            if (!empty($fileData)) {
                $intersection = array_intersect_key($result, $fileData);
                if (!empty($intersection)) {
                    $displayMessage = $this->findFilesWithKeys(array_keys($intersection), $allFilesData);
                    throw new \Exception(
                        "Key collision! The following keys occur in multiple config files:"
                        . PHP_EOL . $displayMessage
                    );
                }
                $result = array_merge($result, $fileData);
            }
        }
    }
    return $result ?: [];
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig.php#L126-L132


        if ($this->overrideData) {
            $this->data = array_replace($this->data, $this->overrideData);
        }
        // flatten data for config retrieval using get()
        $this->flatData = $this->flattenParams($this->data);
    }
}

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig.php#L134-L143


/**
 * Convert associative array of arbitrary depth to a flat associative array with concatenated key path as keys
 * each level of array is accessible by path key
 *
 * @param array $params
 * @param string $path
 * @return array
 * @throws \Exception
 */
private function flattenParams(array $params, $path = null)

github.com

magento/magento2/blob/ec436ce/lib/internal/Magento/Framework/App/DeploymentConfig.php#L144-L163


{
    $cache = [];


    foreach ($params as $key => $param) {
        if ($path) {
            $newPath = $path . '/' . $key;
        } else {
            $newPath = $key;
        }
        if (isset($cache[$newPath])) {
            throw new \Exception("Key collision {$newPath} is already defined.");
        }
        $cache[$newPath] = $param;
        if (is_array($param)) {
            $cache = array_merge($cache, $this->flattenParams($param, $newPath));
        }
    }


    return $cache;
}

How are the app/etc/config.php and app/etc/env.php files loaded?

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