Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asispts/dicontainer
PSR-11 compliant PHP dependency injection container
https://github.com/asispts/dicontainer
container container-interop dependency-injection php psr-11 psr-11-compliant
Last synced: 9 days ago
JSON representation
PSR-11 compliant PHP dependency injection container
- Host: GitHub
- URL: https://github.com/asispts/dicontainer
- Owner: asispts
- License: apache-2.0
- Created: 2020-08-16T07:34:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T02:16:38.000Z (about 4 years ago)
- Last Synced: 2024-04-18T20:22:43.416Z (7 months ago)
- Topics: container, container-interop, dependency-injection, php, psr-11, psr-11-compliant
- Language: PHP
- Homepage:
- Size: 290 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# DiContainer
[](https://github.com/pattisahusiwa/dicontainer/actions)
[](https://coveralls.io/github/pattisahusiwa/dicontainer?branch=master)
[](https://github.com/pattisahusiwa/dicontainer/blob/master/LICENSE)
[](https://packagist.org/packages/xynha/dicontainer)
[](https://packagist.org/packages/xynha/dicontainer)
[](https://packagist.org/packages/xynha/dicontainer)
PSR-11 compliant PHP dependency injection container.
## Table of Contents
- [DiContainer](#dicontainer)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [DiContainer rules](#dicontainer-rules)
- [\# `shared`: `boolean` (default `false`)](#-shared-boolean-default-false)
- [\# `instanceOf`: `string|object` (default `null`)](#-instanceof-stringobject-default-null)
- [\# `constructParams`: `array` (default `null`)](#-constructparams-array-default-null)
- [\# `substitutions`: associative `array` (default `null`)](#-substitutions-associative-array-default-null)
- [\# `getFrom`: `array` (default `null`)](#-getfrom-array-default-null)
- [Use cases](#use-cases)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)
## Installation
Use [composer](https://getcomposer.org/) to install the library.
```bash
composer require xynha/dicontainer
```
## Usage
`DiContainer` can be used with or without configuration.
All classes that do not required constructor arguments, can be created directly.
````php
// Without configuration
$dic = new DiContainer(new DiRuleList);
$obj = $this->dic->get('classname');
````
However, for complex initialization, you have to define `DiContainer` rules and pass them to `DiRuleList`.
````php
// Construct rule list
$rlist = new DiRuleList();
// Add configuration from file
$json = json_decode(file_get_contents('filename'), true);
$rlist = $rlist->addRules($json);
// Add configuration manually
$rule['shared'] = true;
$rlist = $rlist->addRule('classname', $rule);
// Construct the container
$dic = new DiContainer($rlist);
$obj = $this->dic->get('classname');
````
## DiContainer rules
General format of `DiContainer` rules in JSON format:
````json
{
"rule_key" : {
"config_keys": "config_value"
},
"another_rule_key" : {
"config_keys": "config_value"
}
}
````
Where:
- `rule_key`, `another_rule_key` are a class or an interface namespace, and
- `config_keys` are supported rule keys:
- `shared`
- `instanceOf`
- `constructParams`
- `substitutions`
- `getFrom`
### \# `shared`: `boolean` (default `false`)
- Possible values:
* `true`, if the constructed instance can be shared betwen classes during execution,
* `false`, otherwise.
- Example:
````json
"classA" : {
"shared" : true
},
"classB" : {
"shared" : false
}
````
### \# `instanceOf`: `string|object` (default `null`)
- To override class or interface defined in `rule_key`.
- Possible values:
- `string`: class namespace
- `object`: already constructed instance.
- Example:
````json
"interfaceA" : {
"instanceOf" : "classA"
}
````
Example of passing already constructed instance,
````php
$rlist = new DiRuleList();
$rule['interfaceA'] = ['instanceOf' => $object];
$rlist = $rlist->addRules($rule);
````
### \# `constructParams`: `array` (default `null`)
- `constructParams` is a list of constructor argument values.
- Example:
````json
"classA" : {
"constructParams" : [
"arg1",
"arg2"
]
}
````
- Construct params can also be retrieved from another class by using `CALL::OBJECT` and `CALL::SCALAR` identifiers.
- `CALL::SCALAR` is used to retrieve `array` and `scalar` values
- `CALL::OBJECT` is used to retrieve `object` value.
- `CALL::OBJECT` and `CALL::SCALAR` format:
````json
"constructParams": [
["CALL::SCALAR", ["callback"], ["array_of_callback_arguments"]],
["CALL::OBJECT", ["callback"], ["array_of_callback_arguments"]]
]
````
- Example:
````php
class Config{
public function getConfig(string $key){
if ($key === 'db'){
return 'dbconfig';
}
}
}
class DatabaseDriver{
public function __construct(string $config){}
}
````
\# if constructed manually,
````php
$config = new Config();
$driver = new DatabaseDriver($config->getConfig('db'));
````
\# using `DiContainer`
````json
{
"DatabaseDriver" : {
"constructParams" : [
["CALL::SCALAR", ["Config","getConfig"], ["db"]]
]
}
}
````
````php
$driver = $dic->get(DatabaseDriver::class);
````
- A constant can be passed to constructor arguments by using `CALL::CONSTANT`, for example
````json
{
"$pdo": {
"instanceOf": "DatabaseDriver",
"constructParams": [
[
["CALL::CONSTANT", "PDO::ATTR_ERRMODE"],
["CALL::CONSTANT", "PDO::ERRMODE_EXCEPTION"]
]
]
}
}
````
### \# `substitutions`: associative `array` (default `null`)
- Substitute interface in the constructor argument with a substituted class.
- Example
````json
"classA" : {
"substitutions" : {
"interfaceB" : "classB",
"interfaceC" : "classC",
}
}
````
### \# `getFrom`: `array` (default `null`)
- Get `rule_key` instance from a factory or a class.
- `getFrom` format
````json
"getFrom" : [
["callback"],
[ "array_of_callback_arguments" ]
]
````
- Example
````json
"classA" : {
"getFrom" : [
["FactoryClassA", "getClassA"],
["arg1","arg2"]
]
},
"interfaceB" : {
"getFrom" : [
["FactoryClassB", "getClassB"],
["arg1",["array", "arguments"]]
]
}
````
## Use cases
Please check unit test configuration files in `tests/Data/config` and the corresponding tests.
## Changelog
See [CHANGELOG.md](https://github.com/pattisahusiwa/dicontainer/blob/master/CHANGELOG.md)
## Contributing
All form of contributions are welcome. You can [report issues](https://github.com/pattisahusiwa/dicontainer/issues), fork the repo and submit pull request.
For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
Released under [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0). See [LICENSE](https://github.com/pattisahusiwa/dicontainer/blob/master/LICENSE) file for more details.
````
Copyright 2020 Asis Pattisahusiwa
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
````