Read and write INI configurations.
PHP
Clone or download
sgiehl Rename Piwik -> Matomo (#8)
* Rename Piwik -> Matomo

* fix coveralls
Latest commit ac25c89 Feb 14, 2018

README.md

Matomo/Ini

Read and write INI configurations.

Build Status Coverage Status Latest Version

Installation

composer require matomo/ini

Why?

PHP provides a parse_ini_file() function to read INI files.

This component provides the following benefits over the built-in function:

  • allows to write INI files
  • classes can be used with dependency injection and mocked in unit tests
  • throws exceptions instead of PHP errors
  • better type supports:
  • works even if 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)
  • fixes a PHP 5.3.3 bug
  • fixes a parsing bug present in PHP <= 5.4.4

Usage

Read

$reader = new IniReader();

// Read a string
$array = $reader->readString($string);

// Read a file
$array = $reader->readFile('config.ini');

Write

$writer = new IniWriter();

// Write to a string
$string = $writer->writeToString($array);

// Write to a file
$writer->writeToFile('config.ini', $array);

License

The Ini component is released under the LGPL v3.0.

Contributing

To run the unit tests:

vendor/bin/phpunit

To run the performance tests:

php -n vendor/bin/athletic -p tests/PerformanceTest