bsharp/larinterface

Easy Interface generation for your Laravel project

Larinterface

, _(*1)

Larinterface help you to be more productive by generating automaticaly all the interface in your Laravel project by using PHP and black magic., _(*2)

Composer

To install Larinterface using composer, run this command:, _(*3)

    composer require bsharp/larinterface

Setup

After running composer update, open your Laravel config file located at config/app.php and add the following in the $providers array., _(*4)

    Bsharp\Larinterface\LarinterfaceServiceProvider::class

Publish

To add larinterface config file to your app, use the vendor:publish artisan command, _(*5)

  php artisan vendor:publish

Configuration

Open the generated config/larinterface.php file and change the configuration to fits your needs., _(*6)

Execution

Now Larinterface should work using the command:, _(*7)

  php artisan larinterface:generate

File watcher

Executing php artisan larinterface:generate each time after modifying one of your PHP Class is annoying so here is some ways to automate this behavior., _(*8)

Using Laravel Elixir

You can create a gulp watcher, using elixir 3, to do that for you. Add this lines to your gulpfile:, _(*9)

If you generate the interfaces in the same directory than your classes:

    var gulp = require('gulp');
    var exec = require('gulp-exec');
    var Task = elixir.Task;

    var files = require('./storage/app/larinterface.json');
    var locked = false;

    elixir.extend('larinterface', function() {

      new Task('larinterface_generate', function () {

        if(locked === true) {
          return;
        }

        locked = true;

        var task = gulp.src('').pipe(exec('php artisan larinterface:generate'));
        task.on('end', function () {
          setTimeout(function () {
            locked = false;
            files = require('./storage/app/larinterface.json');
          }, 1000);
        });

        return task.pipe(exec.reporter({}));
      })
      .watch(files);
    });

If you generate the interface in a separate directory:

    var gulp = require('gulp');
    var exec = require('gulp-exec');
    var Task = elixir.Task;

    var files = require('./storage/app/larinterface.json');

    elixir.extend('larinterface', function() {

      new Task('larinterface_generate', function () {

        files = require('./storage/app/larinterface.json');

        return gulp.src('').pipe(exec('php artisan larinterface:generate')).pipe(exec.reporter({}));
      })
      .watch(files);
    });

You can now use mix.larinterface(); to execute Larinterface in Elixir !, _(*10)

Using PHPStorm or other JetBrain IDE:

First go to your settings and open Files Watchers , _(*11)

Then create a new Larinterface watcher and configure it as follow: , _(*12)

Contributing

Feel free to contribute to Larinterface by sending a pull request ! You can always ask anything (related to Larinterface of course) using a GitHub issue., _(*13)

License

Larinterface is open-sourced software licensed under the MIT license, _(*14)