# ParameterBag

**Repository Path**: wfdaj/ParameterBag

## Basic Information

- **Project Name**: ParameterBag
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-10-26
- **Last Updated**: 2023-10-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# InitPHP ParameterBag

Single and multi-dimensional parameter bag.

[![Latest Stable Version](http://poser.pugx.org/initphp/parameterbag/v)](https://packagist.org/packages/initphp/parameterbag) [![Total Downloads](http://poser.pugx.org/initphp/parameterbag/downloads)](https://packagist.org/packages/initphp/parameterbag) [![Latest Unstable Version](http://poser.pugx.org/initphp/parameterbag/v/unstable)](https://packagist.org/packages/initphp/parameterbag) [![License](http://poser.pugx.org/initphp/parameterbag/license)](https://packagist.org/packages/initphp/parameterbag) [![PHP Version Require](http://poser.pugx.org/initphp/parameterbag/require/php)](https://packagist.org/packages/initphp/parameterbag)

![parameterbag](https://initphp.github.io/logos/parameterbag.png)

## Installation

```
composer require initphp/parameterbag
```

## Requirements

- PHP 7.2 or later

## Usage

```php
require_once "vendor/autoload.php";
use \InitPHP\ParameterBag\ParameterBag;

$parameter = new ParameterBag($_GET);

// GET /?user=muhametsafak
echo $parameter->get('user', null); // "muhametsafak"
```

### Using nested arrays

```php
require_once "vendor/autoload.php";
use \InitPHP\ParameterBag\ParameterBag;

$data = [
    'database'  => [
        'dsn'           => 'mysql:host=localhost',
        'username'      => 'root',
        'password'      => '123456'
    ]
];

$parameter = new ParameterBag($data, ['isMulti' => true, 'separator' => '.']);

$parameter->get('database.username'); // "root" 
$parameter->has('database.charset'); // false
```

### Methods

#### `has()`

```php
public function has(string $key): bool;
```

#### `get()`

```php
public function get(string $key, mixed $default = null): mixed;
```

#### `set()`

```php
public function set(string $key, mixed $value): \InitPHP\ParameterBag\ParameterBagInterface;
```

#### `remove()`

```php
public function remove(string ...$keys): \InitPHP\ParameterBag\ParameterBagInterface;
```

#### `all()`

```php
public function all(): array;
```

#### `merge()`

```php
public function merge(array|\InitPHP\ParameterBag\ParameterBagInterface ...$merge): \InitPHP\ParameterBag\ParameterBagInterface;
```

## Credits

- [Muhammet ŞAFAK](https://www.muhammetsafak.com.tr) <<info@muhammetsafak.com.tr>> 

## License

Copyright &copy; 2022 - [MIT License](./LICENSE)