https://github.com/plank/laravel-mediable
Laravel-Mediable is a package for easily uploading and attaching media files to models with Laravel
https://github.com/plank/laravel-mediable
eloquent file-upload hacktoberfest laravel
Last synced: 8 days ago
JSON representation
Laravel-Mediable is a package for easily uploading and attaching media files to models with Laravel
- Host: GitHub
- URL: https://github.com/plank/laravel-mediable
- Owner: plank
- License: mit
- Created: 2016-07-20T15:07:43.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T02:21:28.000Z (about 2 months ago)
- Last Synced: 2025-04-06T09:00:42.776Z (16 days ago)
- Topics: eloquent, file-upload, hacktoberfest, laravel
- Language: PHP
- Homepage:
- Size: 2.14 MB
- Stars: 798
- Watchers: 19
- Forks: 107
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel-Mediable
[](https://coveralls.io/github/plank/laravel-mediable)
[](https://styleci.io/repos/63791110)
[](https://packagist.org/packages/plank/laravel-mediable)
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.
```php
$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.
```php
$post = Post::create($this->request->input());
$post->attachMedia($media, ['thumbnail']);
```
Retrieve the media from the model by its tag(s).
```php
$post->getMedia('thumbnail')->first()->getUrl();
```
## Installation
Add the package to your Laravel app using composer
```bash
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.
```php
'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.
```php
'aliases' => [
...
'MediaUploader' => Plank\Mediable\MediaUploaderFacade::class,
...
]
```
Publish the config file (`config/mediable.php`) of the package using artisan.
```bash
php artisan vendor:publish --provider="Plank\Mediable\MediableServiceProvider"
```
Run the migrations to add the required tables to your database.
```bash
php artisan migrate
```
## Documentation
Read the documentation [here](http://laravel-mediable.readthedocs.io/en/latest/).
## License
This package is released under the MIT license (MIT).
## About Plank
[Plank](http://plankdesign.com) is a web development agency based in Montreal, Canada.