jag/common

Common resources like classes, helpers, traits and more

Jag\Common

, _(*1)

Nah, some boilerplate here. All included packages service provider are already registered., _(*2)

Option service are not included out-of-the-box, instead add its service provider. See below for instruction., _(*3)

Laravel Packager are not included out-of-the-box (updated since 1.0.2). See below for instruction, _(*4)

Table of Contents

• Included Packages
• Install
• Post Install
  • IDE Helper
  • Option Service Provider
  • Clockwork Middleware
  • How to use Laravel Packager
• Optional Facade
• Extend Exception Handler
• JSON Controller Response Trait
• Change Log
• Security
• Credits
• License

Included Packages

• Socialite - Fluent interface to OAuth authentication
• Image - PHP Image Manipulation
• Image(Cache) - Caching extension for the Intervention Image Class
• Html/Form - Illuminate HTML component
• Entrust - Role-based Permissions
• HTML Sanitizer- HTML Sanitizer
• iSeed - Inverse seed generator
• Whoops - PHP errors for cool kids
• Clockwork - Chrome extension for PHP development

Install

Via Composer, _(*5)

``` bash $ composer require jag/common, <sub>(*6)</sub>

## Post Install

After the installation/update completed, add the service provider to the `$provider` array in `config/app.app`

'Jag\Common\CommonServiceProvider', <sub>(*7)</sub>

After that, run

``` bash
$ php artisan vendor:publish

Configurations from clockwork, ide-helper, image, imagecache, and entrust generated. Also, users migration will be generated., <sub>(*8)</sub>

IDE Helper

After installing/updating composer, you can now re-generate the docs yourself, <sub>(*9)</sub>

``` bash $ php artisan ide-helper:generate, <sub>(*10)</sub>

You can read the full documentation of [this package](https://github.com/barryvdh/laravel-ide-helper)

##### Option Service Provider

If you want to include the Option Service, add the service provider to the `$provider` array in `config/app.app`

'Jag\Common\OptionServiceProvider', <sub>(*11)</sub>

After that, publish the migrations.

``` bash
$ php artisan vendor:publish --provider="Jag\Common\OptionServiceProvider"

Clockwork Middleware

You need to add Clockwork middleware, in your app/Http/Kernel.php, <sub>(*12)</sub>

``` php protected $middleware = [ 'Clockwork\Support\Laravel\ClockworkMiddleware', ... ], <sub>(*13)</sub>

##### How to use Laravel Packager

__NOTE: This is for developing Laravel packages but only works for Laravel `~5.1`.__

If you are using Laravel `~5.1` add the service provider in `config/app.php`

'JeroenG\Packager\PackagerServiceProvider',, <sub>(*14)</sub>

This package provides you with a simple tool to set up a new packages. Nothing more, nothing less. Read more of its documentation [here](https://github.com/Jeroen-G/laravel-packager).

However, an [article](https://medium.com/@tabacitu/creating-laravel-5-packages-for-dummies-ec6a4ded2e93) teaches you to how to create packages.


## Optional Facade

Edit and Add your `config/app.php` at `$aliases` array
``` php
'aliases' => [
    ...
    'Socialite' => 'Laravel\Socialite\Facades\Socialite',
    'Image'     => 'Intervention\Image\Facades\Image',
    'Html'      => 'Illuminate\Html\HtmlFacade',
    'Form'      => 'Illuminate\Html\FormFacade',
    'Entrust'   => 'Zizaco\Entrust\EntrustFacade',
],

You can also use the class name resolution via ::class, <sub>(*15)</sub>

Extend Exception Handler

You can use the Exception handler specially for developing. This includes the Whoops. You can extend your app/Exceptions/Handler.php with Jag\Common\Exceptions\Handler., <sub>(*16)</sub>

JSON Controller Response Trait

For easy JSON response on your Controller, just included the trait Jag\Common\Traits\ControllerResponsesTrait to your app/Http/Controllers/Controller.php., <sub>(*17)</sub>

Change Log

Please see CHANGELOG for more information what has changed recently., <sub>(*18)</sub>

Security

If you discover any security related issues, please email jayaregalinada@gmail.com instead of using the issue tracker., <sub>(*19)</sub>

Credits

• Jay Are Galinada
• Frederic Minne

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>