Download the PHP package berlioz/config without Composer
On this page you can find all versions of the php package berlioz/config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package config
Berlioz Configuration
Berlioz Configuration is a PHP library to manage your configuration files.
Installation
Composer
You can install Berlioz Configuration with Composer, it's the recommended installation.
Dependencies
- PHP ^8.0
- Packages:
- berlioz/helpers
- colinodell/json5
Usage
Create configuration object
You can create the configuration with adapters. 3 default adapters are available:
ArrayAdapter
: accept a PHP arrayIniAdapter
: accept a INI string or fileJsonAdapter
: accept a JSON/JSON5 string or file
Example:
Second parameter of IniAdapter
and JsonAdapter
constructors define that the first parameter is an url.
The order of adapter is important, the first have priority... So the value returned by get
method is the first adapter
to respond at key. If the value is an array, it will be merged with all adapters.
For more flexibility, you can define the priority by an integer in the constructor of adapters, withe the
parameter priority
.
Get value
To get value, you must call get
method:
The second parameter of ConfigInterface::get()
method is the default value if key does not exist. Default value of
this parameter is NULL
.
You can also test if a key exist:
Functions
Config
object accept a set of functions. The syntax to call a function is: {functionName:value}
.
A function call must be alone in value of configuration key.
Defaults functions:
config
: replace value by another part of configconstant
: replace value by a constantenv
: replace value by environment variablevar
: replace value by variable valuefile
: replace value by file contents
Examples:
Variables
You can define variables usable in configuration with function var
.
Define variables in the constructor:
You can also manipulate the variables after instantiation of config. Variables are stored in a ArrayObject
object,
accessible with Config::getVariables()
method:
Extend library
Create an adapter
You can create your own adapter. Only implements \Berlioz\Config\Adapter\AdapterInterface
interface.
This interface has only 3 methods:
AdapterInterface::getPriority(): int
ConfigInterface::get(string $key, mixed $default = null): mixed
ConfigInterface::has(string $key): bool
Look at the existent adapters in the source code of the library for inspiration.
Create a function
You can create your owns functions. Only implements \Berlioz\Config\ConfigFunction\ConfigFunctionInterface
interface.
This interface has only 2 methods:
ConfigFunctionInterface::getName(): string
ConfigFunctionInterface::execute(string $str): mixed
Look at the existent functions in the source code of the library for inspiration.