navindex/simple-config

Simple library to create and modify a configuration structure.

v0.2.0 2021-09-27 07:35 UTC

Requires

• php: ^7.3|^8.0

Requires (Dev)

• larapack/dd: ^1.1
• php-coveralls/php-coveralls: ^2.4
• phpstan/phpstan: ^0.12.99
• phpunit/phpunit: ^9.5

MIT

• Miklos Karpati

• php
• configuration
• config
• options
• Navindex

README

1. What Is It

Simple config is a class to work with configuration settings. It helps you to perform actions like add, remove, check, append, subtract etc. by using dot notation keys.

2. What Is It Not

This library does not read the filesystem or other environment settings. To use an .env file to feed Simple config, use it together with phpdotenv or other similar library.

3. Installation

This package can be installed through Composer.

composer require navindex/simple-config

4. Usage

use Navindex\SimpleConfig\Config;

$options = [
    'number of fingers' => 5,
    'allowed pets' => ['dog', 'cat', 'spider'],
    'cat' => [
        'name' => 'Mia',
        'food' => ['tuna', 'chicken', 'lamb'],
    ],
    'dog' => [
        'name' => 'Bless',
        'color' => [
            'body' => 'white',
            'tail' => 'black',
        ]
    ],
    'spider' => true,
    42,
    'some text'
];

$config = new Config($options);

$config
    ->set('spider', false)
    ->unset('dog.color.tail')
    ->append('cat.food', 'salmon')
    ->subtract('cat.food', 'tuna');

$spider = $config->get('spider');

$doWeHaveDog = $config->has('dog');

$arrConfig = $config->toArray();

5. Actions

6. About Navindex

Navindex is a web development agency in Melbourne, Australia. You'll find an overview of our cmpany on our website.