Download the PHP package navindex/simple-config without Composer
On this page you can find all versions of the php package navindex/simple-config. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download navindex/simple-config
More information about navindex/simple-config
Files in navindex/simple-config
Package simple-config
Short Description Simple library to create and modify a configuration structure.
License MIT
Homepage https://github.com/balinomad/simple-config
Informations about the package simple-config
Simple config 
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.
4. Usage
The Config
object is immutable. This means methods like with
, without
, append
, and merge
do not change the original object; they return a new, modified Config
instance.
5. API Reference
Method | Attributes | Returns | Description |
---|---|---|---|
constructor | ?array $config , int $cleaningFlags |
self |
Creates a new Config instance. |
with |
$key , $value |
self |
Returns a new instance with a value set. |
without |
$key |
self |
Returns a new instance with a key removed. |
get |
$key , $default |
mixed |
Retrieves a value using dot notation. |
has |
$key |
bool |
Checks if a key exists. |
append |
$key , $value |
self |
Returns a new instance with a value appended to an array. |
subtract |
$key , $value |
self |
Returns a new instance with a value removed from an array. |
merge |
$config , $method |
self |
Returns a new instance merged with another configuration. |
split |
$key |
self |
Returns a new instance containing only a subset of the config. |
toArray |
- | array |
Returns the entire configuration as an array. |
count |
- | int |
Counts all leaf configuration values. Non-associative arrays are counted as a single leaf. |
getIterator |
- | Traversable |
Gets an iterator for the top-level items. |
offsetExists |
$offset |
bool |
Implements ArrayAccess . Checks if a key exists (e.g., isset($config['app.key']) ). |
offsetGet |
$offset |
mixed |
Implements ArrayAccess . Gets a value (e.g., $config['app.key'] ). |
Note: Modifying a Config
object via array access (e.g., $config['key'] = 'value'
) is not permitted and will throw a LogicException
. Use the with()
and without()
methods instead.