Framework Integration

Explore how to integrate Intervention Image with Laravel and Symfony frameworks using the official integration packages. Learn to set up configuration files, select drivers and leverage features like auto-orientation, decoding animations, and blending color.

• Laravel
  • Installation
  • Application-wide Configuration
  • Static Facade Interface
  • Image Response Macro
• Symfony
  • Installation
  • Application-wide Configuration
  • Dependency Injection

Laravel

Intervention Image can be easily integrated into a Laravel application with the official integration package. This package provides a Laravel service provider, facade, a publishable configuration file and more.

Installation

Instead of installing the Intervention Image directly, it is only necessary to integrate the intervention/image-laravel package. The corresponding base libraries are automatically installed as well.

composer require intervention/image-laravel

Application-wide Configuration

The extension comes with a global configuration file that is recognized by Laravel. It is therefore possible to store the settings for Intervention Image once centrally and not have to define them individually each time you call the image manager.

The configuration file can be copied to the application with the following command.

php artisan vendor:publish --provider="Intervention\Image\Laravel\ServiceProvider"

This command will publish the configuration file config/image.php. Here you can set the desired driver and its configuration options for Intervention Image. By default the library is configured to use GD library for image processing.

The configuration files looks like this.

return [

    /*
    |--------------------------------------------------------------------------
    | Image Driver
    |--------------------------------------------------------------------------
    |
    | Intervention Image supports “GD Library” and “Imagick” to process images
    | internally. Depending on your PHP setup, you can choose one of them.
    |
    | Included options:
    |   - \Intervention\Image\Drivers\Gd\Driver::class
    |   - \Intervention\Image\Drivers\Imagick\Driver::class
    |
    */

    'driver' => \Intervention\Image\Drivers\Gd\Driver::class,

    /*
    |--------------------------------------------------------------------------
    | Configuration Options
    |--------------------------------------------------------------------------
    |
    | These options control the behavior of Intervention Image.
    |
    | - "autoOrientation" controls whether an imported image should be
    |    automatically rotated according to any existing Exif data.
    |
    | - "decodeAnimation" decides whether a possibly animated image is
    |    decoded as such or whether the animation is discarded.
    |
    | - "blendingColor" Defines the default blending color.
    |
    | - "strip" controls if meta data like exif tags should be removed when
    |    encoding images.
    */

    'options' => [
        'autoOrientation' => true,
        'decodeAnimation' => true,
        'blendingColor' => 'ffffff',
        'strip' => false,
    ]
];

You can read more about the different options for driver selection, setting options for auto orientation, decoding animations and blending color.

Static Facade Interface

This package also integrates access to Intervention Image's central entry point, the ImageManager::class, via a static facade. The call provides access to the centrally configured image manager via singleton pattern.

The following code example shows how to read an image from an upload request the image facade in a Laravel route and save it on disk with a random file name.

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use Intervention\Image\Laravel\Facades\Image;

Route::get('/', function (Request $request) {
    $upload = $request->file('image');
    $image = Image::read($upload)
        ->resize(300, 200);

    Storage::put(
        Str::random() . '.' . $upload->getClientOriginalExtension(),
        $image->encodeByExtension($upload->getClientOriginalExtension(), quality: 70)
    );
});

Image Response Macro

Furthermore, the package includes a response macro that can be used to elegantly encode an image resource and convert it to an HTTP response in a single step.

The following code example shows how to read an image from disk apply modifications and use the image response macro to encode it and send the image back to the user in one call. Only the first parameter is required.

use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use Intervention\Image\Format;
use Intervention\Image\Laravel\Facades\Image;

Route::get('/', function () {
    $image = Image::read(Storage::get('example.jpg'))
        ->scale(300, 200);

    return response()->image($image, Format::WEBP, quality: 65);
});

Symfony

Intervention Image can also be integrated into the Symfony framework. A convenient way is to use the official integration bundle.

Although the use of this integration library is not absolutely mandatory, it offers a convenient way of central configuration in the Symfony framework.

Installation

Instead of installing the Intervention Image directly, it is only necessary to require the bundle package intervention/image-symfony. The corresponding dependencies are automatically installed as well

composer require intervention/image-symfony

Application-wide Configuration

After the successful installation, you can activate the bundle in the file config/bundes.php of your Symfony application by inserting the following line into the array.

return [
    // ...
    Intervention\Image\Symfony\InterventionImageBundle::class => ['all' => true],
];

Now you can configure the driver of Intervention Image. By default, the bundle is using the GD library with Intervention Image. This and others options can be easily configured by creating a file config/packages/intervention_image.yaml and setting the driver class and the default options as follows.

intervention_image:
  driver: Intervention\Image\Drivers\Gd\Driver
  options:
    autoOrientation: true
    decodeAnimation: true
    blendingColor: 'ffffff'
    strip: false

First choose between the two supplied drivers Intervention\Image\Drivers\Gd\Driver and Intervention\Image\Drivers\Imagick\Driver for example.

Then you can then use the options to determine the behavior of the library. Read more about the different options for driver selection, setting options for auto orientation, decoding animations and blending color.

Dependency Injection

The integration is now complete and it is possible to access the ImageManager via dependency injection.

namespace App\Controller;

use Intervention\Image\ImageManager;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class ExampleController extends AbstractController
{
    #[Route('/')]
    public function example(ImageManager $manager): Response
    {
        $image = $manager->read('images/example.jpg');
    }
}