Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/php-strict/container
Strict version of PSR-11 with additional methods to set/get references (instead of values) and get all container entries as array.
https://github.com/php-strict/container
container php php-library php7
Last synced: about 1 month ago
JSON representation
Strict version of PSR-11 with additional methods to set/get references (instead of values) and get all container entries as array.
- Host: GitHub
- URL: https://github.com/php-strict/container
- Owner: php-strict
- License: gpl-3.0
- Created: 2019-03-15T11:27:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-16T05:50:27.000Z (about 5 years ago)
- Last Synced: 2024-10-13T04:41:18.817Z (2 months ago)
- Topics: container, php, php-library, php7
- Language: PHP
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Container
[![Software License][ico-license]](LICENSE.txt)
[![Build Status][ico-travis]][link-travis]
[![codecov][ico-codecov]][link-codecov]
[![Codacy Badge][ico-codacy]][link-codacy]
Interface and implementation of common container.
Strict version of [PSR-11](https://www.php-fig.org/psr/psr-11/)
with additional methods to set/get references (instead of values)
and get all container entries as array.
## Requirements
* PHP >= 7.1
## Install
Install with [Composer](http://getcomposer.org):
```bash
composer require php-strict/container
```
## Usage
Classic usage:
```php
use PhpStrict\Container\Container
$container = new Container();
$container->set('key1', 1);
if ($container->has('key1')) {
$var1 = $container->get('key1');
}
```
Usage to set/get references:
```php
use PhpStrict\Container\Container
$myObject = new stdClass();
$container = new Container();
$container->setByRef('key2', $myObject);
$anotherObject =& $container->getRef('key2');
```
Set container values through constructor:
```php
use PhpStrict\Container\Container
$container = new Container([
'key1' => 1,
'key2' => 'value 2',
'key3' => true,
]);
if ($container->has('key2')) {
$var2 = $container->get('key2');
}
```
Unpacking container through callback:
```php
use PhpStrict\Container\Container
class MyClass
{
protected $field1;
protected $field2;
protected $field3;
public function unpacker(array $entries): void
{
foreach ($entries as $key => $value) {
$this->$key = $value;
}
}
}
$container = new Container([
'field1' => 1,
'field2' => 'value 2',
'field3' => true,
]);
$myClassObject = new MyClass();
$container->unpackWith([$myClassObject, 'unpacker']);
```
## Tests
To execute the test suite, you'll need [Codeception](https://codeception.com/).
```bash
vendor\bin\codecept run
```
[ico-license]: https://img.shields.io/badge/license-GPL-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/php-strict/container/master.svg?style=flat-square
[link-travis]: https://travis-ci.org/php-strict/container
[ico-codecov]: https://codecov.io/gh/php-strict/container/branch/master/graph/badge.svg
[link-codecov]: https://codecov.io/gh/php-strict/container
[ico-codacy]: https://api.codacy.com/project/badge/Grade/05da7e110e55465bae0d54da68c4f2d1
[link-codacy]: https://www.codacy.com/app/php-strict/container?utm_source=github.com&utm_medium=referral&utm_content=php-strict/container&utm_campaign=Badge_Grade