https://github.com/elusivecodes/fyrecontainer
FyreContainer is a free, open-source container library for PHP.
https://github.com/elusivecodes/fyrecontainer
container php
Last synced: about 2 months ago
JSON representation
FyreContainer is a free, open-source container library for PHP.
- Host: GitHub
- URL: https://github.com/elusivecodes/fyrecontainer
- Owner: elusivecodes
- License: mit
- Created: 2024-11-01T13:27:14.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-02T11:38:34.000Z (2 months ago)
- Last Synced: 2025-04-02T12:32:42.273Z (2 months ago)
- Topics: container, php
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FyreContainer
**FyreContainer** is a free, open-source container library for *PHP*.
## Table Of Contents
- [Installation](#installation)
- [Basic Usage](#basic-usage)
- [Methods](#methods)
- [Static Methods](#static-methods)
## Installation
**Using Composer**
```
composer require fyre/container
```
In PHP:
```php
use Fyre\Container\Container;
```
## Basic Usage
- `$bind` is a boolean indicating whether to bind the container instance to itself, and will default to *true*.
```php
$container = new Container($bind);
```
## Methods
**Bind**
Bind an alias to a factory *Closure* or class name.
- `$alias` is a string representing the alias.
- `$factory` is a string representing the class name, or a *Closure* that returns an instance of the class, and will default to the `$alias`.
```php
$container->bind($alias, $factory);
```
**Bind Attribute**
Bind a contextual attribute to a handler.
- `$attribute` is a string representing the attribute.
- `$handler` is a *Closure* that will resolve a value from the attribute.
```php
$container->bindAttribute($attribute, $handler);
```
**Build**
Build a class name, injecting dependencies as required.
- `$className` is a string representing the class name.
- `$arguments` is an array containing the named arguments for the class constructor.
```php
$instance = $container->build($className, $arguments);
```
**Call**
Execute a callable using resolved dependencies.
- `$callable` is an array, string or object representing the callable.
- `$arguments` is an array containing the named arguments for the callabck.
```php
$result = $container->call($callable, $arguments);
```
**Clear Scoped**
Clear the scoped instances, including any dependents.
```php
$container->clearScoped();
```
**Instance**
Bind an alias to a class instance.
- `$alias` is a string representing the alias.
- `$instance` is an object representing the class instance.
```php
$instance = $container->instance($alias, $instance);
```
**Scoped**
Bind an alias to a factory *Closure* or class name as a reusable scoped instance.
- `$alias` is a string representing the alias.
- `$factory` is a string representing the class name, or a *Closure* that returns an instance of the class, and will default to the `$alias`.
```php
$container->scoped($alias, $factory);
```
**Singleton**
Bind an alias to a factory *Closure* or class name as a reusable instance.
- `$alias` is a string representing the alias.
- `$factory` is a string representing the class name, or a *Closure* that returns an instance of the class, and will default to the `$alias`.
```php
$container->singleton($alias, $factory);
```
**Unscoped**
Remove an alias from the scoped instances.
- `$alias` is a string representing the alias.
```php
$container->unscoped($alias);
```
**Unset**
Remove an instance and optionally any dependents.
- `$alias` is a string representing the alias.
- `$unsetDepentents` is a boolean indicating whether to unset dependents, and will default to *false*.
```php
$container->unset($alias, $unsetDependents);
```
**Use**
Use an instance of a class.
- `$alias` is a string representing the alias.
- `$arguments` is an array containing the named arguments for the class constructor.
```php
$instance = $container->use($alias, $arguments);
```
## Static Methods
**Get Instance**
Get the global instance.
```php
$container = Container::getInstance();
```
**Set Instance**
Set the global instance.
- `$container` is a *Container*.
```php
Container::setInstance($container);
```