multimedia-street/common

Common usage for Multimedia Street Projects

Common

![Software License][ico-license] ![Laravel][ico-laravel] , _(*1)

Some boilerplate for most of the Multimedia Street projects., _(*2)

Table of Contents

• Included Packages
• Install
  • Via Composer
  • Add Service Provider
  • Add Package Facades
  • Disabling CSRF protection for your API
• Post Install
  • Publish Packages Configurations
  • Extend Exception Handler
  • Response Trait
• Change Log
• Testing
• Contributing
• Security
• Credits
• License

Included Packages

• Image - PHP Image Manipulation
• Image (Cache) - Caching extension for the Intervention Image Class
• iSeed - Inverse seed generator
• Whoops - PHP errors for cool kids
• Clockwork - Chrome extension for PHP development
• DOMPDF - DOMPDF Wrapper for Laravel 5
• Excel - Laravel Excel v2.1.* for Laravel 5
• CORS - CORS in Laravel 5

Install

Via Composer

Require the multimedia-street/common package in your composer.json and update your dependencies., _(*3)

``` bash $ composer require multimedia-street/common, <sub>(*4)</sub>

#### Add Service Provider
Include the Service Provider to your `config/app.php` in providers array

``` php
Mmstreet\Common\ServiceProvider::class,

Add Package Facades

Include Facades to your config/app.php in aliases array, <sub>(*5)</sub>

``` php 'Excel' => Maatwebsite\Excel\Facades\Excel::class, 'PDF' => Barryvdh\DomPDF\Facade::class, 'Image' => Intervention\Image\Facades\Image::class,, <sub>(*6)</sub>

#### Disabling CSRF protection for your API
To use the CORS properly, [as stated in the documentation](https://github.com/barryvdh/laravel-cors#disabling-csrf-protection-for-your-api), in `App\Http\Middleware\VerifyCsrfToken`, add your routes to the exceptions:

``` php
protected $except = [
  'api/*'
];

Post Install

Publish Packages Configurations

After the installation is completed, publish the vendor publish by running:, <sub>(*7)</sub>

``` bash php artisan vendor:publish, <sub>(*8)</sub>

#### Extend Exception Handler
You can use the Exception handler specially for developing. This includes the [Whoops](https://github.com/filp/whoops). You can extend your `app/Exceptions/Handler.php` with `Mmstreet\Common\Exceptions\Handler`. Also add your uris using the `$corsUris` property to be used in [CORS](https://github.com/barryvdh/laravel-cors). See example below.

``` php
namespace App\Exceptions;

use Mmstreet\Common\Exceptions\Handler as ExceptionHandler;

class Handler extends ExceptionHandler
{
    protected $corsUris = [
        'api/*', // default
        'auth/*',
        'logout'
    ];
}

Response Trait

You can use the Mmstreet\Common\Traits\ResponseTrait to your App\Http\Controllers\Controller for easy returning response either Json or in View. See example below., <sub>(*9)</sub>

``` php namespace App\Http\Controllers;, <sub>(*10)</sub>

use Illuminate\Foundation\Bus\DispatchesJobs; use Illuminate\Routing\Controller as BaseController; use Illuminate\Foundation\Validation\ValidatesRequests; use Illuminate\Foundation\Auth\Access\AuthorizesRequests; use Mmstreet\Common\Traits\ResponseTrait;, <sub>(*11)</sub>

abstract class Controller extends BaseController { use AuthorizesRequests, DispatchesJobs, ValidatesRequests, ResponseTrait; }, <sub>(*12)</sub>

Example usage:

``` php
namespace App\Http\Controllers;

use App\Post;

class PostController extends Controller
{
    public function index()
    {
        $posts = Post::all();

        if ($posts->isEmpty()) {
            // {The message}, {The data}, {status code}, {view name}, {response headers}, {Json callback}
            return $this->errorResponse('No Posts as of the moment', $posts, 404, 404, [], 'callback');
        }

        return $this->successResponse('Successfully get all posts', $posts);
    }

    public function all()
    {
        $posts = Post::all();

        if ($post->isEmpty()) {
            // You can also use Closure.
            return $this->errorResponse(function() {
                return response('No POSTS');
            }
        }

        return $this->successResponse('Successfully get all posts', $posts);
    }
}

Change log

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

Testing

bash $ composer test, <sub>(*14)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*15)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Jay Are Galinada
• All Contributors

License

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