Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/dovetail
Comprehensive config solution for PHP
https://github.com/decodelabs/dovetail
Last synced: 1 day ago
JSON representation
Comprehensive config solution for PHP
- Host: GitHub
- URL: https://github.com/decodelabs/dovetail
- Owner: decodelabs
- License: mit
- Created: 2023-10-17T12:31:58.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T20:58:16.000Z (4 months ago)
- Last Synced: 2024-12-08T10:05:55.944Z (about 1 month ago)
- Language: PHP
- Size: 42 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Dovetail
[](https://packagist.org/packages/decodelabs/dovetail)
[](https://packagist.org/packages/decodelabs/dovetail)
[](https://packagist.org/packages/decodelabs/dovetail)
[](https://github.com/decodelabs/dovetail/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/dovetail)
### Comprehensive config solution for PHP
Dovetail provides a simple, flexible and powerful way to manage configuration data in PHP applications.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
Install via Composer:
```bash
composer require decodelabs/dovetail
```
## Usage
### Importing
Dovetail uses [Veneer](https://github.com/decodelabs/veneer) to provide a unified frontage under DecodeLabs\Dovetail.
You can access all the primary functionality via this static frontage without compromising testing and dependency injection.
### Env
Dovetail utilises [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv) to load environment variables from a `.env` file in your project root. This is automatically loaded when you first access the Env facade.
```php
use DecodeLabs\Dovetail;
$dbHost = Dovetail::envString('DB_HOST', 'localhost'); // String
$dbPort = Dovetail::envInt('DB_PORT', 3306); // Int
$debug = Dovetail::envBool('DEBUG', false); // Bool
$test = Dovetail::env('TEST', 'default'); // Mixed
```
### Config
Dovetail provides structures to allow loading config files from any custom location, into Repository container tree objects, and presented in domain specific Config objects which can then provide custom data access methods according to your needs.
Sensitive data should be loaded from a `.env` file and not stored in config files - use the Dovetail::env*() methods or $_ENV to inject these values into your config.
```php
# config/database.php
use DecodeLabs\Dovetail;
return [
'adapter' => 'mysql',
'host' => $_ENV['DB_HOST'] ?? 'localhost',
// or
'port' => Dovetail::envInt('DB_PORT', 3306),
];
```
```php
# app/Config/Database.php
use DecodeLabs\Dovetail\Config;
use DecodeLabs\Dovetail\ConfigTrait;
class Database implements Config
{
use ConfigTrait;
public function getAdapter(): string
{
return $this->data['adapter'] ?? 'mysql';
}
public function getHost(): string
{
return $this->data['host'] ?? 'localhost';
}
public function getPort(): int
{
return $this->data['port'] ?? 3306;
}
}
```
```php
use DecodeLabs\Dovetail;
$config = Dovetail::load('database');
$adapter = $config->getAdapter(); // 'mysql'
```
## Licensing
Dovetail is licensed under the proprietary License. See [LICENSE](./LICENSE) for the full license text.