monibco/laravel-webp

Laravel package for WebP image format

dev-master 2021-03-08 11:32 UTC

This package is not auto-updated.

Last update: 2024-05-15 01:54:06 UTC


README

Latest Version on Packagist Software License Total Downloads

About

Cloned from https://github.com/buglinjo/laravel-webp and now source file is image path.

WebP is a modern image format that provides superior lossless and lossy compression for images on the web. Using WebP, webmasters and web developers can create smaller, richer images that make the web faster.

WebP lossless images are 26% smaller in size compared to PNGs. WebP lossy images are 25-34% smaller than comparable JPEG images at equivalent SSIM quality index.

Lossless WebP supports transparency (also known as alpha channel) at a cost of just 22% additional bytes. For cases when lossy RGB compression is acceptable, lossy WebP also supports transparency, typically providing 3× smaller file sizes compared to PNG.

cwebp compresses an image using the WebP format. Input format can be either PNG, JPEG, TIFF, WebP or raw Y'CbCr samples.

Before Installation

Note: You will need to install WebP before installing this package. For more information you can visit this page

Install

Via Composer

$ composer require monibco/laravel-webp

For Laravel <= 5.4

After updating composer, add the ServiceProvider to the providers array in config/app.php

Monibco\LaravelWebp\WebpServiceProvider::class,

You can use the facade for shorter code. Add this to your aliases:

'Webp' => Monibco\LaravelWebp\Facades\Webp::class,

Publish config file

You will need to publish config file to add cwebp global path.

php artisan vendor:publish --provider="Monibco\LaravelWebp\WebpServiceProvider" --tag=config

In config/laravel-webp.php config file you should set cwebp global path.

    return [
        /*
        |--------------------------------------------------------------------------
        | Default Quality
        |--------------------------------------------------------------------------
        |
        | This is a default quality unless you provide while generation of the WebP
        |
        */

        'default_quality' => 70,

        /*
        |--------------------------------------------------------------------------
        | Default Driver
        |--------------------------------------------------------------------------
        |
        | This is a default image processing driver. Available: ['cwebp']
        |
        */

        'default_driver' => 'cwebp',

        /*
        |--------------------------------------------------------------------------
        | Drivers
        |--------------------------------------------------------------------------
        |
        | Available drivers which can be selected
        |
        */

        'drivers' => [

            'cwebp' => [
                'path' => '/usr/local/bin/cwebp',
            ],

        ],
    ];

Usage

Webp::make(image path>)->save(<output path>, <quality :optional>);

Example:

    $webp = Webp::make($filePath));

    if ($webp->save(public_path('output.webp'))) {
        // File is saved successfully
    }

where <quality> is 0 - 100 integer. 0 - lowest quality, 100 - highest quality.

Default quality is 70

Also you can set quality by chaining ->quality(<quality>) between WebP::make(<image path>) and ->save(<output path>);

License

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