Every two weeks I send out a newsletter containing lots of interesting stuff for the modern PHP developer. You can expect quick tips, links to interesting tutorials, opinions and packages. Want to learn the cool stuff? Then sign up now!

Laravel-medialibrary hits version 3

Not a month has gone by since v2 of the laravel-medialibrary package got released. If you’re not familiar with it: the package provides an easy way to associate files with Eloquent models. Though I was quite happy with the improvements made over v1 there were some things that bothered me.

Take a look at the signature of the addMedia function:

public function addMedia($file, $collectionName = 'default', $removeOriginal = true, $addAsTemporary = false)

It accepts two booleans. It’s perfectly understandable what the booleans do when looking at the function signature. When using the function it becomes less clear:

$model->addMedia('test.jpg', 'images', false, true);

Using booleans as parameters wasn’t a good idea. I couldn’t improve this function without making breaking changes. That’s why the version number had to be bumped up from v2 to v3.

In the shiny new version of the medialibrary the addMedia-function is replaced with a fluent interface:


The new way of adding a files is a lot more readable. As a bonus new functions can be added to this fluent interface without making breaking changes.

Another new feature is that the package can now handle uploads directly. Previously only a file could be added. You had to do this to add a file to the medialibrary:

$file = $request->get('file');

$targetDirectory = storage_path('temp');
$targetFileName = $file->getClientOriginalName());

$file->move($targetDirectory, $targetFileName);

$media = $yourModel->addMedia($targetDirectory.'/'.$targetFileName, $collectionName);

The equivalent code using v3 of the medialibrary is:


Besides the new way of adding files the package can now use multiple filesystems to store media. When adding a file to the medialibrary you can choose on which disk the file should be stored:

->toCollectionOnDisk('images', 's3');

This is useful when for example you have some small files that should be stored locally and some big files that you want to save on s3.

Another neat addition is that custom properties can be stored on a media object:

->withCustomProperties(['mime-type' => 'image/jpeg'])
->toCollectionOnDisk('images', 's3');

If you’re coming from a previous version and want to upgrade to the latest release check out the upgrade instructions to learn how to upgrade. If you’re new to the package you can read the entire installation and usage guide on GitHub:

Freek Van der Herten is a partner and developer at Spatie, an Antwerp based company that specializes in creating web apps with Laravel. After hours he writes about modern PHP and Laravel on this blog. When not coding he’s probably rehearsing with his kraut rock band. He loves waffles and butterflies.
  • Binalf Kassa

    Is this package compatible with php 7?

    • Yes, it is

      • Binalf Kassa

        Sorry to bother you but this is what i got while installing it on my new laravel 5.2 project:

        Your requirements could not be resolved to an installable set of packages.

        Problem 1
        – Conclusion: don’t install spatie/laravel-glide 2.2.6
        – Conclusion: don’t install spatie/laravel-medialibrary 3.11.1|install spatie/laravel-glide 2.2.6
        – Conclusion: don’t install spatie/laravel-medialibrary 3.11.2|install spatie/laravel-glide 2.2.6
        – Conclusion: don’t install spatie/laravel-medialibrary 3.11.3|install spatie/laravel-glide 2.2.6
        – Conclusion: don’t install spatie/laravel-medialibrary 3.11.0|remove symfony/debug v3.0.0|install spatie/laravel-glide 2.2.6
        – Conclusion: don’t install spatie/laravel-medialibrary 3.11.0|don’t install symfony/debug v3.0.0|install spatie/laravel-glide 2.2.6