PHPackages                             syofyanzuhad/laravel-fileapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [File & Storage](/categories/file-storage)
4. /
5. syofyanzuhad/laravel-fileapi

ActiveLibrary[File & Storage](/categories/file-storage)

syofyanzuhad/laravel-fileapi
============================

Laravel File API - Handle Files with Laravel Storage

v1.0.2(8y ago)24121[1 PRs](https://github.com/syofyanzuhad/laravel-fileapi/pulls)MITPHPPHP >=5.5.0

Since Oct 14Pushed 4y agoCompare

[ Source](https://github.com/syofyanzuhad/laravel-fileapi)[ Packagist](https://packagist.org/packages/syofyanzuhad/laravel-fileapi)[ RSS](/packages/syofyanzuhad-laravel-fileapi/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (3)Versions (8)Used By (0)

Laravel File API
================

[](#laravel-file-api)

Features
--------

[](#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
------------

[](#installation)

1. Install File API

    ```
    composer require unisharp/laravel-fileapi
    ```
2. Set service provider in `config/app.php`

    ```
    Unisharp\FileApi\FileApiServiceProvider::class,
    ```
3. publish config file

    ```
    php artisan vendor:publish --tag=fileapi_config
    ```

Config
------

[](#config)

in `config/fileapi.php`

1. 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);
    });
    ```
2. set default thumb sizes(by key and value)

    ```
    'default_thumbs' => ['S' => '96x96', 'M' => '256x256', 'L' => '480x480'],
    ```
3. set default image compress quality

    ```
    'compress_quality' => 90,
    ```
4. 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

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

    ```
    'middlewares' => [],
    ```

Usage
-----

[](#usage)

### Initialize File API

[](#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

[](#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

[](#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

[](#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

[](#delete-image-and-thumbs)

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

### Get file fullpath (abstract path from Laravel Storage)

[](#get-file-fullpath-abstract-path-from-laravel-storage)

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

### Parse File Path to URL

[](#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

[](#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
-----------

[](#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

[](#after-uploaded)

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

#### Step

[](#step)

1. Write listener under `App\Listeners`

    ```