README

This Laravel package is a simple wrapper for the PHP Intervention Library to provide a more straightforward interface and convenient way to convert images to the WebP format - a next-generation image format - and resize them to render only the needed sizes.

Installation

You can install the package via composer:

composer require eyadhamza/laravel-webp

Publish the config file with:

php artisan vendor:publish --provider="EyadHamza\LaravelWebp\LaravelWebpServiceProvider" --tag="webp-config"

The contents of the published config file:

return [
    'quality' => 70,
    'height' => null,
    'width' => null,
    'overwrite' => true
];

Usage

Converting / Resizing Images in Eloquent Models:

To convert images in Eloquent Models, all you need to do is to add a cast to the image columns in your model:

class TestModel extends Model
{
    protected $casts = [
        'image' => ToWebpCast::class . ':200,200,100',
        'avatar' => ToWebpCast::class,
    ];
}

The ToWebpCast class takes three optional parameters: width, height, and quality. You can also pass the values in the config file as default values. In the config file, set the overwrite value to true or false; if set to true, the old image will be deleted.

Now, whenever you set the image attribute, it will be converted to WebP and resized to the specified dimensions—if given.

Optimize Existing Images:

If you already have images on your local storage that are not optimized, and their paths are stored in the database, you can use the following Artisan command:

php artisan public:to-webp

To convert images in a specific directory:

php artisan public:to-webp --directory='public/images'

To delete old images, use the --overwrite option:

php artisan public:to-webp --overwrite

For optimizing files in static assets, use:

php artisan public:to-webp --assets

To modify the database attribute values to point to the new webp image, run:

php artisan images:to-webp Post

If you want more methods to conveniently change your image path, refer to the ImageToWebpService class.

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

eyadhamza / laravel-webp

Maintainers

Details