rayan-tools/l5-modular

Modular pattern generator for Laravel 5

L5Modular

 , _(*1)

This package gives you the ability to use Laravel 5 with module system. You can simply drop or generate modules with their own controllers, models, views, translations and a routes file into the app/Modules folder and go on working with them., _(*2)

Thanks to zyhn for the "Modular Structure in Laravel 5" tutorial. Well explained and helped a lot., _(*3)

Documentation

• Installation
• Getting started
• Usage

, _(*4)

Installation

The best way to install this package is through your terminal via Composer., _(*5)

Add the following line to the composer.json file and fire composer update, _(*6)

"RayanTools/l5-modular": "dev-master"

Once this operation is complete, simply add the service provider to your project's config/app.php, _(*7)

Service Provider

RayanTools\L5Modular\ModuleServiceProvider::class,

, _(*8)

Getting started

The built in Artisan command php artisan make:module name [--no-migration] [--no-translation] generates a ready to use module in the app/Modules folder and a migration if necessary., _(*9)

Since version 1.3.0 you can generate modules named with more than one word, like foo-bar., _(*10)

This is how the generated module would look like:, _(*11)

laravel-project/
    app/
    |-- Modules/
        |-- FooBar/
            |-- Controllers/
                |-- FooBarController.php
            |-- Models/
                |-- FooBar.php
            |-- Views/
                |-- index.blade.php
            |-- Translations/
                |-- en/
                    |-- example.php
            |-- routes.php
            |-- helper.php

, _(*12)

Usage

The generated RESTful Resource Controller and the corresponding routes.php make it easy to dive in. In my example you would see the output from the Modules/FooBar/Views/index.blade.php when you open laravel-project:8000/foo-bar in your browser., _(*13)

Disable modules

In case you want to disable one ore more modules, you can add a modules.php into your projects app/config folder. This file should return an array with the module names that should be loaded. F.a:, _(*14)

return [
    'enable' => array(
        "customer",
        "contract",
        "reporting",
    ),
];

In this case L5Modular would only load this three modules customer contract reporting. Every other module in the app/Modules folder would not be loaded., _(*15)

L5Modular will load all modules if there is no modules.php file in the config folder., _(*16)

Change template

In case you want to change template, you can edit a view.php into your projects app/config folder and add key template with value template name., _(*17)

return [
    'template' => 'default'
];

default template generated would look like:, _(*18)

laravel-project/
    resources/
        themes/
        |-- default/
            |-- Module1/
                |-- index.blade.php
            |-- Module2/
                |-- index.blade.php
            |-- Module3/
                |-- index.blade.php                

Update to 1.3.0

Since version 1.3.0 you have to follow the upper camel case name convention for the module folder. If you had a Modules/foo folder you have to rename it to Modules/Foo., _(*19)

Also there are changes in the app/config/modules.php file. Now you have to return an array with the key enable instead of list., _(*20)

License

L5Modular is licensed under the terms of the MIT License (See LICENSE file for details)., _(*21)