diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5471dc1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,203 @@ + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5239e1 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# lib-di-container + +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![PHP Version](https://img.shields.io/badge/php-%3E%3D8.1-blueviolet)](https://php.net) + +A simple implementation of PSR-11: Container. + +## Description + +`lib-di-container` is a lightweight PHP library that provides a simple implementation of the PSR-11 Container interface. It allows you to manage and retrieve objects and dependencies in your applications. + +## Features + +- Implements the PSR-11 Container interface. +- Supports object instantiation and retrieval. +- Provides dependency injection and method invocation. + +## Installation + +You can install `lib-di-container` via [Composer](https://getcomposer.org/): + +```bash +composer require uid/lib-di-container +``` + + +## Usage + +### Creating a Container + +To create a new container, instantiate the `Container` class: + +```php +use Uid\Utils\Container\Container; + +$container = new Container(); +``` + +### Defining Services + +You can define services in the container using the `set` method. Services can be defined as anonymous functions or class names: + +```php +// Define a service as an anonymous function +$container->set('myService', function ($container) { + return new MyService(); +}); + +// Define a service as a class name +$container->set('myService', 'MyService'); +``` + +### Retrieving Services + +To retrieve a service from the container, use the `get` method: + +```php +$myService = $container->get('myService'); +``` + +### Invoking Methods + +The container allows you to invoke methods on objects using the `invoke` method. You can specify the object and method to invoke, along with any required parameters: + +```php +$result = $container->invoke($myService, 'someMethod', ['param1' => $value1]); +``` + +## API Reference + +### Container + +The `Container` class implements the `Psr\Container\ContainerInterface` interface. + +#### Methods + +- `__construct(array $definitions = [])`: Creates a new container with optional initial service definitions. +- `set(string $name, string|callable $value, array $constants = [], bool $singleton = false): self`: Defines a service in the container. +- `get(string $id): mixed`: Retrieves a service from the container. +- `invoke(string|object $entry, string $method = '__invoke', array $constants = []): mixed`: Invokes a method on an object. + +## Requirements + +- PHP >= 8.1 +- PSR-Container >= 1.0 + +## Contributing + +Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request. + +## License + +This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for more information. diff --git a/src/Container/Container.php b/src/Container/Container.php index a693a11..624bf77 100644 --- a/src/Container/Container.php +++ b/src/Container/Container.php @@ -25,7 +25,11 @@ class Container implements ContainerInterface { private array $definitions; - + /** + * Container constructor. + * + * @param array $definitions Predefined definitions for the container (default: []). + */ public function __construct(array $definitions = []) { $this->definitions = $definitions; @@ -33,30 +37,64 @@ $this->definitions[PsrContainerInterface::class] = ['alias' => Container::class]; $this->definitions[self::class] = ['value' => $this]; } - + /** + * Define a value to be stored in the container. + * + * @param string $name The name of the value. + * @param mixed $value The value to store. + * @return Container The container instance. + */ public function value(string $name, $value): self { $this->definitions[$name] = ['value' => $value]; return $this; } - + /** + * Define an alias for a name in the container. + * + * @param string $name The name of the alias. + * @param string $alias The name of the entry to alias. + * @return Container The container instance. + */ public function alias(string $name, string $alias): self { $this->definitions[$name] = ['alias' => $alias]; return $this; } - + /** + * Defines a class and store it in a container. + * + * @param string $class The name of the class. + * @param array $constants Parameters as an associative array to pass to the constructor (default: []). + * @param bool $singleton Whether the instance should be treated as a singleton (default: false). + * @return Container The container instance. + */ public function create(string $class, array $constants = [], bool $singleton = false): self { return $this->set($class, $class, $constants, $singleton); } - + /** + * Define a factory callback to create instances in the container. + * + * @param string $name The name of the entry. + * @param callable $callback The factory callback. + * @param array $constants Parameters as an associative array to pass to the callback (default: []). + * @param bool $singleton Whether the instance should be treated as a singleton (default: false). + * @return Container The container instance. + */ public function factory(string $name, callable $callback, array $constants = [], bool $singleton = false): self { - $this->definitions[$name] = ['callback' => $this->callback($callback, $constants), 'singleton' => $singleton]; - return $this; + return $this->set($name, $callback, $constants, $singleton);; } - + /** + * Define an entry in the container. + * + * @param string $name The name of the entry. + * @param string|callable $value The value or factory callback for the entry. + * @param array $constants Parameters as an associative array to pass to the constructor or callback (default: []). + * @param bool $singleton Whether the instance should be treated as a singleton (default: false). + * @return Container The container instance. + */ public function set(string $name, string|callable $value, array $constants = [], bool $singleton = false): self { $this->definitions[$name] = [ @@ -67,14 +105,11 @@ ]; return $this; } - - /** @inheritdoc*/ public function has(string $id): bool { return $this->definition($this->resolve($id)) !== null; } - /** @inheritdoc*/ public function get(string $id): mixed { @@ -92,7 +127,7 @@ } return $result; } - + /** @inheritdoc*/ public function invoke(string|object $entry, string $method = '__invoke', array $constants = []): mixed { $object = is_string($entry) ? $this->get($entry) : $entry; @@ -110,7 +145,12 @@ $arguments = array_map(fn($parameter) => $this->argument($parameter, $constants), $reflection->getParameters()); return $object->$method(... array_map(fn($arg) => $arg[0] ? $this->get($arg[1]): $arg[1], $arguments)); } - + /** + * Get the definition for the given entry name. + * + * @param string $name The name of the entry. + * @return array|null The definition array if found, null otherwise. + */ private function definition(string $name): ?array { if (array_key_exists($name, $this->definitions)) { @@ -121,7 +161,12 @@ } return null; } - + /** + * Resolve an entry name by following any aliases. + * + * @param string $id The name of the entry. + * @return string The resolved name. + */ private function resolve(string $id): string { while (array_key_exists($id, $this->definitions)) { @@ -133,7 +178,14 @@ } return $id; } - + /** + * Create a constructor callback for the given class. + * + * @param string $class The name of the class. + * @param array $constants Parameters as an associative array to pass to the constructor (default: []). + * @return callable The constructor callback. + * @throws ContainerException If the class cannot be instantiated. + */ private function constructor(string $class, array $constants = []): callable { try { @@ -147,7 +199,13 @@ } return fn(Container $container) => new $class(... array_map(fn($arg) => $arg[0] ? $container->get($arg[1]) : $arg[1], $arguments)); } - + /** + * Create a callback for the given callable. + * + * @param callable $callback The callable. + * @param array $constants Parameters as an associative array to pass to the callable (default: []). + * @return callable The created callback. + */ private function callback(callable $callback, array $constants = []): callable { try { @@ -165,7 +223,14 @@ $arguments = array_map(fn($parameter) => $this->argument($parameter, $constants), $parameters); return fn(Container $container) => $callback(... array_map(fn($arg) => $arg[0] ? $container->get($arg[1]): $arg[1], $arguments)); } - + /** + * Resolve the argument for a parameter. + * + * @param ReflectionParameter $parameter The parameter reflection. + * @param array $constants Parameters as an associative array to pass to the callable or constructor. + * @return array The resolved argument, consisting of a flag indicating if the argument is a dependency and the value. + * @throws ContainerException If the argument cannot be resolved. + */ private function argument(ReflectionParameter $parameter, array $constants): ?array { $name = $parameter->getName(); diff --git a/src/Container/ContainerException.php b/src/Container/ContainerException.php index 8bf69d9..9de7455 100644 --- a/src/Container/ContainerException.php +++ b/src/Container/ContainerException.php @@ -5,6 +5,9 @@ use Psr\Container\ContainerExceptionInterface; use Exception; +/** + * Base interface representing a generic exception in a container. + */ class ContainerException extends Exception implements ContainerExceptionInterface { } diff --git a/src/Container/NotFoundException.php b/src/Container/NotFoundException.php index 20482ba..16df86f 100644 --- a/src/Container/NotFoundException.php +++ b/src/Container/NotFoundException.php @@ -4,6 +4,9 @@ use Psr\Container\NotFoundExceptionInterface; +/** + * No entry was found in the container. + */ class NotFoundException extends ContainerException implements NotFoundExceptionInterface { }