README

A Laravel package for dynamic image processing based on Spatie/Laravel-Glide.

Features

Dynamic image processing (resizing, cropping, format conversion)
Image optimization for web use
Automatic caching for improved performance
Configurable default images by category
Predefined presets for consistent image usage
HasImages trait for Eloquent models
ImageProcessor facade for easy access
Configurable routes to avoid conflicts with other packages

Current Limitations

The package currently works only with local files (using the 'local' and 'public' disks)
External storage services like AWS S3 are not fully supported for image processing
URLs from external services are recognized but cannot be dynamically processed

Installation

You can install the package via composer:

composer require maccesar/laravel-glide-enhanced

The package will automatically register its service provider and facade.

Then publish the configuration file:

php artisan vendor:publish --tag=images-config

Requirements

PHP 8.0 or higher
Laravel 8.x, 9.x, 10.x, 11.x, or 12.x
Spatie's Laravel Glide package

Configuration

The config/images.php file contains several configuration options:

return [
    // Image cache configuration
    'cache' => [
        'lifetime' => 30, // days
        'path' => 'cache/img',
    ],

    // Default processing settings
    'defaults' => [
        'fit' => 'max',     // Default fit mode (max, crop, fill, stretch)
        'quality' => 85,    // Default quality (0-100)
        'format' => 'webp', // Default output format (webp, jpg, png, etc.)
    ],

    // Routes configuration
    'routes' => [
        'enabled' => true,       // Enable/disable package routes
        'prefix' => 'img',       // URL prefix for the image routes
        'middleware' => ['web'],  // Middleware to apply to the routes
    ],

    // Disk configuration. Change to 'local' if your images are in /storage/app
    'disk' => 'public',

    // Default fallback images by category
    'fallback_images' => [
        'default' => 'defaults/no-image.jpg',
        'documents' => 'defaults/document.jpg',
        'evidence' => 'defaults/evidence.jpg',
        'products' => 'defaults/product.jpg',
        'users' => 'defaults/user.jpg',
    ],

    // Predefined presets for image conversion
    'presets' => [
        'large' => ['dimensions' => '800', 'format' => 'webp', 'fit' => 'max'],
        'medium' => ['dimensions' => '400', 'format' => 'webp', 'fit' => 'max'],
        'social' => ['dimensions' => '1200x630', 'format' => 'jpg', 'fit' => 'crop'],
        'thumbnail' => ['dimensions' => '150x150', 'format' => 'webp', 'fit' => 'crop'],
    ],
];

Disk Configuration

The disk configuration allows you to specify where your images are stored. By default, the package uses the public disk, which corresponds to the /storage/app/public directory. If your images are stored in a different location, such as the root of /storage/app, you can change the disk to local or any other disk defined in your Laravel filesystem configuration.

'disk' => 'public', // Change to 'local' if your images are in /storage/app

For example, if your images are stored in /storage/app, update the configuration as follows:

'disk' => 'local',

Make sure the disk you specify is properly configured in your config/filesystems.php file.

Route Configuration

The routes section allows you to customize how the package registers its routes:

'routes' => [
    'enabled' => true,        // Set to false to disable all package routes
    'prefix' => 'img',        // Change the URL prefix (e.g., 'images', 'media', etc.)
    'middleware' => ['web'],  // Add or modify middleware applied to the routes
],

If you need to avoid conflicts with other packages, you can change the route prefix or disable the routes entirely and implement your own.

Basic Usage

Image Processing URLs

use MacCesar\LaravelGlideEnhanced\Facades\ImageProcessor;

// Basic URL with parameters
ImageProcessor::url('path/to/image.jpg', ['w' => 300, 'h' => 200, 'fit' => 'crop']);

// WebP optimized URL
ImageProcessor::webpUrl('path/to/image.jpg', ['w' => 300, 'h' => 200, 'fit' => 'crop', 'q' => 90]);

// Use a predefined preset
ImageProcessor::preset('path/to/image.jpg', 'thumbnail');

HasImages Trait for Eloquent Models

use MacCesar\LaravelGlideEnhanced\Traits\HasImages;

class Product extends Model
{
    use HasImages;

    // ...
}

// Usage in code
$product->getImageWebpUrl('main', 300);
$product->getImageUrl('main', ['w' => 300]);
$product->getImagePreset('main', 'thumbnail');

Responsive Images with srcset

The package provides a convenient way to generate srcset attributes for responsive images with different pixel densities:

use MacCesar\LaravelGlideEnhanced\Facades\ImageProcessor;

// Generate srcset for 1x, 2x, and 3x pixel densities
ImageProcessor::srcset('path/to/image.jpg', ['w' => 300, 'fm' => 'webp']);
// Output: "/img/storage/path/to/image.jpg?w=300&fm=webp 1x, /img/storage/path/to/image.jpg?w=600&fm=webp 2x, /img/storage/path/to/image.jpg?w=900&fm=webp 3x"

// Control the maximum density factor (e.g., up to 2x)
ImageProcessor::srcset('path/to/image.jpg', ['w' => 300, 'h' => 200, 'fm' => 'webp'], 2);
// Output: "/img/storage/path/to/image.jpg?w=300&h=200&fm=webp 1x, /img/storage/path/to/image.jpg?w=600&h=400&fm=webp 2x"

Applying Watermarks

You can apply watermarks to your images using the following parameters:

use MacCesar\LaravelGlideEnhanced\Facades\ImageProcessor;

// Apply watermark
ImageProcessor::url('path/to/image.jpg', ['w' => 600, 'mark' => 'watermarks/logo.png', 'markw' => 200, 'markpos' => 'bottom-right', 'markalpha' => 60]);

Important note: The watermark image must exist at the specified path within storage/app/public/. For example, if you use 'mark' => 'watermarks/logo.png', the file should be located at storage/app/public/watermarks/logo.png.

Cache Cleaning

To clean the image cache, use the command:

php artisan images:clean-cache

To clean only images older than a specific number of days:

php artisan images:clean-cache --days=7

Components Registered

This package registers the following components in Laravel:

Routes: A route with the prefix /img/ (configurable via the routes.prefix config)
Services: A singleton image-processor in the container
Facade: ImageProcessor for easy access to the service
Command: images:clean-cache for cache maintenance

License

MIT

Credits

Developed by César Estrada (macCesar)

maccesar / laravel-glide-enhanced

Maintainers

Details