plank/laravel-mediable

A package for easily uploading and attaching media files to models with Laravel

6.2.0 2024-12-05 02:23 UTC

Requires

• php: >=8.1.0
• ext-fileinfo: *
• guzzlehttp/guzzle: ^7.9.1
• guzzlehttp/psr7: ^2.7
• illuminate/database: ^10.48.25|^11.34.0
• illuminate/filesystem: ^10.48.25|^11.34.0
• illuminate/support: ^10.48.25|^11.34.0
• intervention/image: ^2.7.1|^3.9.1
• league/flysystem: ^3.29.1
• spatie/image-optimizer: ^1.8
• symfony/http-foundation: ^6.0.3|^7.2
• symfony/mime: ^6.0|^7.2

Requires (Dev)

• aws/aws-sdk-php: ^3.334.0
• doctrine/dbal: ^3.9.3
• guzzlehttp/promises: ^1.5.1
• laravel/legacy-factories: ^1.4.0
• league/flysystem-aws-s3-v3: ^3.29.0
• mockery/mockery: ^1.6.12
• orchestra/testbench: ^9.6.1
• php-coveralls/php-coveralls: ^2.7.0
• phpstan/phpstan: ^2.0.3
• phpunit/phpunit: ^10.5.38
• vlucas/phpdotenv: ^5.6.1

Suggests

• intervention/image-laravel: Laravel bindings for the intervention/image package used for image manipulation

MIT

• Sean Fraser

• media
• image
• laravel
• uploader
• eloquent

README

Laravel-Mediable is a package for easily uploading and attaching media files to models with Laravel.

Features

• Filesystem-driven approach is easily configurable to allow any number of upload directories with different accessibility. Easily restrict uploads by MIME type, extension and/or aggregate type (e.g. image for JPEG, PNG or GIF).
• Many-to-many polymorphic relationships allow any number of media to be assigned to any number of other models without any need to modify their schema.
• Attach media to models with tags, in order to set and retrieve media for specific purposes, such as 'thumbnail', 'featured image', 'gallery' or 'download'.
• Integrated support for integration/image for manipulating image files to create variants for different use cases.

Example Usage

Upload a file to the server, and place it in a directory on the filesystem disk named "uploads". This will create a Media record that can be used to refer to the file.

$media = MediaUploader::fromSource($request->file('thumb'))
	->toDestination('uploads', 'blog/thumbnails')
	->upload();

Attach the Media to another eloquent model with one or more tags defining their relationship.

$post = Post::create($this->request->input());
$post->attachMedia($media, ['thumbnail']);

Retrieve the media from the model by its tag(s).

$post->getMedia('thumbnail')->first()->getUrl();

Installation

Add the package to your Laravel app using composer

composer require plank/laravel-mediable

Register the package's service provider in config/app.php. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.

'providers' => [
    ...
    Plank\Mediable\MediableServiceProvider::class,
    ...
];

The package comes with a Facade for the image uploader, which you can optionally register as well. In Laravel versions 5.5 and beyond, this step can be skipped if package auto-discovery is enabled.

'aliases' => [
	...
    'MediaUploader' => Plank\Mediable\MediaUploaderFacade::class,
    ...
]

Publish the config file (config/mediable.php) of the package using artisan.

php artisan vendor:publish --provider="Plank\Mediable\MediableServiceProvider"

Run the migrations to add the required tables to your database.

php artisan migrate

Documentation

Read the documentation here.

License

This package is released under the MIT license (MIT).

About Plank

Plank is a web development agency based in Montreal, Canada.