modulatr/loader

Modulatr

Modulatr Loader

, _(*1)

Package for creating and loading modules in PHP projects., _(*2)

Installation via Composer

composer require modulatr/loader, _(*3)

Usage

Modulatr is framework agnostic, although there are plans for implementing service providers for popular frameworks as and when requested., _(*4)

To start with, create a new Module., _(*5)

<?php

namespace App\Modules;

use Modulatr\Loader\Module;

class Example extends Module
{
    public function getId(): string
    {
        return 'example';
    }

    public function getServiceProviders(): array 
    {
        return [];
    }
}

Next, load the module into the ModuleLoader class, with the URI parts as the first parameter and a config array as the second:, _(*6)

<?php

use Modulatr\Loader\ModuleLoader;
use App\Modules\Example;

$loader = new ModuleLoader(['example', 'index'], [
    'modules' => [
        Example::class,    
    ],
]);

In the above example, the URI passed to the module would be /example/index, _(*7)

If you are using a framework such as Laravel, you might want to create the array from the route name (which may be example.index) in order to not tie your modules to the URI directly., _(*8)

Now, if you call getCurrentModule() on the loader, you will be returned your module class, as it's ID is example and the URI array contains the string example., _(*9)