utopia-php/registry

A simple dependency management library for PHP

0.6.0 2022-07-17 15:26 UTC

This package is auto-updated.

Last update: 2023-01-09 15:35:59 UTC


README

Build Status Total Downloads Discord

Utopia Registry library is simple and lite library for managing dependency management and lazy load initialization of PHP objects or resources. This library is aiming to be as simple and easy to learn and use.

Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.

Getting Started

Install using composer:

composer require utopia-php/registry

script.php

<?php

require_once '../vendor/autoload.php';

use Utopia\Registry\Registry;

global $dbHost, $dbUser, $dbPass, $dbScheme;

$register = new Registry();

$register->set('db', function() use ($dbHost, $dbUser, $dbPass, $dbScheme) { // Register DB connection
    $pdo = new PDO("mysql:host={$dbHost};dbname={$dbScheme}", $dbUser, $dbPass, array(
        PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8',
        PDO::ATTR_TIMEOUT => 5 // Seconds
    ));

    // Connection settings
    $pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_ASSOC);   // Return arrays
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);        // Handle all errors with exceptions

    return $pdo;
});

/**
 * Execute callback and create database connection only when
 *  you need it and not a second before
 */
$register->get('db');

/**
 * Second call for db service will return the instance that has been created
 *  in the previous line of code
 */
$register->get('db');

/**
 * Third call for db service when passing the value 'true' to the $fresh argument
 *  will return a fresh and new instance of the db service
 */
$register->get('db', true);

/**
 * Using the context method you can manage multiple instances of the same resources with separated scopes.
 */
$register->context('new-set-of-instances');

/**
 * You can use the 3rd parameter `$fresh` to get a new copy of the resource in every get call
 */
$register->set('time', function() { // Register DB connection
    return microtime();
}, true);

$register->get('time'); // 0.16608900
$register->get('time'); // 0.16608905

System Requirements

Utopia Framework requires PHP 7.4 or later. We recommend using the latest PHP version whenever possible.

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php