Merge pull request #5748 from MrPetovan/bug/fix-addon-config-overwrite

Add overwrite parameter to App->loadConfigFile
This commit is contained in:
Michael Vogel 2018-09-08 13:15:15 +00:00 committed by GitHub
commit 21341eb32c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -372,13 +372,13 @@ class App
} }
if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) { if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php')) {
$this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php'); $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', true);
} }
} }
/** /**
* Tries to load the specified configuration file into the App->config array. * Tries to load the specified configuration file into the App->config array.
* Overwrites previously set values. * Doesn't overwrite previously set values by default to prevent default config files to supersede DB Config.
* *
* The config format is INI and the template for configuration files is the following: * The config format is INI and the template for configuration files is the following:
* *
@ -391,9 +391,10 @@ class App
* // Keep this line * // Keep this line
* *
* @param type $filepath * @param type $filepath
* @param bool $overwrite Force value overwrite if the config key already exists
* @throws Exception * @throws Exception
*/ */
public function loadConfigFile($filepath) public function loadConfigFile($filepath, $overwrite = false)
{ {
if (!file_exists($filepath)) { if (!file_exists($filepath)) {
throw new Exception('Error parsing non-existent config file ' . $filepath); throw new Exception('Error parsing non-existent config file ' . $filepath);
@ -409,7 +410,11 @@ class App
foreach ($config as $category => $values) { foreach ($config as $category => $values) {
foreach ($values as $key => $value) { foreach ($values as $key => $value) {
if ($overwrite) {
$this->setConfigValue($category, $key, $value); $this->setConfigValue($category, $key, $value);
} else {
$this->setDefaultConfigValue($category, $key, $value);
}
} }
} }
} }
@ -427,7 +432,7 @@ class App
// Load the local addon config file to overwritten default addon config values // Load the local addon config file to overwritten default addon config values
if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) { if (file_exists($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php')) {
$this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php'); $this->loadConfigFile($this->basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'addon.ini.php', true);
} }
} }
@ -1244,6 +1249,20 @@ class App
return $return; return $return;
} }
/**
* Sets a default value in the config cache. Ignores already existing keys.
*
* @param string $cat Config category
* @param string $k Config key
* @param mixed $v Default value to set
*/
private function setDefaultConfigValue($cat, $k, $v)
{
if (!isset($this->config[$cat][$k])) {
$this->setConfigValue($cat, $k, $v);
}
}
/** /**
* Sets a value in the config cache. Accepts raw output from the config table * Sets a value in the config cache. Accepts raw output from the config table
* *