README

Settings

A framework-agnostic PHP settings library for managing application configuration in a consistent and structured way.

Introduction

This library provides a lightweight wrapper around a plain PHP array, exposing a clean interface for storing and retrieving application configuration values. It offers a straightforward, dependency-free way to manage configuration without coupling application code to a specific framework, making it easy to drop into any project or architecture.

Prerequisites

• PHP: Version 8.3 or higher is required.
• Composer: Dependency management tool for PHP.

Installation

composer require andrewdyer/settings

Getting Started

Create a AndrewDyer\Settings\Settings instance by passing in the configuration array.

$settings = new Settings([
    'app_name' => 'My Application',
    'database' => [
        'host' => 'localhost',
        'port' => 5432,
        'credentials' => [
            'username' => 'admin',
            'password' => 'secret',
        ],
    ],
]);

Usage

Retrieve all settings

The entire settings array is returned by the all() method.

$all = $settings->all();

Retrieve a setting

A top-level setting is accessed by its key with the get() method.

$appName = $settings->get('app_name'); // 'My Application'

The get() method can also access nested settings using dot notation.

$host = $settings->get('database.host'); // 'localhost'

Dot notation can traverse multiple levels of configuration.

$username = $settings->get('database.credentials.username'); // 'admin'

Requesting a parent key with get() returns the entire nested configuration array.

$database = $settings->get('database');

Check if a setting exists

The has() method checks whether a top-level key exists.

$settings->has('app_name'); // true

The has() method also supports nested keys using dot notation.

$settings->has('database.credentials.password'); // true

Literal keys containing dots

If a top-level key contains dots, the exact key takes precedence over nested resolution.

$settings = new Settings([
    'database.host' => 'literal',
]);

$settings->get('database.host'); // 'literal'

If the exact key does not exist, the get() method falls back to resolving nested values using dot notation.

$settings = new Settings([
    'database' => [
        'host' => 'nested',
    ],
]);

$settings->get('database.host'); // 'nested'

License

Licensed under the MIT license and is free for private or commercial projects.