bkwld/upchuck

A simple, automatic handler of file uploads for Laravel's Eloquent models using using Flysystem.

2.6.1 2020-12-02 21:09 UTC

Requires

• php: >=5.5.0
• graham-campbell/flysystem: ^3 || ^4 || ^5
• illuminate/database: ^5
• illuminate/queue: ^5
• illuminate/support: ^5

Suggests

• league/flysystem-cached-adapter: Required for Flysystem caching of remote disks

Conflicts

• laravel/framework: <5.4.0

MIT

• Robert Reinhard

README

Upchuck is a simple, automatic handler of file uploads for Laravel's Eloquent models using using Flysystem. It does not attempt to do anything besides let the developer treat file uploads like regular input fields. It does this by listening to Eloquent saving events, checking the model attribute for UploadedFile instances, pushing those files to "disk" of your choosing, and then storing the publically accessible URL in the model attribute for that input.

Installation

1. Add to your project: composer require bkwld/upchuck:~2.0
2. Laravel < 5.5 only Add Upchuck as a provider in your app/config/app.php's provider list: 'Bkwld\Upchuck\ServiceProvider',
3. Publish the config: php artisan vendor:publish --provider="Bkwld\Upchuck\ServiceProvider"

Usage

Edit the disk config setting to supply configuration information for where uploads should be moved. We are using Graham Campbell's Flysystem integration for Laravel to instantiate Flysystem instances, so the configruation of the disk matches his configuration options for connections. As the comments in the config file mention, I recommend turning on caching if you are using any disk other than local. For both caching and other disk drivers, you will need to include other packages.

Then, to enable upload support for your models, use the Bkwld\Upchuck\SupportsUploads trait on your model and itemize each attribute that should support uploads via the $upload_attributes property. For example:

class Person extends Eloquent {

	// Use the trait
	use Bkwld\Upchuck\SupportsUploads;

	// Define the uploadable attributes
	protected $upload_attributes = [ 'image', 'pdf', ];

	// Since the upload handling happens via model events, it acts like a mass
	// assignment.  As such, Upchuck sets attributes via `fill()` so you can
	// control the setting.
	protected $fillable = ['image', 'pdf'];
}

Then, say you have a <input type="file" name="image"> field, you would do this from your controller:

$model = new Model;
$model->fill(Input::all())
$model->save();

You are filling the object with the Input:all() array, which includes your image data as an UploadedFile object keyed to the image attribute. When you save(), Upchuck will act on the saving event, moving the upload into the storage you've defined in the config file, and replacing the attribute value with the URL of the file.

Resizing images

If your app supports uploading files you are probably also dealing with needing to resize uploaded images. We (BKWLD) use our Croppa package to resize images using specially formatted URLs. If you are looking for an model-upload package that also resizes images, you might want to check out Stapler.