DeGraciaMathieu/Manager

Implementation of the Manager pattern existing in Laravel framework.

• Installation
• Usage
• Work with singleton
• Example with Laravel

Installation

Manager	3.*	2.*	1.*
php ^8.1	✅	❌	❌
php 8.0.*	❌	✅	❌
php 7.*	❌	❌	✅

composer require degraciamathieu/manager

Usage

This package offers an abstract class Manager which needs to be extended to implement the creation of various Driver classes.

<?php

use DeGraciaMathieu/Manager/Manager;

class LoggerManager extends Manager {

    public function createMonologDriver(): LoggerDriver
    {
        return new MonologDriver();
    }

    public function createMockDriver(): LoggerDriver
    {
        return new MockDriver();
    }

    public function getDefaultDriver(): string
    {
        return 'monolog';
    }
}

The getDefaultDriver method should also be implemented in your class Manager, in order to determine which driver has to be created by default. It's also the right spot to determine the default driver from an environment variable, or a configuration.

<?php

public function getDefaultDriver(): string
{
    return env('MANAGER_LOGGER_DEFAULT_DRIVER');
}

In a matter of consistency, all Driver creations (createClientDriver, createMockDriver...) should return a class which itself implements the same interface, the LoggerDriver contract in this here case.

<?php

interface LoggerDriver {
    public function doAnything(): string;
}

class MonologDriver implements LoggerDriver {

    public function doAnything(): string
    {
        echo 'i do anything from the monolog driver';
    }
}

class MockDriver implements LoggerDriver {

    public function doAnything(): string
    {
        echo 'i do anything from the mock driver';
    }
}

From now on, it's possible to use your Manager, either by using the default driver:

<?php

(new LoggerManager())->doAnything(); // i do anything from the default driver

Or by simply specify the driver which needs to be instantiated.

<?php

(new LoggerManager())->driver('monolog')->doAnything(); // i do anything from the monolog driver
(new LoggerManager())->driver('mock')->doAnything(); // i do anything from the mock driver

Work with singleton

You can also cache the creation of Drivers with the $singleton property.

With the singleton property you will only create one instance of MonologDriver

<?php

$loggerManager = new LoggerManager(singleton: true);

$loggerManager->driver('monolog')->doAnything();
$loggerManager->driver('monolog')->doAnything();
$loggerManager->driver('monolog')->doAnything();

by default, singleton property value is False

Example with Laravel

Usage example of the pattern manager in a Laravel project.