calderawp/caldera-containers

0.2.0 2018-05-05 22:43 UTC

This package is auto-updated.

Last update: 2020-07-09 04:56:19 UTC


README

A collection of useful containers for Caldera (or your) development.

Install

composer require calderawp/caldera-containers

Requires PHP 5.6+

Containers

  • calderawp\CalderaContainers\Container Basic PSR-11 compatible container decorating Pimple.

    • Is abstract.
    • Converts to arrays. calderawp\CalderaContainers\Interfaces\Arrayable
    • Converts to JSON. JsonSerializable
  • calderawp\CalderaContainers\ControlledContainer Extends the base container but only allows in specified attributes.

    • Is abstract
  • calderawp\CalderaContainers\Service\Coantainer A basic service container, with provider bindings, lazy-loaded objects, and singletons.

Usage

calderawp\CalderaContainers\Container

@todo

calderawp\CalderaContainers\ControlledContainer

@todo

calderawp\CalderaContainers\Service\Container

Binding As Factory

Add a binding that returns a new object of the same class using the alias std

$container = new \calderawp\CalderaContainers\Service\Container();
$container->bind( 'std', function (){
     $obj = new \stdClass();
     $obj->foo = rand();
     return $obj;
});

//$obj1->foo !== $obj2->foo
$obj1 = $container->make('std');
$obj2 = $container->make('std');

Binding A Singleton

Add a binding that returns a the same object of the same class using the alias std. You MUST instantiate class before binding.

$container = new \calderawp\CalderaContainers\Service\Container();
$obj = new \stdClass();
$obj->foo = rand();
$container->singleton( 'std', $obj );

//$obj1->foo === $obj2->foo
$obj1 = $container->make('std');
$obj2 = $container->make('std');

Binding A Lazy-Loaded Singleton

Add a binding that returns a the same object of the same class using the alias std. Class is instantiated 1 times, but is not instantiated until used, if ever.

$container = new \calderawp\CalderaContainers\Service\Container();
$container->singleton( 'std', function (){
     $obj = new \stdClass();
     $obj->foo = rand();
     return $obj;
});

//$obj1->foo === $obj2->foo
$obj1 = $container->make('std');
$obj2 = $container->make('std');

## Stuff.
Copyright 2018 CalderaWP LLC. License: GPL v2 or later.