https://github.com/parable-php/di
Parable DI is a no-nonsense dependency injection container.
https://github.com/parable-php/di
dependency dependency-injection deps di parable parable-di php8 service-container
Last synced: 2 months ago
JSON representation
Parable DI is a no-nonsense dependency injection container.
- Host: GitHub
- URL: https://github.com/parable-php/di
- Owner: parable-php
- License: mit
- Created: 2018-08-09T12:45:39.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2025-02-01T08:33:51.000Z (8 months ago)
- Last Synced: 2025-04-03T07:22:57.079Z (6 months ago)
- Topics: dependency, dependency-injection, deps, di, parable, parable-di, php8, service-container
- Language: PHP
- Homepage:
- Size: 53.7 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Parable DI Container
[](https://github.com/parable-php/di/actions?query=workflow%3ATests)
[](https://packagist.org/packages/parable-php/di)
[](https://packagist.org/packages/parable-php/di)
[](https://packagist.org/packages/parable-php/di)
Parable DI is a no-nonsense dependency injection container that gets the job done.
## Install
Php 8.0+ and [composer](https://getcomposer.org) are required.
```bash
$ composer require parable-php/di
```
## Usage
Example usage of a straightforward situation:
```php
use \Parable\Di\Container;
$container = new Container();
$app = $container->get(App::class);
$app->run();
```
Example usage of an interface-hinted dependency being mapped:
```php
use \Parable\Di\Container;
$container = new Container();
class App
{
public function __construct(ThatInterface $classWithThatInterface)
{
}
public function run()
{
echo "Run? RUN!";
}
}
$container->map(ThatInterface::class, ClassWithThatInterface::class);
$app = $container->get(App::class);
$app->run();
```
The above situation can also be solved by instantiating and then storing `ClassWithThatInterface` under `ThatInterface`.
Example usage of a class that needs the di itself, in case you need to do dynamic DI:
```php
use \Parable\Di\Container;
$container = new Container();
class App
{
public $container;
public function __construct(
public Container $container
) {}
}
$app = $container->get(App::class);
var_dump($app->container->has(App::class)); // output: bool(true)
```
For all other use cases, simply check the tests in `tests/ContainerTest.php`.
## API
- `get(string $name): object` - creates or gets instance
- `has(string $name): bool` - check if instance is stored
- `assertHas(string $name): void` - check and throw exception if instance is not stored
- `build(string $name): object` - build instance with stored deps, don't store
- `buildAll(string $name): object` - build instance with new deps, don't store
- `map(string $requested, string $replacement): void` - allow pre-emptively defining a replacement class to be instantiated when the requested name is retrieved or built. Use for lazy-loading classes, i.e. for interface deps.
- `unmap(string $requested): void` - removes the mapping _and_ clears any previously mapped instances
- `getDependenciesFor(string $name, [int $storedDependencies]): array` - get dependencies for instance, with stored (default) or new deps
- `store(object $instance, [string $name]): void` - store instance under name, or under instance name by default
- `clear(string $name): void` - clear instance
- `clearExcept(array $keep): void` - clear all except provided names, throws if any of the instances to keep doesn't exist
- `clearAll(): void` - clear all
Where `object` refers to any instance of any class.
## Contributing
Any suggestions, bug reports or general feedback is welcome. Use github issues and pull requests, or find me over at [devvoh.com](https://devvoh.com).
## License
All Parable components are open-source software, licensed under the MIT license.