README

laravel-file-compressor is a Laravel package that compresses uploaded images before saving them to Laravel storage. It supports JPEG, PNG, and WebP uploads and returns the stored path after compression.

Features

• Compress uploaded images before storing them
• Support for JPEG, PNG, and WebP
• Configurable compression quality
• Configurable storage disk
• Publishable configuration
• Laravel package discovery for provider and facade

Requirements

• PHP 8.0+
• Laravel 9, 10, 11, or 12
• Intervention Image

Installation

Install the package with Composer:

composer require vendor/laravel-file-compressor

If you publish this package under your own Composer vendor, replace vendor with your actual vendor name.

Package Structure

laravel-file-compressor/
|-- composer.json
|-- README.md
|-- config/
|   `-- file-compressor.php
`-- src/
    |-- Exceptions/
    |   |-- FileStorageException.php
    |   `-- UnsupportedFileTypeException.php
    |-- Facades/
    |   `-- FileCompressor.php
    |-- Support/
    |   `-- FileHelper.php
    |-- FileCompressorManager.php
    `-- FileCompressorServiceProvider.php

Configuration

Publish the package configuration:

php artisan vendor:publish --tag=file-compressor-config

The generated config file contains:

return [
    'compression_quality' => 75,
    'allowed_file_types' => ['jpg', 'jpeg', 'png', 'webp'],
    'storage_disk' => 'public',
];

Usage

Facade Example

use FileCompressor;

$path = FileCompressor::compressAndStore($request->file('image'), 'uploads');

The method will:

1. Validate the uploaded file type against the configured allow list.
2. Compress the image using the configured quality.
3. Store the compressed image on the configured Laravel disk.
4. Return the stored file path, for example uploads/abc123-file.jpg.

Custom Disk or Quality

$path = FileCompressor::compressAndStore(
    $request->file('image'),
    'uploads',
    's3',
    ['quality' => 65]
);

Example Controller

<?php

namespace App\Http\Controllers;

use FileCompressor;
use Illuminate\Http\Request;

class UploadController extends Controller
{
    public function store(Request $request)
    {
        $request->validate([
            'image' => ['required', 'image', 'mimes:jpeg,jpg,png,webp'],
        ]);

        $path = FileCompressor::compressAndStore($request->file('image'), 'uploads');

        return response()->json([
            'path' => $path,
        ]);
    }
}

How It Works

• The package reads the uploaded file using Intervention Image.
• The image is re-encoded using the configured quality level.
• The compressed binary is written with Laravel's Storage facade.
• The stored relative path is returned to the caller.

Notes

• The current implementation is image-focused and only processes configured image extensions.
• For public disk usage, make sure php artisan storage:link has been run in the Laravel application when public access is required.

License

MIT