jminayat/modules-laravel

modular laravel applications

Tuesday, April 17, 2018
by jminayat
Repository
2 Watchers
1 Stars
67 Installations

PHP
0 Dependents
0 Suggesters
0 Forks
0 Open issues
22 Versions
16 % Grown

The README.md

JMinayaT Laravel - Modules

jminayat/modules-laravel is a package for the administration of your laravel application in modules. compatible with Laravel version 5.5 . * Installation * Usage * Artisan Commands * Facade methods * Module Methods, _(*1)

Installation

Install the package through the composer., _(*2)

``` bash composer require jminayat/modules-laravel, _(*3)


You need to load the module folder since it does not load automatically. You can autoload your modules using `psr-4`.

Edit main composer file, and add:
``` json
{
  "autoload": {
    "psr-4": {
      "App\\": "app/",
      "Modules\\": "modules/"
    }
  }
}

Do not forget to execute composer dump-autoload ., _(*4)

You can publish the Migrations. ``` bash php artisan vendor:publish --provider="JMinayaT\Modules\ModulesServiceProvider" --tag="migrations", _(*5)


After the migration has been published, you can create the table of modules by executing the migrations:
```bash
php artisan migrate

You can publish the Config file (it's optional). ``` bash php artisan vendor:publish --provider="JMinayaT\Modules\ModulesServiceProvider" --tag="config", _(*6)

When published, the `config/modules.php ` Config file contains:
```php
<?php

return [

  /*
   * Name of the table to use
   * default value but you may easily change it to any table you like.
   */

   'table_name'  =>  'modules',

];

Usage

Creating A Module, _(*7)

To create a new module, simply run the following command: ``` bash php artisan module:create , _(*8)

- `<module-name>` - Replace with the name of the desired module.
- `module description` - Write the description of the module created.

To automatically add controller, model and migration when creating a new module use: `-c -d -m`
``` bash
php artisan module:create <module-name> -c -d -m

-c or --controller - Create controller.
-d or --model - Create model.
-m or --migration - Create migration.

Folder Structure, _(*9)

modules/
  ├── Blog/
      ├── Controllers/
      ├── Database/
          ├── migrations/
      ├── Models/
      ├── Resources/
          ├── Assets/
          ├── lang/
          ├── views/
      ├── Route/
          ├── web.php
          ├── api.php
      ├── module.json

Artisan Commands

****Note that the command names use "test" as the name of the example module****, _(*10)

module:active, _(*11)

activate | disable module, use true or false., _(*12)

php artisan module:active test true

module:create, _(*13)

create a new module., _(*14)

php artisan module:create test

options, _(*15)

-c or --controller - Create controller.
-d or --model - Create model.
-m or --migration - Create migration.

module:delete, _(*16)

delete module., _(*17)

php artisan module:delete test

module:install, _(*18)

Install module from zip file., _(*19)

php artisan module:install var/this-path/test.zip

module:list, _(*20)

show list of all modules., _(*21)

php artisan module:list

module:make-controller, _(*22)

Create a new module controller., _(*23)

php artisan module:make-controller test TestController

module:make-middleware, _(*24)

Create a new module middleware class., _(*25)

php artisan module:make-middleware test TestMiddleware

module:make-request, _(*26)

Create a new module request class., _(*27)

php artisan module:make-request test TestRequest

module:make-model, _(*28)

Create a new module model., _(*29)

php artisan module:make-model test TestModel

options - -m or --migration - Create migration., _(*30)

module:make-migration, _(*31)

Create a new module migration., _(*32)

php artisan module:make-migration test create_tests_table

module:make-seeder, _(*33)

Create a new module seeder class., _(*34)

php artisan module:make-seeder test testSeeder

module:make-factory, _(*35)

Create a new module factory class., _(*36)

php artisan module:make-factory test testFactory

module:make-test, _(*37)

Create a new module test class., _(*38)

php artisan module:make-test test userTest

module:make-policy, _(*39)

Create a new module policy class., _(*40)

php artisan module:make-policy test testPolicy

module:publish, _(*41)

Publish module zip file., _(*42)

php artisan module:publish test

module:up, _(*43)

Up config file module json., _(*44)

php artisan module:up test

module:migrate, _(*45)

Migrate database for all modules., _(*46)

php artisan module:migrate

For migrate a specific module to use:, _(*47)

php artisan module:migrate test

module:rollback, _(*48)

Rollback the last module database migration., _(*49)

php artisan module:rollback

For rollback a specific module to use:, _(*50)

php artisan module:rollback test

module:seed, _(*51)

Module Seed the database with records., _(*52)

php artisan module:sedd

For seed a specific module to use:, _(*53)

php artisan module:seed test

Facade Methods

Get all modules., _(*54)

Module::all();

Get a specific module., _(*55)

Module::get('test');

Get all active modules., _(*56)

Module::getEnabled();

Get all disabled modules., _(*57)

Module::getDisabled();

Check the specified module. If it exists, will return true, otherwise false., _(*58)

Module::has('test');

Count all modules., _(*59)

Module::count();

Install a module using the zip file., _(*60)

Module::install('path/file.zip');

Migrate database the specified module., _(*61)

Module::moduleMigrate('test');

Rollback database the specified module., _(*62)

Module::moduleRollback('test');

Migrate the database to all modules, _(*63)

Module::moduleMigrateAll();

Rollback database to all modules., _(*64)

Module::moduleRollbackAll();

Module Methods

get entity from a specific module., _(*65)

$module = Module::get('test');

Get module name in studlycase., _(*66)

$module->studlyName();

Get the status of the module if it is active or disabled., _(*67)

$module->status();

Enable the specified module., _(*68)

$module->active();

Enable the specified module., _(*69)

$module->disable();

Delete the specified module., _(*70)

$module->delete();

Get module Path., _(*71)

$module->getPath();

Get module Json file., _(*72)

$module->getModuleJson();

License

The MIT License (MIT). Please see License File for more information., _(*73)

The Versions

17/04 2018

dev-master

9999999-dev

modular laravel applications

project modules-laravel

modular laravel applications

jminayat/modules-laravel

The README.md

JMinayaT Laravel - Modules

Installation

Usage

Artisan Commands

Facade Methods

Module Methods

License

The Versions

dev-master

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.9

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.8

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.7

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.6

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.5

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.4

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.3

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.2

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.1

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.0.x-dev

The Requires

The Development Requires

by Javier Minaya Trinidad

v2.0.0

The Requires

The Development Requires

by Javier Minaya Trinidad

v1.0.9

The Requires

by Javier Minaya Trinidad

v1.0.8

The Requires

by Javier Minaya Trinidad

v1.0.7

The Requires

by Javier Minaya Trinidad

v1.0.6

The Requires

by Javier Minaya Trinidad

v1.0.5

The Requires

by Javier Minaya Trinidad

v1.0.4

The Requires

by Javier Minaya Trinidad

v1.0.3

The Requires