ryanl/flexer

Flexer is a powerful PHP library that offers a versatile implementation of the PSR-11 Container interface. Designed to provide a seamless and standardized way to manage dependencies and services in your PHP applications, Flexer empowers developers with a flexible and intuitive container solution.

v0.0.1 2024-06-26 20:46 UTC

Requires

• php: ^8.2
• psr/container: ^2.0

Requires (Dev)

• pestphp/pest: ^2.23
• phpstan/phpstan: ^1.10
• spatie/ray: ^1.41
• squizlabs/php_codesniffer: ^3.7
• vimeo/psalm: ^5.15

Provides

• psr/container-implementation: ^1.0

MIT

• Ryan Lima

README

Description:

A simple, but robust implementation of PSR11, that support multiple types of definitions for your dependencies

Getting Started

Similar to what is done with PHP-DI

Installation

Install Flexer with Composer:

composer require ryanl/flexer

Usage

Instantiate an instance of the container:

$container = new \Flexer\Container();

With autowiring, Flexer can handle most cases of object instantiation. Here is a list of cases Flexer can cover with zero configuration.

Classes with:

• No constructor
• Empty constructor
• Constructor with optional parameters
• Constructor parameters that are objects of classes fitting the previous cases.

Defining How to Instantiate Complex Objects

There are two possible syntaxes for adding definitions to Flexer:

Directly in the constructor:

$container = new \Flexer\Container([
   $id => $definition 
]);

Using the add method:

$container = new \Flexer\Container();
$container->add($id, $definition)

Id

The id can be, as defined in PSR-11, the "Identifier of the entry to look for", so it can be an arbitrary identifier. However, the most common practice is to use the fully qualified class name (including its namespace).

$container = new \Flexer\Container();
$container->add(\Test\Sample\NormalClass::class, $definition)

Definition

The definition is the instruction given to the container to instantiate your class. Currently, Flexer accepts the following types of $definition:

• Closure

$definition = fn() => new \Test\Sample\NormalClass();
$container->add($id, $definition);

• Function Name

function getNormalClassInstance(): \Test\Sample\NormalClass
{
    return new \Test\Sample\NormalClass();
}
$container->add($id, 'getNormalClassInstance');

• Class Closure Object

$container->add($id, \Test\Sample\NormalClass::create(...));

• Object Instance

$container->add($id, new \Test\Sample\NormalClass());

Despite the numerous possibilities for defining your dependencies, we recommend using deferred alternatives, where the dependency is only instantiated when it becomes necessary, avoiding unnecessary memory allocation.

Tip

A more elegant way to manage your definitions is to separate them into a file that provides an array of definitions:

# dependencies.php

<?php

declare(strict_types=1);

return [
    \Test\Sample\NormalClass::class => fn () => new \Test\Sample\NormalClass(),
    \PDO::class => function (): \PDO {
        return new PDO('sqlite::memory');
    }
];

# index.php

<?php

declare(strict_types=1);

$container = new \Flexer\Container(require_once 'dependencies.php');

Tests

To execute the test suite, clone the repository and then run the test script on composer.json

git clone https://github.com/ryanlimadotdev/flexer.git
composer install
composer test

Contributing

Anyone who wishes and is available to collaborate with the project should feel free to create a fork of the project and make a pull request suggestion with the modifications they deem pertinent. Just pay attention to carrying out the appropriate tests and following the code style policy present in the project in:

composer analyse