Creating a custom image generator | laravel-medialibrary | Spatie SPATIE Laravel Media Library ======================== spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary/v11) Converting-other-file-types Creating a custom image generator Version v11 v10 v9 v8 v7 v6 v5 v4 v3 Other versions for crawler [v11](https://spatie.be/docs/laravel-medialibrary/v11) [v10](https://spatie.be/docs/laravel-medialibrary/v10) [v9](https://spatie.be/docs/laravel-medialibrary/v9) [v8](https://spatie.be/docs/laravel-medialibrary/v8) [v7](https://spatie.be/docs/laravel-medialibrary/v7) [v6](https://spatie.be/docs/laravel-medialibrary/v6) [v5](https://spatie.be/docs/laravel-medialibrary/v5) [v4](https://spatie.be/docs/laravel-medialibrary/v4) [v3](https://spatie.be/docs/laravel-medialibrary/v3) Creating a custom image generator - [ Introduction ](https://spatie.be/docs/laravel-medialibrary/v11/introduction) - [ Support us ](https://spatie.be/docs/laravel-medialibrary/v11/support-us) - [ Base installation ](https://spatie.be/docs/laravel-medialibrary/v11/installation-setup) - [ Questions and issues ](https://spatie.be/docs/laravel-medialibrary/v11/questions-issues) - [ Requirements ](https://spatie.be/docs/laravel-medialibrary/v11/requirements) - [ Upgrading ](https://spatie.be/docs/laravel-medialibrary/v11/upgrading) - [ Changelog ](https://spatie.be/docs/laravel-medialibrary/v11/changelog) - [ Troubleshooting ](https://spatie.be/docs/laravel-medialibrary/v11/troubleshooting) - [ About us ](https://spatie.be/docs/laravel-medialibrary/v11/about-us) Basic usage ----------- - [ Preparing your model ](https://spatie.be/docs/laravel-medialibrary/v11/basic-usage/preparing-your-model) - [ Associating files ](https://spatie.be/docs/laravel-medialibrary/v11/basic-usage/associating-files) - [ Retrieving media ](https://spatie.be/docs/laravel-medialibrary/v11/basic-usage/retrieving-media) Working with media collections ------------------------------ - [ Simple media collections ](https://spatie.be/docs/laravel-medialibrary/v11/working-with-media-collections/simple-media-collections) - [ Defining media collections ](https://spatie.be/docs/laravel-medialibrary/v11/working-with-media-collections/defining-media-collections) Converting images ----------------- - [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v11/converting-images/defining-conversions) - [ Retrieving converted images ](https://spatie.be/docs/laravel-medialibrary/v11/converting-images/retrieving-converted-images) - [ Optimizing converted images ](https://spatie.be/docs/laravel-medialibrary/v11/converting-images/optimizing-converted-images) - [ Regenerating images ](https://spatie.be/docs/laravel-medialibrary/v11/converting-images/regenerating-images) Responsive images ----------------- - [ Getting started with responsive images ](https://spatie.be/docs/laravel-medialibrary/v11/responsive-images/getting-started-with-responsive-images) - [ Using your own width calculator ](https://spatie.be/docs/laravel-medialibrary/v11/responsive-images/using-your-own-width-calculator) - [ Customizing the rendered HTML ](https://spatie.be/docs/laravel-medialibrary/v11/responsive-images/customizing-the-rendered-html) - [ Generating your own tiny placeholder ](https://spatie.be/docs/laravel-medialibrary/v11/responsive-images/generating-your-own-tiny-placeholder) - [ Responsive images demo ](https://spatie.be/docs/laravel-medialibrary/v11/responsive-images/demo) Converting other file types --------------------------- - [ Using image generators ](https://spatie.be/docs/laravel-medialibrary/v11/converting-other-file-types/using-image-generators) - [ Creating a custom image generator ](https://spatie.be/docs/laravel-medialibrary/v11/converting-other-file-types/creating-a-custom-image-generator) Downloading media ----------------- - [ Downloading a single file ](https://spatie.be/docs/laravel-medialibrary/v11/downloading-media/downloading-a-single-file) - [ Downloading multiple files ](https://spatie.be/docs/laravel-medialibrary/v11/downloading-media/downloading-multiple-files) Advanced usage -------------- - [ Working with multiple filesystems ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/working-with-multiple-filesystems) - [ Using custom properties ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/using-custom-properties) - [ Storing media specific manipulations ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/storing-media-specific-manipulations) - [ Using your own model ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/using-your-own-model) - [ Outputting media ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/outputting-media) - [ Rendering media ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/rendering-media) - [ Using a custom directory structure ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/using-a-custom-directory-structure) - [ Using a custom file removal strategy ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/using-a-custom-file-removal-strategy) - [ Ordering media ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/ordering-media) - [ Using a custom media downloader ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/using-a-custom-media-downloader) - [ Moving media ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/moving-media) - [ Consuming events ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/consuming-events) - [ Attaching media in mails ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/attaching-media-in-mails) - [ Generating custom URLs ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/generating-custom-urls) - [ Overriding default filesystem behavior ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/overriding-the-default-filesystem-behaviour) - [ Naming generated files ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/naming-files) - [ Disable CDN ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/disable-cdn) - [ Customising Database Connections ](https://spatie.be/docs/laravel-medialibrary/v11/advanced-usage/customising-database-connections) API --- - [ Adding files ](https://spatie.be/docs/laravel-medialibrary/v11/api/adding-files) - [ Defining conversions ](https://spatie.be/docs/laravel-medialibrary/v11/api/defining-conversions) Creating a custom image generator ================================= ### On this page 1. [ Creating a custom image generator ](#content-creating-a-custom-image-generator) 2. [ Registering the custom generator ](#content-registering-the-custom-generator) 3. [ Passing configuration to a custom image generator ](#content-passing-configuration-to-a-custom-image-generator) 4. [ Only using a custom image generator a specific model ](#content-only-using-a-custom-image-generator-a-specific-model) If you want to generate a conversion for a file type that is not covered out of the box you can easily create your own media generator. Generators can only be used to generate images, intended to be used as a thumbnail representation of files. Converting to any other file format other than images is unsupported. In the following example we'll create a custom generator that can convert a Powerpoint to an image. Creating a custom image generator ----------------------------------------------------------------------------------------------------------------------------------------------------------- The first step for creating a custom generator is to create a class that extends `Spatie\MediaLibrary\Conversions\ImageGenerators\ImageGenerator`: ``` use Illuminate\Support\Collection; use Spatie\MediaLibrary\Conversions\Conversion; use Spatie\MediaLibrary\Conversions\ImageGenerators\ImageGenerator; class PowerPoint extends ImageGenerator { /** * This function should return a path to an image representation of the given file. */ public function convert(string $file, Conversion $conversion = null) : string { $pathToImageFile = pathinfo($file, PATHINFO_DIRNAME).'/'.pathinfo($file, PATHINFO_FILENAME).'.jpg'; // Here you should convert the file to an image and return generated conversion path. \PowerPoint::convertFileToImage($file)->store($pathToImageFile); return $pathToImageFile; } public function requirementsAreInstalled() : bool { return true; } public function supportedExtensions() : Collection { return collect(['ppt', 'pptx']); } public function supportedMimeTypes() : Collection { return collect([ 'application/vnd.ms-powerpoint', 'application/vnd.openxmlformats-officedocument.presentationml.presentation' ]); } } ``` Registering the custom generator -------------------------------------------------------------------------------------------------------------------------------------------------------- After creating your custom image generator, you should add the class name to the `image_generators` key of the `media-library` config file. ``` // in config/laravel-medialibrary.php 'image_generators' => [ // ... YourImageGenerator::class, ], ``` Passing configuration to a custom image generator ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- When registering a custom image generator in the `media-library` config file, you can pass values like this ``` // in config/laravel-medialibrary.php 'image_generators' => [ // ... YourImageGenerator::class => ['myArgument' => 'value', 'myOtherArgument' => 'otherValue'], ], ``` In your custom image generator you can accept those arguments in the constructor. ``` class YourImageGenerator { public function __construct(string $myArgument, string $myOtherArgument) { // do something with these arguments } } ``` Only using a custom image generator a specific model -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If the generator only needs to be applied to one of your models you can override the `getImageGenerators` in that model like this: ``` namespace App\Models; use Illuminate\Database\Eloquent\Model; use Spatie\MediaLibrary\InteractsWithMedia; use Spatie\MediaLibrary\Interfaces\HasMedia; class News extends Model implements HasMedia { ... /** * Collection of all ImageGenerator drivers. */ public function getImageGenerators() : Collection { return parent::getImageGenerators()->push(\App\ImageGenerators\PowerPoint::class); } } ``` A good match? ------------- ### What we do best - All things Laravel - Custom frontend components - Building APIs - AI-powered features - Simplifying things - Clean solutions - Integrating services ### Not our cup of tea - WordPress themes - Cutting corners - Free mockups to win a job - "Just execute the briefing" In short: we'd like to be a **substantial part** of your project. [ Get in touch via email ](mailto:info@spatie.be?subject=A%20good%20match%21&body=Tell%20us%20as%20much%20as%20you%20can%20about%0A-%20your%20online%20project%0A-%20your%20planning%0A-%20your%20budget%0A-%20%E2%80%A6%0A%0AAnything%20that%20helps%20us%20to%20start%20straightforward%21)