https://github.com/maplephp/container
PSR Container built for PHP Fuse framework
https://github.com/maplephp/container
Last synced: 11 months ago
JSON representation
PSR Container built for PHP Fuse framework
- Host: GitHub
- URL: https://github.com/maplephp/container
- Owner: MaplePHP
- License: apache-2.0
- Created: 2023-03-29T08:12:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-14T19:11:14.000Z (about 1 year ago)
- Last Synced: 2025-05-14T20:28:13.711Z (about 1 year ago)
- Language: PHP
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Container, Factories and the dependency injector
PSR Container built for MaplePHP framework
Container, Factories and dependency injectors will help to make your PHP code more maintainable, flexible, and testable by reducing coupling between objects and centralizing the management of dependencies.
- [Container](#container)
- [Factory](#factory)
- [Dependency injector](#dependency-injector)
- [Event handler](#event-handler)
## Container
Containers allowing you to easily create and retrieve objects that are needed throughout your application.
```php
use MaplePHP\Container\Container;
$container = new Container();
$container->set("YourClass", \YourNamespace\To\YourClass::class); // Bind "YourClass" to container and dependency injector
$yourClass = $container->get("YourClass")->get(); // Will return "YourClass"
//$yourClass->yourClassMehthod();
```
If the constructor of "YourClass" contains unresolved class arguments, the dependency injector will attempt to automatically locate them for you. Read more under the headline **dependency injector**.
## Factory
Factories can be used to create new instances of objects, rather than instantiating them directly in your code.
```php
$container->factory("factoryKey", function() {
$a = new TestClassA();
$b = new TestClassB();
return new TestClassC($a, $b);
});
echo $container->get("factoryKey"); // Will return TestClassC
```
## Dependency injector
Dependency injection is a technique for managing dependencies between objects in an application. Instead of creating objects directly in your code, you can pass them in as dependencies when you instantiate an object. This makes your code more modular and easier to test, as you can easily swap out dependencies for mock objects or other implementations.
You can use the **Dependency injector** just like create any other container, as long as you dont add arguments or try to access method, if you do that then it will automatically disable **Dependency injector**. It is design like this becouse it will load in all class reclusive into endlessly.
Take a look at this example
```php
$container->set("YourClass", \YourNamespace\To\YourClass::class);
$testService = $container->get("YourClass");
echo $testService->start();
```
The above code will load **YourClass** and auto initialize the class **Test**.
```php
namespace YourNamespace\To;
use YourNamespace\ToTestClasses\Test;
class YourClass {
private $test;
// Dependency injector will auto load "Test" class and the "Test" classes and so on.
function __construct(Test $test) {
$this->test = $test;
}
function start() {
return $this->test->get("This is the start page");
}
}
```
## Event handler
### Initiate
```php
use MaplePHP\Container\EventHandler;
```
### Example 1 - (Callable)
```php
$logger = new EventHandler();
$logger->addHandler(new Logger());
$logger->addEvent(function() {
var_dump("Executed in conjunction with logger every method");
// You could add a mail function that will send log message to you,
});
echo $logger->error("A error message to log");
// Will log message AND execute the event
```
### Example 2 - (Bind to method)
```php
$logger = new EventHandler();
$logger->addHandler(new Logger(), ["emergency", "alert", "critical"]);
$logger->addEvent(function() {
var_dump("Executed in conjunction with logger event method");
// You could add a mail function that will send log message to you,
});
echo $logger->error("A error message to log");
// Will only log message
echo $logger->alert("A error message to log");
// Will log message AND execute the event
```
### Example 3 - (Add service to handler)
Set the namespace to the **EventInterface**.
```php
use MaplePHP\Container\Interfaces\EventInterface;
```
Then extend a class with implements to the interface **EventInterface** and add the method **resolve** to that class. I am using a "Anonymous Function" bellow as an example just to show that **EventInterface** is required, you can use a regular class.
```php
$callableFunction = new class implements EventInterface {
public function someMethod(string $what): string
{
return "Hello {$what}!";
}
// Resolve method will be executed in conjunction
// with logger event method
public function resolve(): void
{
var_dump($this->someMethod("world"));
}
};
$logger = new EventHandler();
$logger->addHandler(new Logger(), ["emergency", "alert", "critical"]);
$logger->addEvent(function() {
var_dump("Executed in conjunction with logger event method");
// You could add a mail function that will send log message to you,
});
echo $logger->error("A error message to log");
// Will only log message
echo $logger->alert("A error message to log");
// Will log message AND execute the event
```