CodeIgniter4: Bug: BaseConfig issue on registrar
PHP Version
8.2
CodeIgniter4 Version
4.5.5
CodeIgniter4 Installation Method
Manual (zip or tar.gz)
Which operating systems have you tested for this bug?
Windows, Linux
Which server did you use?
apache
Database
MySQL
What happened?
New registrar with the same method with other registrars replaces their contents on array_merge which works on only first level array. I hope array_merge_recursive will be better for modules
Steps to Reproduce
\Codeigniter\Config\BaseConfig
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @return void
*
* @throws ReflectionException
*/
protected function registerProperties()
{
if (! static::$moduleConfig->shouldDiscover('registrars')) {
return;
}
if (! static::$didDiscovery) {
$locator = service('locator');
$registrarsFiles = $locator->search('Config/Registrar.php');
foreach ($registrarsFiles as $file) {
$className = $locator->findQualifiedNameFromPath($file);
if ($className === false) {
continue;
}
static::$registrars[] = new $className();
}
static::$didDiscovery = true;
}
$shortName = (new ReflectionClass($this))->getShortName();
// Check the registrar class for a method named after this class' shortName
foreach (static::$registrars as $callable) {
// ignore non-applicable registrars
if (! method_exists($callable, $shortName)) {
continue; // @codeCoverageIgnore
}
$properties = $callable::$shortName();
if (! is_array($properties)) {
throw new RuntimeException('Registrars must return an array of properties and their values.');
}
foreach ($properties as $property => $value) {
if (isset($this->{$property}) && is_array($this->{$property}) && is_array($value)) {
$this->{$property} = array_merge($this->{$property}, $value);
} else {
$this->{$property} = $value;
}
}
}
}
Expected Output
Expected merge the old contents array with the new one
Anything else?
Yes i used array_merge_recursive. I discovered the issue to so i extend the base config to child class today fix this but i think the usage of array_merge_recursive is a better option help on this to update the core code
\Codeigniter\Config\BaseConfig
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @return void
*
* @throws ReflectionException
*/
protected function registerProperties()
{
if (! static::$moduleConfig->shouldDiscover('registrars')) {
return;
}
if (! static::$didDiscovery) {
$locator = service('locator');
$registrarsFiles = $locator->search('Config/Registrar.php');
foreach ($registrarsFiles as $file) {
$className = $locator->findQualifiedNameFromPath($file);
if ($className === false) {
continue;
}
static::$registrars[] = new $className();
}
static::$didDiscovery = true;
}
$shortName = (new ReflectionClass($this))->getShortName();
// Check the registrar class for a method named after this class' shortName
foreach (static::$registrars as $callable) {
// ignore non-applicable registrars
if (! method_exists($callable, $shortName)) {
continue; // @codeCoverageIgnore
}
$properties = $callable::$shortName();
if (! is_array($properties)) {
throw new RuntimeException('Registrars must return an array of properties and their values.');
}
foreach ($properties as $property => $value) {
if (isset($this->{$property}) && is_array($this->{$property}) && is_array($value)) {
$this->{$property} = array_merge_recursive($this->{$property}, $value);
} else {
$this->{$property} = $value;
}
}
}
}
About this issue
- Original URL
- State: open
- Created 2 years ago
- Comments: 16 (12 by maintainers)
There haven’t been any updates so far. Unless more maintainers express agreement on introducing such changes, we won’t be moving forward at this time.
IMHO, permission definitions should remain centralized in a single main file for security and maintainability reasons.
However, if you’re confident in what you’re doing, you can simply use
ReflectionClassin yourRegistrar.phpfile to merge the basesuperadminpermission array with additional items.Certainly! Let’s explore this issue in detail, starting with examples of the problem.
Example of the Problem: Config File and Registrar
In a typical modular CodeIgniter 4 application, you might have several independent modules, each with its own
Registrar.phpfile. These registrars are meant to register specific configuration settings, such as filters, routes, or other properties, into a central configuration system.Example Configuration Files
Blog Module Registrar:
Shop Module Registrar:
Paypal Module Registrar:
These files define filters that are supposed to be registered into the main configuration. The expectation is that all these configurations should be combined, so the application uses filters from all modules.
The Problem: Overwriting Instead of Merging
The issue arises due to the way the
registerPropertiesmethod handles the merging of configuration arrays. The current implementation usesarray_merge, which works fine for single-dimensional arrays but doesn’t perform a deep merge. This means that when you have nested arrays, the nested arrays from one module can overwrite those of another module instead of merging them.For example, if the
filtersmethod is defined similarly in multiple modules, the last one processed will overwrite the previous ones rather than integrating all of them.Are You Defining the Same Registrar in Many Modules?
Yes, in this context, the same registrar method (
filters) is defined in multiple modules. Each module has its own implementation of thefiltersmethod within itsRegistrar.phpfile. The intention is for each module to contribute its filters to the central configuration.Solution: Deep Merging
To solve this issue, a deep merge function is needed. This function should recursively merge arrays to ensure that all configurations are retained and integrated properly. Here’s a simple example of how I implement a deep merge function in PHP:
Applying the Solution
In the
registerPropertiesmethod, I replace thearray_mergeoperation with thisdeep_mergefunction to ensure that all configurations from different modules are properly merged.Solution Output:
After applying the
deepMergefunction, the combined configuration will look like this:Explanation of the Output
Aliases: The
aliasesarray now contains all filter aliases from the Blog, Shop, and Paypal modules, ensuring that each module’s filter is registered.Globals: The
globalsarray for thebeforekey contains an array with all filter names, ensuring that all specified filters are applied before global processing.This method guarantees that all configuration data is retained, allowing each module to seamlessly contribute to the overall application setup. By using a deep merge function, the solution ensures that nested arrays are combined effectively, thereby preserving the unique configurations intended by each module’s developer. This approach respects the configurations from all modules and integrates them cohesively, maintaining the integrity of the application’s intended settings.
I will assume this is the proper example:
Now, you will get this:
But you expect this:
This is not a bug, but a feature request. Personally, I’m not a fan of this change.
You can avoid this problem very simply - by defining the structure of the config file differently.