Download the PHP package jasny/config without Composer

Jasny's Config class

Configure your application. Implements PSR-11 to be used as container.

Installation

Jasny Config is registred at packagist as jasny/config and can be easily installed using composer.

composer require jasny/config

Usage

Loaders

• Dir
• Ini
• Json
• Yaml
  • Symfony
  • Yaml extension
• Env
• DynamoDB

The DelegateLoader can pick a loader based on class name or file extension.

For every loader; a Jasny\Config\LoadException is thrown if the loader can't load the settings.

Dir

DirLoader loader will traverse through every file in a directory. It uses the filename (without extension) as key name.

Ini

IniLoader parses an INI file using parse_ini_file.

Json

JsonLoader parses a JSON file using json_decode.

Yaml

YamlLoader parses a YAML file using yaml_parse.

The YamlLoader is used by default if the yaml extension is loaded.

Symfony\Yaml

YamlSymfonyLoader is an alternative loader for YAML, using the Symfony Yaml component.

When constructing the loader a Symfony\Component\Yaml\Parser object may be passed.

Env

EnvLoader maps environment variables to settings. In the mapping the settings key supports dot notation.

Example

DynamoDB

DynamoDBLoader allows loading settings from an AWS DynamoDB database. It expects all settings to be in a single item. It will not do a table scan. By default the whole item is taken as settings. Alternatively, use the settings_field option to specify a Map field that holds the settings.

Example

DelegateLoader

The DelegateLoader is a map with loaders, than can automatically pick a loader based on the file extension or class name.

By default it holds all the loaders of this library. You may pass an array of loaders as dependency injection.

Config

The Config object is a dynamic object; settings are added as public properties. It extends the stdClass object.

Upon construction you can pass settings as associative array or stdClass object.

Optionally you can pass a loader. If your config is only in JSON files, consider passing the JsonLoader. This saves the creation of the DelegateLoader and loaders for all other file types.

load()

Load new setting from file or other data source and add it to the config.

load(string|object $source, array $options = [])

This is a fluent interface, so the method returns $this.

Example

merge()

Merge one or more Config (or stdClass) objects into the config.

merge(stdClass $settings, ...)

This is a fluent interface, so the method returns $this.

get()

The Config object implements the PSR-11 ContainerInterface. The get method finds a setting in the config by key. The dot notation may be used to get child properties.

mixed get(string $key)

If the setting doesn't exist, a Jasny\Config\Exception\NotFoundException is thrown.

Example

has()

The has method is part of the PSR-11 ContainerInterface. It checks if a setting exists. As with get(), the key supports the dot notation.

bool has(string $key)

saveAsScript() / loadFromScript()

The saveAsScript() method create parsable string representation of a variable using var_export and store it as a PHP script.

As described in the 500x faster caching article, storing the parsed configuration as a PHP script can make loading it much faster.

The loadFromScript() method can be used to load the settings. It's recommended to use this function rather than just file_exists and include, as checking the file exists would always hit the file system. This function checks the opcode cache first.