{"id":12693,"date":"2017-03-23T14:59:35","date_gmt":"2017-03-23T11:59:35","guid":{"rendered":"http:\/\/blog.belvg.com\/?p=12693"},"modified":"2019-03-20T12:19:00","modified_gmt":"2019-03-20T10:19:00","slug":"use-case-config-php-file-in-magento-2","status":"publish","type":"post","link":"https:\/\/belvg.com\/blog\/use-case-config-php-file-in-magento-2.html","title":{"rendered":"Use Case: Config.php File in Magento 2"},"content":{"rendered":"

New projects are usually developed on a separate dedicated web-server which settings may differ from those of a production server. So, to avoid mess-ups when trying to back up the production server it is required either to reassign data in the core_config<\/em> table or to use a special script. The situation goes worse when there is more than one developer involved in the same project, because each developer may use its own custom set of server configurations.<\/p>\n

The solution to the problem is the \/etc\/config.php<\/em> file which can help us to set up our data configurations.  Let’s check the file vendor\/magento\/framework\/Config\/File\/ConfigFilePool.php<\/em> and private properties of $applicationConfigFiles<\/em> and $initialConfigFiles<\/em><\/p>\n

\/**\r\n* Default files for configuration\r\n*\r\n* @var array\r\n*\/\r\nprivate $applicationConfigFiles = [\r\n   self::APP_CONFIG => 'config.php',\r\n   self::APP_ENV => 'env.php',\r\n];\r\n\r\n\/**\r\n* Initial files for configuration\r\n*\r\n* @var array\r\n*\/\r\nprivate $initialConfigFiles = [\r\n   self::DIST => [\r\n       self::APP_CONFIG => 'config.dist.php',\r\n       self::APP_ENV => 'env.dist.php',\r\n   ],\r\n   self::LOCAL => [\r\n       self::APP_CONFIG => 'config.local.php',\r\n       self::APP_ENV => 'env.local.php',\r\n   ]\r\n];\r\n<\/pre>\n
As we see, apart from the main config.php<\/em> file there are also 2 more files: config.dist.php<\/em> and config.local.php<\/em>.  As seen from the properties, the files env.dist.php<\/em> and env.local.php<\/em> can help us to reassign data. Let’s assume that we need to reassign the configuration for checkout\/cart\/delete_quote_after<\/em><\/p>\n
Add the following code to the config.php<\/em> file:<\/p>\n
'system'=>\r\n   [\r\n       'default' =>\r\n           [\r\n               'checkout' => [\r\n                   'cart' => [\r\n                       'delete_quote_after' => 31\r\n                   ]\r\n               ]\r\n           ]\r\n   ]\r\n<\/pre>\n
Perhaps, it is not the best idea to add new data to the config.php<\/em> file, instead it is better to use the config.local.php<\/em> or config.dist.php<\/em> files for this.<\/p>\n
The only thing we need to clarify now is whether it is possible to change the config.php<\/em> file configuration by creating the same type of settings for config.local.php<\/em> or config.dist.php<\/em> files. Let’s check the method \\Magento\\Framework\\App\\DeploymentConfig\\Reader::loadConfigFile<\/em><\/p>\n
\/**\r\n* @param string $fileKey\r\n* @param string $pathConfig\r\n* @param bool $ignoreInitialConfigFiles\r\n* @return array\r\n*\/\r\npublic function loadConfigFile($fileKey, $pathConfig, $ignoreInitialConfigFiles = false)\r\n{\r\n   $result = [];\r\n   $initialFilePools = $this->configFilePool->getInitialFilePools();\r\n   $path = $this->dirList->getPath(DirectoryList::CONFIG);\r\n   $fileDriver = $this->driverPool->getDriver(DriverPool::FILE);\r\n\r\n   if (!$ignoreInitialConfigFiles) {\r\n       foreach ($initialFilePools as $initialFiles) {\r\n           if (isset($initialFiles[$fileKey]) && $fileDriver->isExists($path . '\/' . $initialFiles[$fileKey])) {\r\n               $fileBuffer = include $path . '\/' . $initialFiles[$fileKey];\r\n               if (is_array($fileBuffer)) {\r\n                   $result = array_replace_recursive($result, $fileBuffer);\r\n               }\r\n           }\r\n       }\r\n   }\r\n\r\n   if ($fileDriver->isExists($path . '\/' . $pathConfig)) {\r\n       $configResult = include $path . '\/' . $pathConfig;\r\n       if (is_array($configResult)) {\r\n           $result = array_replace_recursive($result, $configResult);\r\n       }\r\n   }\r\n\r\n   return $result;\r\n}\r\n<\/pre>\n
This is exactly the method where the files become merged. The line<\/p>\n
$result = array_replace_recursive($result, $fileBuffer);<\/pre>\n
recursively merges env.*.php<\/em> and config.*.php<\/em> files. And as we can see the data from env.*.php<\/em> is replaced by the data from the config.*.php<\/em> file.<\/p>\n
Unfortunately, it is impossible to reassign the data from the config.php<\/em> with the data from config.*.php<\/em> files. But generally, we do not need to do that, because config.php<\/em> contains the information about enabled modules, so, it does not have any information which needs to be modified. The priority of config.local.php<\/em> is higher than of config.dist.php<\/em>.<\/p>\n
Magento offers convenient ways to reassign file configurations without modifying the database, which lets us arrange flexible development and deploy processes and can also be pretty useful for quality assurance.<\/p>\n
UPD. You can back up the current store configurations by the following command:<\/p>\n
UPD 2: the file app\/etc\/config.local.php<\/em> is not supported<\/a> by Magento starting from version 2.2.0.<\/p>\n
php bin\/magento app:config:dump<\/em><\/p>\n
Consequently, Magento creates config.local.php<\/em> file and writes the data in it. But please keep in mind that confidential files, such as passwords, will not be included in that file.<\/p>\n","protected":false},"excerpt":{"rendered":"New projects are usually developed on a separate dedicated web-server which settings may differ from …","protected":false},"author":47,"featured_media":12696,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"image","meta":{"_acf_changed":false,"footnotes":""},"categories":[14,389],"tags":[],"class_list":["post-12693","post","type-post","status-publish","format-image","has-post-thumbnail","hentry","category-magento","category-magento2-development","post_format-post-format-image"],"acf":[],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t