Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xety/configurator
A simple configuration class without dependencies that use the Fluent pattern.
https://github.com/xety/configurator
class config configuration fluent pattern
Last synced: 4 months ago
JSON representation
A simple configuration class without dependencies that use the Fluent pattern.
- Host: GitHub
- URL: https://github.com/xety/configurator
- Owner: Xety
- License: mit
- Created: 2017-06-01T15:51:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-06-03T12:47:13.000Z (over 7 years ago)
- Last Synced: 2024-04-29T10:44:28.287Z (9 months ago)
- Topics: class, config, configuration, fluent, pattern
- Language: PHP
- Homepage:
- Size: 24.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Configurator
|Travis|Coverage|Stable Version|Downloads|PHP|License|
|:-------:|:------:|:-------:|:------:|:-------:|:-------:|
|[](https://travis-ci.org/Xety/Configurator)|[](https://coveralls.io/r/Xety/Configurator)|[](https://packagist.org/packages/xety/configurator)|[](https://packagist.org/packages/xety/configurator)|[](https://travis-ci.org/Xety/Configurator)|[](https://github.com/Xety/Configurator/blob/master/LICENSE)|
A simple configuration class without dependencies that use the Fluent pattern.
# Requirement
# Installation
```sh
composer require xety/configurator
```
# Usage
The `Configurator` class is an abstract class, so you just need to `extends` it:
```php
'value',
//etc
];
public function __construct()
{
$this->setConfig($defaultConfig);
}
}
```
# Docs
## Methods
| Name | Description |
|------|-------------|
|[setConfig](#configuratorsetconfig)|Set the values to the options array.|
|[getConfig](#configuratorgetconfig)|Get all the options with their values.|
|[flushConfig](#configuratorflushconfig)|Flush a list of options from the config array.|
|[mergeConfig](#configuratormergeconfig)|Merge the values to the options array.|
|[clearConfig](#configuratorclearconfig)|Clear all options stored.|
|[setOption](#configuratorsetoption)|Set a value to the given option.|
|[getOption](#configuratorgetoption)|Get an option value.|
|[hasOption](#configuratorhasoption)|Check if the option exist.|
|[flushOption](#configuratorflushoption)|Flush an option.|
|[pushOption](#configuratorpushoption)|Push the listed args to the named option.|
|[consumeOption](#configuratorconsumeoption)|Read then flush an option.|
|[transientOption](#configuratortransientoption)|Adds a transient configuration key/value.|
### Configurator::setConfig
```php
public setConfig (array $values)
```
**Description**
Set the values to the options array.
This function will replace all the configuration options.
**Parameters**
* `(array) $values` : The values to push into the config.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::getConfig
```php
public getConfig (void)
```
**Description**
Get all the options with their values.
**Parameters**
`This function has no parameters.`
**Return Values**
`array`
### Configurator::flushConfig
```php
public flushConfig (string ...$filter)
```
**Description**
Flush a list of options from the options array.
Usage:
```php
$this->flushConfig('key1', 'key2', 'key3');
```
**Parameters**
* `(string) ...$filter` : All the options to remove from the config.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::mergeConfig
```php
public mergeConfig (array $values, bool $invert = false)
```
**Description**
Merge the values to the options array.
**Parameters**
* `(array) $values` : The values to merge in the config.
* `(bool) $invert` : Invert the merge by merging the actual config into the values.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::clearConfig
```php
public clearConfig (void)
```
**Description**
Clear all options stored.
**Parameters**
`This function has no parameters.`
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::setOption
```php
public setOption (string $name, mixed $value)
```
**Description**
Set a value to the given option.
Usage:
```php
$this->setOption('key', 'value');
$this->setOption('key', ['key2' => ['value2']]);
```
**Parameters**
* `(string) $name` : The option name.
* `(mixed) $value` : The option value.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::getOption
```php
public getOption (string $name)
```
**Description**
Get an option value.
Usage:
```php
$this->getOption('key');
```
**Parameters**
* `(string) $name` : The option name to to get.
**Return Values**
`mixed`
### Configurator::hasOption
```php
public hasOption (string $name)
```
**Description**
Check if the option exist.
**Parameters**
* `(string) $name` : The option name to check.
**Return Values**
`bool`
### Configurator::flushOption
```php
public flushOption (string $name)
```
**Description**
Flush an option.
**Parameters**
* `(string) $name` : The name of the option to flush.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::pushOption
```php
public pushOption (string $name, array $args)
```
**Description**
Push the listed args to the named option.
Usage:
```php
$this->pushOption('key', ['key1' => 'value1'], ['key2' => ['value2' => 'value3']]);
```
Result:
```php
'key' => [
'key1' => 'value1',
'key2' => [
'value2' => 'value3'
]
]
```
**Parameters**
* `(string) $name` : The name of the option.
* `(array) $args` : A list of values to push into the option key.
**Return Values**
`\Xety\Configurator\Configurator::class`
### Configurator::consumeOption
```php
public consumeOption (string $name)
```
**Description**
Read then flush an option.
Exemple:
Config:
```php
$config = [
'key1' => 'value1'
];
```
Usage:
```php
$result = $this->consumeOption('key1');
```
Result:
```php
echo $result; // value1
var_dump($config); // []
```
**Parameters**
* `(string) $name` : The name of the option to read then flush.
**Return Values**
`mixed`
### Configurator::transientOption
```php
public transientOption (string $name, mixed $value)
```
**Description**
Adds a transient configuration key/value.
Usage:
```php
// Will update the value of the key `key` if it exist,
// or it will create it with the value `value`.
$this->transientOption('key', 'value');
```
**Parameters**
* `(string) $name` : The name of the option.
* `(mixed) $value` : The value to set.
**Return Values**
`\Xety\Configurator\Configurator::class`
# Contribute
If you want to contribute, please [follow this guide](https://github.com/Xety/Configurator/blob/master/.github/CONTRIBUTING.md).