okipa/laravel-medialibrary-ext

Extra features for spatie/laravel-medialibrary package.

10.2.0 2023-01-22 07:57 UTC

Requires

• php: 8.1.*|8.2.*
• illuminate/contracts: ^9.0|^10.0
• spatie/laravel-medialibrary: ^10.0
• symfony/mime: ^6.0

Requires (Dev)

• brianium/paratest: ^6.4
• laravel/pint: ^1.1
• nunomaduro/collision: ^6.0
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^7.0|^8.0
• phpmd/phpmd: ^2.11
• roave/security-advisories: dev-latest

MIT

• Arthur LORENT

• media
• cms
• extension
• conversion
• images
• laravel
• downloads
• spatie
• laravel-medialibrary
• okipa
• laravel-medialibrary-extension

README

This package extension provides extra features for the spatie/laravel-medialibrary package.

Found this package helpful? Please consider supporting my work!

Compatibility

This package extension will follow the base package major versions but may be a bit stricter about compatibility constraints.

Upgrade guide

• From V9 to V10
• From V8 to V9
• From V7 to V8

Table of contents

• Installation
• Documentation
• Translations
• Extension features
  • Validation rules
  • Media caption
• Testing
• Changelog
• Contributing
• Security
• Credits
• Licence

Installation

First, be sure to follow the base package installation instructions:

• https://github.com/spatie/laravel-medialibrary#installation
• https://docs.spatie.be/laravel-medialibrary/v8/installation-setup

Then, install the extension via composer:

composer require okipa/laravel-medialibrary-ext

Finally, implement the ExtendsMediaAbilities trait to be able to use the extension features in addition of the base package ones.

use Illuminate\Database\Eloquent\Model;
use Okipa\MediaLibraryExt\ExtendsMediaAbilities;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;

class Page extends Model implements HasMedia
{
    use InteractsWithMedia;
    use ExtendsMediaAbilities;

	// ...
}

Documentation

Find the complete documentation of the base package here: https://docs.spatie.be/laravel-medialibrary/v8/introduction.

Translations

All captions are translatable.

See how to translate them on the Laravel official documentation: https://laravel.com/docs/localization#using-translation-strings-as-keys.

Here is the list of the sentences available for translation:

• Min. width: :width px.
• Min. height: :height px.
• {1}Accepted type: :types.|[2,*]Accepted types: :types.
• Max. file size: :size Mb.

Extension features

Media validation rules

Declaring your media validation rules like this:

// In your user storing form request for example
public function rules()
{
    return [
        'avatar' => (new User)->getMediaValidationRules('avatar'),
        // your other validation rules
    ];
}

Will generate:

    // Example
    ['mimetypes:image/jpeg,image/png', 'mimes:jpg,jpeg,jpe,png', 'dimensions:min_width=60,min_height=20', 'max:5000'];

Available public methods:

• ->getMediaValidationRules(string $collectionName): array: returns all the validation rules for the given collection.
• ->getMediaMimesValidationRules(string $collectionName): string: returns only the mimes validation rules for the given collection.
• ->getMediaMimeTypesValidationRules(string $collectionName): string: returns only the mime types validation rules for the given collection.
• ->getMediaDimensionValidationRules(string $collectionName): string: returns only the dimension validation rules for the given collection.
• ->getMediaSizeValidationRule(): string: returns only the max file size validation rule set from the base package media-library.max_file_size configuration value.

Media caption

Adding a constraint caption under a file input:

<!-- In your HTML form -->
<label for="avatar">Choose a profile picture:</label>
<input type="file" id="avatar" name="avatar" value="{{ $user->getFirstMedia('avatar')->name }}">
<small>{{ $user->getMediaCaption('avatar') }}</small>

Will generate:

    <!-- Example -->
    Min. width: 150 px. Min. height: 70 px. Accepted types: jpg, jpeg, jpe, png. Max file size: 5Mb.

Available public methods:

• getMediaCaption(string $collectionName): string: returns a complete caption for the given collection.
• getMediaDimensionsCaption(string $collectionName): string: returns only the dimensions caption for the given collection.
• getMediaMimeTypesCaption(string $collectionName): string: returns only the mime types caption for the given collection.
• getMediaSizeCaption(): string: returns only the config max file size caption only.

Exceptions

In order to avoid careless mistakes when using public methods that are requiring a string $collectionName argument provided by this extension, an Okipa\MediaLibraryExt\Exceptions\CollectionNotFound exception will be thrown when the given collection name is not found in the targeted model.

Testing

composer test

Changelog

Please see CHANGELOG for more information about what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Arthur LORENT
• All Contributors

License

The MIT License (MIT). Please see License File for more information.