Read and write INI configurations.
composer require matomo/ini
PHP provides a parse_ini_file()
function to read INI files.
This component provides the following benefits over the built-in function:
true
/false
, on
/off
, yes
/no
) to real PHP booleans (instead of strings "1"
and ""
)null
(instead of an empty string)parse_ini_file()
or parse_ini_string()
is disabled in php.ini
by falling back on an alternate implementation (can happen on some shared hosts)$reader = new IniReader();
// Read a string
$array = $reader->readString($string);
// Read a file
$array = $reader->readFile('config.ini');
unexpected BOOL_TRUE in Unknown on line X
The PHP default implementation of read_ini_file does not allow bool-ish values as keys in when reading ini files.
Data like yes = "Yes"
results in the following error:
Syntax error in INI configuration: syntax error, unexpected BOOL_TRUE in Unknown on line 6
To prevent from that error, please switch to the custom ini reader implementation by using:
$reader = new IniReader();
$reader->setUseNativeFunction(false);
$writer = new IniWriter();
// Write to a string
$string = $writer->writeToString($array);
// Write to a file
$writer->writeToFile('config.ini', $array);
The Ini component is released under the LGPL v3.0.
To run the unit tests:
vendor/bin/phpunit
To run the performance tests:
php vendor/bin/phpbench run tests/PerformanceTest --report=default