plank/laravel-mediable

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

Laravel-Mediable

, _(*1)

Laravel-Mediable is a package for easily uploading and attaching media files to models with Laravel., _(*2)

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., _(*3)

$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., _(*4)

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

Retrieve the media from the model by its tag(s)., _(*5)

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

Installation

Add the package to your Laravel app using composer, _(*6)

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., _(*7)

'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., _(*8)

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

Publish the config file (config/mediable.php) of the package using artisan., _(*9)

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

Run the migrations to add the required tables to your database., _(*10)

php artisan migrate

Documentation

Read the documentation here., _(*11)

License

This package is released under the MIT license (MIT)., _(*12)

About Plank

Plank is a web development agency based in Montreal, Canada., _(*13)