palmtree/container

Service Container component for Palmtree PHP

:palm_tree: Palmtree Container

, _(*1)

A PSR-11 compatible service container, _(*2)

Supports environment variable parameters, factories and private services., _(*3)

Requirements

• PHP >= 7.1

For PHP >= 5.6 support use v1.0, _(*4)

Installation

Use composer to add the package to your dependencies:, _(*5)

composer require palmtree/container

Usage

Define parameters and services:, _(*6)

# config.yml
parameters:
  database_name: 'mydb'
  database_user: 'mydb_user'
  database_password: '%env(DB_PASSWORD)%'
  env(DB_PASSWORD): 123456 # Default env parameter used if environment variable is not set

imports:
  - { resource: services.yml }
  - { resource: secrets.yml }

# services.yml
services:
  my_service:
    class: MyNamespace\MyService
    arguments: [arg1, '%database_name%']

  my_other_service:
    class: MyNamespace\MyOtherService
    arguments: ['@my_service']
    calls:
      -
        method: doThing
        arguments: [arg1, arg2]

# secrets.yml
parameters:
    secret: 'TopsyCrett'

Create container:, _(*7)

<?php
use Palmtree\Container\ContainerFactory;

$container = ContainerFactory::create('config.yml');

$container->get('my_service')->myMethod();

$container->getParameter('db_username');

Advanced Usage

Factories

Services can be created by calling static factory methods. Arguments are passed to the factory method., _(*8)

# services.yml
services:
  my_service:
    factory: 'MyNamespace\MyFactory:createService'
    arguments: [argForCreateService]

Private Services

Services can be defined as private, meaning they can only be used via dependency injection and cannot be retrieved from the container directly:, _(*9)

# services.yml
services:
  my_service:
    class: MyNamespace\MyService
    public: false

  my_consumer:
    class: MyNamespace\MyConsumer
    arguments:
        - "@my_service"

The following will throw a ServiceNotPublicException:, _(*10)

<?php
$container->get('my_service');

Whilst the following will work:, _(*11)

<?php
namespace MyNamespace;

class MyConsumer {
    public function __construct(MyService $myService) {
    }
}

Prior Art

Inspired by Symfony's DependencyInjection component., _(*12)

License

Released under the MIT license, _(*13)