laravel-modules

Modules management library for laravel 5.1

Allows modules structure of your project. Each module can have its views, config, routes, controllers, ...

Installation

1. The package relies on the composer PSR-4 loader like all laravel projects. Use the composer command:

   composer require itvisionsy/laravel-modules
   

2. Add \ItvisionSy\Laravel\Modules\ServiceProvider::class to providers section in your config/app.php file:

   'providers'=>[
      //...
      \ItvisionSy\Laravel\Modules\ServiceProvider::class,
   ],
   

3. Publish the config file using the command

   php artisan vendor:publish
   

   This will copy the modules.php config file to your config folder.
4. Modify the config/modules.php config file as needed.

How It Works

Your modules should go in a root modules folder. By default this is app/Modules which maps to the namespace \App\Modules.

Each of your modules will have its own folder inside the modules root folder, the folder will be named after the module name, and will map to the namespace \App\Modules\{ModuleName}.

Each module will contain a base module definition class, which (by default) will be named Module.php and maps to the namespace \App\Modules\{ModuleName}\Module. This class will act as the key generator for the module URLs, routes, and other framework-related values.

Each module will contain its data models, controllers, views, routes, and other project files as usual. The composer PSR-4 loader should take care of loading your module files and classes properly.

Your module controllers (by default go into the Http/Controllers folder) should inherite the ItvisionSy\Laravel\Modules\Controller class to make views rendering and other tasks easier.

Creating Modules

To create a new module, you can use the artisan command

php artisan modules:make {id} [{name}] [--url={url}]

Values of id, name, and url are strings. The name and URL parts are optional. URL will be used to generate the URLs of the module more human friendly. Name is used for human identification and readability only.

This command will create the basic folder structure inside the modules folder, along with the base module and a sample routes (inside Http/routes.php), controller (inside Http/Controllers/), and view (inside Views).

As you have the basic structure, you can start creating your files and classes as normal. Nothing special to worry about.

What is Store Handler

It is a feature allows a per-module configuration to be saved in the database, in addition to a flag to identify if a module is enabled or disabled.

You need a class that implements the ItvisionSy\Laravel\Modules\Interfaces\KeyValueStoreInterface interface, which defines two methods: set($key, $value) and get($key, $default=null).

There are two ready-made implementations in the \ItvisionSy\Laravel\Modules\StoreHandlers\ namespace, one is calle MysqlSimpleDbStoreHandler and the other SqliteSimpleDbStoreHandler, which utilizes a DB connection (default one by default) to store the config in a simple key/value table.

The feature comes disabled by default by setting the class \ItvisionSy\Laravel\Modules\StoreHandlers\DummyStoreHandler as the store handler. To enable it, just change the store_handler config setting in the config/modules.php config file to use one of the two classes mentioned above.

//config/modules.php config file

'store_handler' => \ItvisionSy\Laravel\Modules\StoreHandlers\SqliteSimpleDbStoreHandler::class,

Also, you need to create the database table for the store. We provided a simple artisan command to do that. After you have configured everything correctly, simply execute the following command: php artisan modules:db:init which will take care about creating the database table by executing the following SQL command:

CREATE TABLE IF NOT EXISTS `modules_storage` (
  `key` VARCHAR(200) UNIQUE NOT NULL PRIMARY KEY,
  `value` VARCHAR(200) NULL
);

You can create the table manually, and override its name by extending the class and change the $tableName property.

Thanks

• JetBrains for the free license of PHPStorm IDE. The great tool I wrote this module with.