mediadevs/configuration

A lightweight package for managing configuration files.

1.0.1 2019-11-12 16:27 UTC

This package is auto-updated.

Last update: 2024-04-10 05:01:29 UTC


README

Total Downloads Latest Unstable Version Latest Stable Version Version Software License Code Intelligence Status Build Status Code Coverage Scrutinizer Code Quality Minimum PHP Version StyleCI

Install

Via Composer

$ composer require mediadevs/configuration

Via GIT

HTTPS:
git clone https://github.com/mediadevs/configuration.git

SSH:
git clone git@github.com:mediadevs/configuration.git

Usage

<?php

use Mediadevs\Configuration\Configuration;
use \Mediadevs\Configuration\Exceptions\ConfigurationFileException;
use \Mediadevs\Configuration\Exceptions\InvalidReturnTypeException;
use \Mediadevs\Configuration\Exceptions\ConfigurationDirectoryException;

try {
    $config = (new Configuration())
        ->directory('./config')
        ->config('config_file')
        ->get(Configuration::RETURN_TYPE_ARRAY);
    /**
     * Possible return types:
     * array:   (Configuration::RETURN_TYPE_ARRAY)
     * Json:    (Configuration::RETURN_TYPE_JSON)
     */
} catch (ConfigurationDirectoryException $e) {
    echo $e->errorMessage();
} catch (ConfigurationFileException $e) {
    echo $e->errorMessage();
} catch (InvalidReturnTypeException $e) {
    echo $e->errorMessage();
}

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email contact@mediadevs.nl instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.