Download the PHP package unisharp/laravel-fileapi without Composer

Laravel File API

Features

• Handle files with Laravel Storage.
• Load files through Laravel routing instead of public path.
• Save images with thumbs, compressed image, and sizes are customisable.

Installation

1. Install File API

2. Set service provider in config/app.php

3. publish config file

Config

in config/fileapi.php

1. fill in the storage path, which make routes for you.

   it will generate routes like below :

2. set default thumb sizes(by key and value)

3. set default image compress quality

4. choose whether you want to enable upload directly by url(api)

   and upload to url by below

5. and you might also want to set some middlewares to protect the upload route

Usage

Initialize File API

Save By Giving Uploaded File

• Default Usage : get unique filename

• Custimize your upload file name

• By default will set three thumbs(equal scaling)

Thumbnail functions

• Set custom thumb sizes

• make cropped thumbs

Get image url

Delete image and thumbs

Get file fullpath (abstract path from Laravel Storage)

Parse File Path to URL

if you store your file into cloud storage and you want to get url cloud site, you can use url() method to get it

Work with Laravel Storage

• Get file content

• Write files

• Get Mime Type

Auto Upload

if enable_api_upload=true in config/fileapi.php, you can upload file to these two path

1. Image

   • head

      POST /api/v1/images/{target}/{param?}

   • body

      image={file multipart body}

2. Video

   • head

     /api/v1/videos/{target}/{param?}

   • body

     video={file multipar body}

After uploaded

you add event listener to finish up after file uploaded, file api will fire image.{target}.created and video.{target}.created

Step

1. Write listener under App\Listeners

   <?php
   
   namespace App\Listeners;
   
   class ArticleImageListener
   {
   
        public function handle($param, $filename, $path)
       {
           ... do something ...
       }
   }

2. Write event mapping in Providers\EvnetService\Providers

       protected $listen = [
           'image.article.created' => [
               'App\Listeners\ArticleImageListener'
           ],
       ];

Configurations

'enable_api_upload' => false, // auto upload api
'api_prefix' => '/api/v1',    // upload api url prefix
'middlewares' => [],          // middlewares that wrap the api upload route