README

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

Install File API

composer require unisharp/laravel-fileapi

Set service provider in config/app.php

Unisharp\FileApi\FileApiServiceProvider::class,

publish config file

php artisan vendor:publish --tag=fileapi_config

Config

in config/fileapi.php

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

'path' => ['/images/event/', '/images/article/'],

it will generate routes like below :

Route::get('/images/event/{filename}', function ($filename) {
    $entry = new \Unisharp\FileApi\FileApi('/images/event/');
    return $entry->getResponse($filename);
});

Route::get('/images/article/{filename}', function ($filename) {
    $entry = new \Unisharp\FileApi\FileApi('/images/article/');
    return $entry->getResponse($filename);
});

set default thumb sizes(by key and value)

'default_thumbs' => ['S' => '96x96', 'M' => '256x256', 'L' => '480x480'],

set default image compress quality
```
'compress_quality' => 90,
```
choose whether you want to enable upload directly by url(api)
```
'enable_api_upload' => false,
```
and upload to url by below
```
POST /upload/images/event/the-file-name
```
and you might also want to set some middlewares to protect the upload route
```
'middlewares' => [],
```

Usage

Initialize File API

use \Unisharp\FileApi\FileApi;
    
$fa = new FileApi(); # use default path (as '/images/')
$fa_event = new FileApi('/images/event/'); # initialize it by giving a base path
$fa_article = new FileApi('/images/article/'); # initiate another instance

Save By Giving Uploaded File

Default Usage : get unique filename

$file = $fa->save(\Input::file('main_image')); // => wfj412.jpg

Custimize your upload file name

$file = $fa->save(\Input::file('main_image'), 'custom-file-name'); // => custom-file-name.jpg

By default will set three thumbs(equal scaling)

Thumbnail functions

Set custom thumb sizes

$file = $fa
    ->thumbs([
        'S' => '150x100',
        'M' => '300x200',
        'L' => '450x300'
        ])
    ->save(\Input::file('main_image'));

make cropped thumbs

$file = $fa->crop()->save(\Input::file('main_image'));

Get image url

// large size
$fa->get('wfj412.jpg');
$fa->get('wfj412.jpg', 'L');
$fa->get('wfj412.jpg', FileApi::SIZE_LARGE);

// medium size
$fa->get('wfj412.jpg', 'M');
$fa->get('wfj412.jpg', FileApi::SIZE_MEDIUM);

// full size
$fa->get('wfj412.jpg', 'full');
$fa->get('wfj412.jpg', FileApi::SIZE_ORIGINAL);

// comporssed
$fa->get('wfj412.jpg', 'CP'); // => get image url of compressed one

Delete image and thumbs

$fa->drop('wfj412.jpg');

Get file fullpath (abstract path from Laravel Storage)

$fa->getPath('wfj412.jpg'); // => '/images/event/wfj412.jpg'

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

echo $fa->getUrl('wfjsdf.jpg'); // => "https://s3-ap-northeast-1.amazonaws.com/xxx/xxx/55c1e027caa62L.png"

Work with Laravel Storage

Get file content

\Storage::get($fa->getPath('wfj412.jpg'));

Write files

\Storage::put($fa->getPath('wfj412.jpg'));

Get Mime Type

\Storage::mimeType($fa->getPath('wfj412.jpg'));

Auto Upload

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

Image

head

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

body
```
   image={file multipart body}
```

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

Write listener under App\Listeners

 <?php

 namespace App\Listeners;

 class ArticleImageListener
 {

      public function handle($param, $filename, $path)
     {
         ... do something ...
     }
 }

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

unisharp / laravel-fileapi

Maintainers

Details