fink/config

A simple yet powerful configuration library for PHP

A simple yet powerful configuration library for PHP

, _(*1)

, _(*2)

Usage

Given this configuration file in json format:, _(*3)

{
  "section": {
    "key": "value"
  }
}

Use the configuration class like the following:, _(*4)

use \Fink\config\Configuration;

// create a new instance
$config = new Configuration("config.json", Configuration::JSON);

// access a specific value
echo $config->get("section", "key"); // echoes "value"

Features

Multiple configuration formats

The library currently supports json and ini format. If you want an additional format, open a new issue or pull request., _(*5)

Auto detection of configuration format

The second parameter of the class Configuration is optional. So this is equal:, _(*6)

config.ini, _(*7)

[section]
key = value

config.json, _(*8)

{
  "section": {
    "key": "value"
  }
}

Use it as the following, _(*9)

use \Fink\config\Configuration;

// create a new instance
$jsonConfig = new Configuration("config.json");
$iniConfig = new Configuration("config.ini");

echo $jsonConfig->get("section", "key"); // echoes "value"
echo $iniConfig->get("section", "key");  // echoes "value", too

Use custom configuration loaders

To create a new (custom) configuration loader, just create a new subclass of \Fink\config\loader\FileConfigurationLoader and implement the methods needed. Be sure to override the static class member $supportedFileTypes as a hint for supported configuration file types. Add the new configuration loader to the list of supported loaders:, _(*10)

use \Fink\config\Configuration;

Configuration::addConfigurationLoader(42, YourCustomConfigurationLoader::class);

$config = new Configuration("your-custom-configuration-syntax.type", 42);

Autodetect the correct loader will work for the custom one, too. If your custom loader supports a file type already supported by a predefined one, the loader with the smallest id will handle the configuration file., _(*11)