padosoft/laravel-uploadable

Laravel package for automatic upload handling with trait

3.1.1 2019-04-24 11:59 UTC

This package is auto-updated.

Last update: 2019-11-24 20:02:17 UTC


README

Latest Version on Packagist Software License Build Status Quality Score Total Downloads SensioLabsInsight

This package provides a trait that will automatic handlind upload when saving/updating/deleting any Eloquent model with upload form request.

##Requires

"php" : ">=7.1.0", "padosoft/support": "^1.6|^2.1" "padosoft/io": "^1.0", "illuminate/http": "^5.7|^5.8", "illuminate/database": "^5.7|^5.8", "illuminate/support": "^5.7|^5.8", "padosoft/laravel-request": "^2.0|^3.0",

Installation

You can install the package via composer:

$ composer require padosoft/laravel-uploadable

Usage

Your Eloquent models should use the Padosoft\Uploadable\Uploadable trait and the Padosoft\Uploadable\UploadOptions class.

You can define getUploadOptions() method in your model.

Here's an example of how to implement the trait with implementation of getUploadOptions():

<?php

namespace App;

use Padosoft\Uploadable\Uploadable;
use Padosoft\Uploadable\UploadOptions;
use Illuminate\Database\Eloquent\Model;

class YourEloquentModel extends Model
{
    use Uploadable;
    
 /**
     * Retrive a specifice UploadOptions for this model, or return default UploadOptions
     * @return UploadOptions
     */
    public function getUploadOptions() : UploadOptions
    {
        if($this->uploadOptions){
            return $this->uploadOptions;
        }

        $this->uploadOptions = UploadOptions::create()->getUploadOptionsDefault()
            ->setUploadBasePath(public_path('upload/' . $this->getTable()))
            ->setUploadsAttributes(['image', 'image_mobile']);

        return $this->uploadOptions;
    }
}

You can specified uploads attributes with:

public function getUploadOptions() : UploadOptions
{
    return UploadOptions::create()
        ->setUploadsAttributes(['image', 'image_mobile']);
}

You can set the base upload path for your model:

public function getUploadOptions() : UploadOptions
{
    return UploadOptions::create()
        ->setUploadBasePath(public_path('upload/news'));
}

You can set different path for each (or for some) upload attributes in your model:

public function getUploadOptions() : UploadOptions
{
    return UploadOptions::create()
        ->setUploadPaths(['image_mobile' => '/mobile' ]);
}

It support validation to accept files by specified list of Mime Type:

public function getUploadOptions() : UploadOptions
{
    return UploadOptions::create()
        ->setMimeType([
          'image/gif',
          'image/jpeg',
          'image/png',
            ]);
}

By default every uploaded file will rename with 'original_name_'.$model->id.'.original_ext' but you can redefine a custom function for renaming file:

/**
 * Generate a new file name for uploaded file.
 * Return empty string if $uploadedFile is null.
 * @param \Illuminate\Http\UploadedFile $uploadedFile
 * @param String $uploadField
 * @return string
 */
public function generateNewUploadFileName(\Illuminate\Http\UploadedFile $uploadedFile, string $uploadField) : string 
{
    if($uploadField=='image'){
        return 'pippo.jpg';
    }else{
        return 'pippo_mobile.jpg';
    }
}

This class use Laravel 'local' Storage Disk for default. You can set different disk in your model:

public function getUploadOptions() : UploadOptions
{
    return UploadOptions::create()
        ->setStorageDisk('ftp');
}

For all options see UploadOptions class.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email instead of using the issue tracker.

Credits

About Padosoft

Padosoft (https://www.padosoft.com) is a software house based in Florence, Italy. Specialized in E-commerce and web sites.

License

The MIT License (MIT). Please see License File for more information.