library zit {🖫 233, ⚐ 11, ★ 4}

selvinortiz/zit

Tiny dependency management library for PHP

Tuesday, June 21, 2016
by selvinortiz
Repository
1 Watchers
4 Stars
233 Installations

PHP
1 Dependents
0 Suggesters
1 Forks
0 Open issues
11 Versions
14 % Grown

The README.md

Zit , _(*1)

, _(*2)

Description

Zit is a tiny dependency injection library inspired by Pimple and written by Selvin Ortiz, _(*3)

Requirements

PHP 5.4+
Composer and selvinortiz/zit

Install

composer require selvinortiz/zit

Test

sh spec.sh

Usage

Dependency management is a difficult topic to explain but essentially, Zit lets you stuff things into it that you can pop out later throughout your application., _(*4)

// Make an instance
$app = Zit::make();

// Stash a config object
$app->stash('config', new Config(['usr' => 'root', 'pwd' => 'secret']));

// Bind a session generator
$app->bind('session', function() {
    return new Session();
});

// Bind a database generator
$app->bind('db', function($app) {
    return new Db($app->config->usr, $app->config->pwd);
});

// Extend your $app with new functionality
$app->extend('end', function($app) {
    $app->db->close();
    $app->session->destroy();
});

// Finish
$app->end();

You can also use Zit without making a new instance, the static way if you will., _(*5)

// Stash a config object
Zit::stash('config', new Config(['usr' => 'root', 'pwd' => 'secret']));

// Bind a session generator
Zit::bind('session', function() {
    return new Session();
});

// Bind a database generator
Zit::bind('db', function($zit) {
    return new Db($zit->config->usr, $zit->config->pwd);
});

// Extend Zit with new functionality
Zit::extend('end', function($zit) {
    $zit->db->close();
    $zit->session->destroy();
});

// Finish
Zit::end();

Which approach should you use? Whatever you prefer. If you aren't sure, you can use the static way unless you need to create your own instance that extends Zit, _(*6)

Note

Whether you bind(), stash(), or extend() it. You can pop it out using:, _(*7)

Zit::pop('db');  // Formal
Zit::db();       // Via __callStatic()
Zit::db          // Via __callStatic() property sniffing

// If you had done $app = Zit::make()
$app->pop('db'); // Formal
$app->db();      // Via __call()
$app->db;        // Via __get()

API

`pop($id, $args = array())`

pop() lets you pop a dependency out of the container, _(*8)

Zit::pop('db');
// See the note above on popping stuff out

`bind($id, callable $serviceGenerator)`

bind() lets you register a service generator. Useful when you need to instantiate a service that depends on a config object for example. Services get generated only once on first call., _(*9)

Zit::make()->bind('db', function($zit) {
   return new Db($zit->config->usr, $zit->config->pwd); 
});

`stash($id, $service)`

stash() lets you stash anything inside the container. You get out what you put in, which is useful if you need to stash a bunch of stuff that needs to be accessible throughout your whole application., _(*10)

Zit::make()->stash('session', new Session())

`extend($id, $callback)`

extend() gives you the ability to add new functionality to the container, _(*11)

Zit::make()->extend('logout', function($zit) {
    $zit->session->logout();
});

Contribute

Zit wants to be friendly to first time contributors. Just follow the steps below and if you have questions along the way, please reach out., _(*12)