Merge pull request #3 from MaplePHP/develop

v2.0.0 - Improve code quality and ensure compatibility with PHP 8.1+

Author: wazabii8

Interfaces/ContainerExceptionInterface.php

@@ -14,10 +14,14 @@ Container, Factories and dependency injectors will help to make your PHP code mo
 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();
+
+// You can set mixed values in the container
+$container->set("hasEmail", true);
+
+$hasEmail = $container->get("hasEmail")->get();
+var_dump($hasEmail); // Result in: (bool) true
 ```
 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**.
 
@@ -40,32 +44,16 @@ 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;
+use MaplePHP\Container\Container;
+use MaplePHP\Container\Autowire;
+use App\Services\MailService;
 
-    // Dependency injector will auto load "Test" class and the "Test" classes and so on.
-    function __construct(Test $test) {
-        $this->test = $test;
-    }
+$container = new Container();
+$container->set("MailService", new Autowire(MailService::class));
 
-    function start() {
-        return $this->test->get("This is the start page");
-    }
-    
-}
+// This will return "MailService" with all dependencies resolved on constructor
+$mailService = $container->get("MailService")->get();
+echo $mailService->send();
 ```
 
 ## Event handler

Interfaces/ContainerInterface.php

@@ -1,11 +1,10 @@
 {
   "name": "maplephp/container",
   "type": "library",
-  "version": "v1.1.4",
   "description": "Container, Factories and dependency injectors with full PSR-11 support.",
   "keywords": [
     "container",
-    "psr11",
+    "PSR-11",
     "factories",
     "dependency injectors",
     "injectors"
@@ -23,12 +22,13 @@
     }
   ],
   "require": {
-    "php": ">=8.0",
-    "maplephp/dto": "^3.0"
+    "php": ">=8.2",
+    "psr/container": "^2.0",
+    "maplephp/dto": "^3.1"
   },
   "autoload": {
     "psr-4": {
-      "MaplePHP\\Container\\": ""
+      "MaplePHP\\Container\\": "src"
     }
   },
   "minimum-stability": "dev"

Interfaces/NotFoundExceptionInterface.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MaplePHP\Container;
+
+use MaplePHP\Container\Interfaces\AutowireInterface;
+
+class Autowire implements AutowireInterface
+{
+    private Reflection $reflect;
+    /**
+     * @var mixed|object|null
+     */
+    private mixed $class = null;
+    private bool $disableDI = false;
+
+    /**
+     * @param string $class
+     * @throws \ReflectionException
+     */
+    public function __construct(string $class)
+    {
+        if (is_string($class) && class_exists($class)) {
+            $this->reflect = new Reflection($class);
+        } else {
+            throw new \InvalidArgumentException("The class {$class} does not exist.");
+        }
+    }
+
+    /**
+     * Disable the dependency injector
+     *
+     * Note: This method MUST be implemented in such a way as to retain the immutability
+     *
+     * @return $this
+     */
+    public function disableDI(): self
+    {
+        $inst = clone $this;
+        $inst->disableDI = true;
+        return $inst;
+    }
+
+    /**
+     * Pass custom arguments to the class constructor
+     *
+     * Note: This method MUST be implemented in such a way as to retain the immutability
+     * NOTE: This will disable the dependency injector
+     *
+     * @param array $args
+     * @return $this
+     */
+    public function addArgs(array $args): self
+    {
+        if (count($args) <= 0) {
+            throw new \InvalidArgumentException("You must provide at least one argument.");
+        }
+        $inst = $this->disableDI();
+        $inst->reflect->setArgs($args);
+        return $inst;
+    }
+
+    /**
+     * Run the class with all dependencies.
+     *
+     * @return mixed
+     * @throws \ReflectionException
+     */
+    public function run(): mixed
+    {
+        if (is_null($this->class)) {
+            $this->class = ($this->disableDI) ? $this->reflect->get() : $this->reflect->dependencyInjector();
+        }
+        return $this->class;
+    }
+}

README.md

@@ -5,7 +5,8 @@
 namespace MaplePHP\Container;
 
 use Closure;
-use MaplePHP\Container\Interfaces\ContainerInterface;
+use MaplePHP\Container\Interfaces\AutowireInterface;
+use Psr\Container\ContainerInterface;
 use MaplePHP\Container\Interfaces\FactoryInterface;
 use MaplePHP\DTO\Format\Arr;
 //use MaplePHP\Container\Reflection;
@@ -34,10 +35,10 @@ public function __call($method, $args)
      *                                  TestClasses\Test::class,
      *                                  TestClasses\Test::class."::__construct",
      *                                  TestClasses\Test::class."::getStaticMethod",
-     * @param array|null   $args        Pass argumnets to constructor staticMethod if you choose.
+     * @param array|null   $args        Pass arguments to constructor staticMethod if you choose.
      * @param bool $overwrite   Will throw exception if already been defined if not arg is set to TRUE.
      */
-    public function set(string $identifier, $value, ?array $args = null, bool $overwrite = false): ContainerInterface
+    public function set(string $identifier, mixed $value, ?array $args = null, bool $overwrite = false): ContainerInterface
     {
         if (!$overwrite && $this->has($identifier)) {
             $type = ($this->isFactory($identifier)) ? "factory" : "container";
@@ -112,27 +113,26 @@ public function isContainer(string $identifier): bool
 
     /**
      * Get a container or factory
-     * @param string $identifier [description]
-     * @param array $args Is possible to overwrite/add __construct or method argumnets
-     * @return mixed
+     * @template T of object
+     * @param class-string<T>|string $identifier The class or service identifier
+     * @param string $identifier
+     * @param array $args Is possible to overwrite/add __construct or method arguments
+     * @return T
      * @throws ReflectionException
      */
     public function get(string $identifier, array $args = []): mixed
     {
-        if ($service = $this->getService($identifier)) {
+        $service = $this->getService($identifier);
+        if (isset($service)) {
             if (count($args) === 0) {
                 $args = $this->getArgs($identifier);
             }
             if ($this->isFactory($identifier)) {
                 $this->getter[$identifier] = $service(...$args);
             } else {
-                if (empty($this->getter[$identifier])) {
-                    if (is_string($service) && class_exists($service)) {
-                        $reflect = new Reflection($service);
-                        if (count($args) > 0) {
-                            $reflect->setArgs($args);
-                        }
-                        $this->getter[$identifier] = $reflect->get();
+                if (!isset($this->getter[$identifier])) {
+                    if ($service instanceof AutowireInterface) {
+                        $this->getter[$identifier] = $service->run();
                     } else {
                         $this->getter[$identifier] = $service;
                     }

composer.json

@@ -51,18 +51,18 @@ public function addHandler(object|string $handler, string|array $method = null):
     public function addEvent(callable|object|string $event, ?string $bind = null): void
     {
 
-        if(!is_callable($event)) {
-            if(is_string($event)) {
+        if (!is_callable($event)) {
+            if (is_string($event)) {
                 $reflect = new Reflection($event);
                 $event = $reflect->get();
             }
 
-            if(is_object($event) && !($event instanceof EventInterface)) {
+            if (is_object($event) && !($event instanceof EventInterface)) {
                 throw new Exception("Event object/class needs to be instance of \"EventInterface\"!", 1);
             }
         }
 
-        if (is_null($bind)) {
+        if ($bind === null) {
             $this->event[] = $event;
         } else {
             $this->event[] = [$bind => $event];
@@ -95,7 +95,7 @@ public function __call(string $method, array $args): mixed
                 throw new BadMethodCallException("The method \"".$method."\" does not exist in the class (" . $handler[0]::class . ")", 1);
             }
             */
-            if (is_null($handler[1][0]) || in_array($method, $handler[1])) {
+            if ($handler[1][0] === null || in_array($method, $handler[1])) {
                 $this->bindable[$method] = $method;
             }
             $data = call_user_func_array([$handler[0], $method], $args);
@@ -136,7 +136,7 @@ final protected function triggerEvents(): void
      */
     final protected function getEvent(callable|object $data): void
     {
-        if(is_callable($data)) {
+        if (is_callable($data)) {
             $data();
         } else {
             $data->resolve();

src/Autowire.php

@@ -3,7 +3,7 @@
 namespace MaplePHP\Container\Exceptions;
 
 use InvalidArgumentException;
-use MaplePHP\Container\Interfaces\ContainerExceptionInterface;
+use Psr\Container\ContainerExceptionInterface;
 
 /**
  * Base interface representing a generic exception in a container.

Container.php src/Container.phpContainer.php renamed to src/Container.php

@@ -2,7 +2,7 @@
 
 namespace MaplePHP\Container\Exceptions;
 
-use MaplePHP\Container\Interfaces\NotFoundExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;
 use RuntimeException;
 
 /**