PHPackages                             povly/moonshine-intervention-image - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image & Media](/categories/media)
4. /
5. povly/moonshine-intervention-image

Abandoned → [povly/moonshine-image-editor](/?search=povly%2Fmoonshine-image-editor)Library[Image & Media](/categories/media)

povly/moonshine-intervention-image
==================================

Image optimization and WebP/AVIF conversion field for MoonShine using intervention/image

v1.8.2(1mo ago)6157MITPHPPHP ^8.2

Since Mar 15Pushed 1mo agoCompare

[ Source](https://github.com/povly/moonshine-intervention-image)[ Packagist](https://packagist.org/packages/povly/moonshine-intervention-image)[ RSS](/packages/povly-moonshine-intervention-image/feed)WikiDiscussions main Synced 3w ago

READMEChangelogDependencies (10)Versions (17)Used By (0)

MoonShine Intervention Image Field
==================================

[](#moonshine-intervention-image-field)

> **⚠️ This package is no longer maintained.**
>
> Use these two packages instead:
>
> - **[yurizoom/moonshine-media-manager](https://github.com/yurizoom/moonshine-media-manager)** — file manager
> - **[povly/moonshine-image-editor](https://github.com/povly/moonshine-image-editor)** — visual image editor with optimization and WebP/AVIF conversion
>
> ```
> composer require yurizoom/moonshine-media-manager povly/moonshine-image-editor
> ```

---

Image optimization and WebP/AVIF conversion field for MoonShine using [intervention/image](https://image.intervention.io/).

Installation
------------

[](#installation)

```
composer require povly/moonshine-intervention-image
```

The package requires `intervention/image` and `intervention/image-laravel`. If not already installed:

```
composer require intervention/image intervention/image-laravel
```

Publish the config (optional):

```
php artisan vendor:publish --tag=moonshine-intervention-image-config
```

Requirements
------------

[](#requirements)

- PHP 8.2+
- Laravel 11+ / 12+
- MoonShine 4.x
- intervention/image ^3.0
- intervention/image-laravel ^1.0
- GD or Imagick extension

Configuration
-------------

[](#configuration)

Publish the config file to customize default settings:

```
// config/moonshine-intervention-image.php
return [
    'default' => [
        'quality' => env('MOONSHINE_INTERVENTION_IMAGE_QUALITY', 85),
        'quality_webp' => env('MOONSHINE_INTERVENTION_IMAGE_QUALITY_WEBP', 80),
        'quality_avif' => env('MOONSHINE_INTERVENTION_IMAGE_QUALITY_AVIF', 65),
        'generate_webp' => env('MOONSHINE_INTERVENTION_IMAGE_WEBP', false),
        'generate_avif' => env('MOONSHINE_INTERVENTION_IMAGE_AVIF', false),
        'strip_metadata' => env('MOONSHINE_INTERVENTION_IMAGE_STRIP_METADATA', false),
        'max_width' => env('MOONSHINE_INTERVENTION_IMAGE_MAX_WIDTH'),
        'max_height' => env('MOONSHINE_INTERVENTION_IMAGE_MAX_HEIGHT'),
        'logging' => env('MOONSHINE_INTERVENTION_IMAGE_LOGGING', false),
    ],
    'png' => [
        'indexed' => env('MOONSHINE_INTERVENTION_IMAGE_PNG_INDEXED', true),
        'colors' => env('MOONSHINE_INTERVENTION_IMAGE_PNG_COLORS', 256),
    ],
    'queue' => [
        'enabled' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_ENABLED', false),
        'connection' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_CONNECTION'),
        'queue' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_NAME', 'images'),
        'delay' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_DELAY'),
        'tries' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_TRIES', 3),
        'timeout' => env('MOONSHINE_INTERVENTION_IMAGE_QUEUE_TIMEOUT', 120),
    ],
    'presets' => [
        'banner' => [
            'quality' => 85,
            'quality_webp' => 80,
            'quality_avif' => 65,
            'generate_webp' => true,
            'generate_avif' => false,
            'max_width' => 1920,
            'max_height' => 1080,
            'png_indexed' => true,
        ],
    ],
    'watermark' => [
        'enabled' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_ENABLED', false),
        'image' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_IMAGE'),
        'position' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_POSITION', 'bottom-right'),
        'custom_position' => [
            'x' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_CUSTOM_X'),
            'y' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_CUSTOM_Y'),
        ],
        'offset_x' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OFFSET_X', 10),
        'offset_y' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OFFSET_Y', 10),
        'opacity' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OPACITY', 100),
        'width' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_WIDTH'),
        'height' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_HEIGHT'),
    ],
    'watermark_text' => [
        'enabled' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_ENABLED', false),
        'text' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT'),
        'font' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_FONT'),
        'size' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_SIZE', 24),
        'color' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_COLOR', 'ffffff'),
        'position' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_POSITION', 'bottom-right'),
        'custom_position' => [
            'x' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_CUSTOM_X'),
            'y' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_CUSTOM_Y'),
        ],
        'offset_x' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_OFFSET_X', 10),
        'offset_y' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_OFFSET_Y', 10),
        'stroke_color' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_STROKE_COLOR'),
        'stroke_width' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_STROKE_WIDTH', 2),
        'angle' => env('MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_ANGLE'),
    ],

    'optimize' => [
        'disk' => env('MOONSHINE_INTERVENTION_IMAGE_OPTIMIZE_DISK', 'public'),
        'exclude_paths' => [],
    ],
];
```

Basic Usage
-----------

[](#basic-usage)

```
use Povly\MoonshineInterventionImage\Fields\InterventionImage;
// Basic usage
InterventionImage::make('Image', 'image')
// Using preset from config
InterventionImage::make('Image', 'image')
    ->preset('banner')
// With WebP generation
InterventionImage::make('Image', 'image')
    ->generateWebp()
// With AVIF generation
InterventionImage::make('Image', 'image')
    ->generateAvif()
// With both formats
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->generateAvif()
// With quality control (1-100)
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->generateAvif()
    ->quality(85)           // Original image
    ->qualityWebp(80)       // WebP version
    ->qualityAvif(65)       // AVIF version
// PNG optimization with indexed colors (reduces file size significantly)
InterventionImage::make('Image', 'image')
    ->pngIndexed()                    // Uses default 256 colors
    ->pngIndexed(true, 128)           // Custom color count (2-256)
// Strip metadata (EXIF, IPTC, etc.)
InterventionImage::make('Image', 'image')
    ->stripMetadata()
// Resize images (keeps aspect ratio)
InterventionImage::make('Image', 'image')
    ->maxDimensions(1920, 1080)
// Multiple images
InterventionImage::make('Gallery', 'gallery')
    ->multiple()
    ->generateWebp()
    ->generateAvif()
// Enable logging (disabled by default)
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->logging()
// Queue processing (for large images)
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->queue()
// Queue with custom settings
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->queue(true, 'redis', 'images', 10) // enabled, connection, queue, delay(seconds)
```

Watermark
---------

[](#watermark)

### Available Positions

[](#available-positions)

PositionDescription`top-left`Top left corner`top`Top center`top-right`Top right corner`left`Left center`center`Center`right`Right center`bottom-left`Bottom left corner`bottom`Bottom center`bottom-right`Bottom right corner (default)`custom`Custom X/Y coordinates### Image Watermark

[](#image-watermark)

```
use Povly\MoonshineInterventionImage\Enums\WatermarkPosition;
// Basic image watermark
InterventionImage::make('Image', 'image')
    ->watermarkImage('/path/to/watermark.png')
// With position
InterventionImage::make('Image', 'image')
    ->watermarkImage(
        '/path/to/watermark.png',
        WatermarkPosition::TopLeft
    )
// Full control
InterventionImage::make('Image', 'image')
    ->watermarkImage(
        path: '/path/to/watermark.png',
        position: WatermarkPosition::BottomRight,
        offsetX: 20,         // Offset from position (pixels)
        offsetY: 20,
        opacity: 80,         // 0-100 (default: 100)
        width: 200,          // Resize watermark width (optional)
        height: null,        // Resize watermark height (optional)
        customX: null,       // Custom X position (when position is 'custom')
        customY: null        // Custom Y position (when position is 'custom')
    )
// Custom position
InterventionImage::make('Image', 'image')
    ->watermarkImage(
        path: '/path/to/watermark.png',
        position: WatermarkPosition::Custom,
        customX: 150,
        customY: 100
    )
// Using string position
InterventionImage::make('Image', 'image')
    ->watermarkImage('/path/to/watermark.png', 'top-left')
```

### Text Watermark

[](#text-watermark)

```
use Povly\MoonshineInterventionImage\Enums\WatermarkPosition;
// Basic text watermark
InterventionImage::make('Image', 'image')
    ->watermarkText('© My Site 2025')
// With position
InterventionImage::make('Image', 'image')
    ->watermarkText(
        '© My Site 2025',
        WatermarkPosition::BottomRight
    )
// Full control
InterventionImage::make('Image', 'image')
    ->watermarkText(
        text: '© My Site 2025',
        position: WatermarkPosition::BottomRight,
        offsetX: 20,         // Offset from position (pixels)
        offsetY: 20,
        size: 32,            // Font size (default: 24)
        color: 'ffffff',     // Hex color without # (default: 'ffffff')
        customX: null,       // Custom X position (when position is 'custom')
        customY: null        // Custom Y position (when position is 'custom')
    )
// With custom font
InterventionImage::make('Image', 'image')
    ->watermarkText('© My Site', WatermarkPosition::BottomRight)
    ->watermarkTextFont('/path/to/font.ttf')
// With stroke (text outline)
InterventionImage::make('Image', 'image')
    ->watermarkText('© My Site', WatermarkPosition::BottomRight)
    ->watermarkTextStroke('000000', 2)  // color, width
// With rotation
InterventionImage::make('Image', 'image')
    ->watermarkText('© My Site', WatermarkPosition::Center)
    ->watermarkTextAngle(45)  // degrees
// Using string position
InterventionImage::make('Image', 'image')
    ->watermarkText('© My Site', 'top-left')
```

### Disable Watermark Per Field

[](#disable-watermark-per-field)

```
// Disable watermark for specific field (even if enabled in config)
InterventionImage::make('Image', 'image')
    ->disableWatermark()
```

### Global Watermark via Config

[](#global-watermark-via-config)

Configure watermarks globally for all images:

```
// config/moonshine-intervention-image.php
'watermark' => [
    'enabled' => true,
    'image' => public_path('images/watermark.png'),
    'position' => 'bottom-right',
    'offset_x' => 20,
    'offset_y' => 20,
    'opacity' => 80,
    'width' => 200,
    'height' => null,
],
'watermark_text' => [
    'enabled' => true,
    'text' => '© My Site 2025',
    'font' => public_path('fonts/arial.ttf'),
    'size' => 24,
    'color' => 'ffffff',
    'position' => 'bottom-right',
    'offset_x' => 20,
    'offset_y' => 20,
    'stroke_color' => '000000',
    'stroke_width' => 2,
    'angle' => null,
],
```

Or via `.env`:

```
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_ENABLED=true
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_IMAGE=/full/path/to/watermark.png
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_POSITION=bottom-right
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OFFSET_X=20
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OFFSET_Y=20
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_OPACITY=80
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_ENABLED=true
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT="© My Site 2025"
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_SIZE=24
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_COLOR=ffffff
MOONSHINE_INTERVENTION_IMAGE_WATERMARK_TEXT_POSITION=bottom-right
```

### Offset Behavior

[](#offset-behavior)

Offsets work relative to the position:

Position`offset_x` positive`offset_y` positive`top-left`Moves rightMoves down`top`Moves rightMoves down`top-right`Moves leftMoves down`left`Moves rightMoves down`center`Moves rightMoves down`right`Moves leftMoves down`bottom-left`Moves rightMoves up`bottom`Moves rightMoves up`bottom-right`Moves leftMoves upExample - move watermark away from edges:```
// Move 50px left and 30px up from bottom-right corner
InterventionImage::make('Image', 'image')
    ->watermarkText(
        '© My Site',
        WatermarkPosition::BottomRight,
        offsetX: 50,
        offsetY: 30
    )
```

Queue Processing
----------------

[](#queue-processing)

Process images in the background using Laravel queues. Useful for handling large images or multiple uploads without blocking the user request.

### Enable via Config

[](#enable-via-config)

```
// config/moonshine-intervention-image.php
'queue' => [
    'enabled' => true,
    'connection' => null,     // null = default connection
    'queue' => 'images',
    'delay' => null,          // seconds or Carbon instance
    'tries' => 3,
    'timeout' => 120,
],
```

### Enable via Field Method

[](#enable-via-field-method)

```
// Enable queue with default config settings
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->queue()
// Override queue settings per field
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->queue(true, 'redis', 'high-priority', 5)
// Set only delay
InterventionImage::make('Image', 'image')
    ->generateWebp()
    ->queue()
    ->queueDelay(now()->addMinutes(5))
```

### Queue Job

[](#queue-job)

The `ProcessImage` job handles:

- Image optimization
- WebP conversion
- AVIF conversion
- Watermarks (image and text)
- Automatic retries (3 attempts by default)
- 1 hour retry window
- Exponential backoff (10s, 30s, 60s)

```
# Start queue worker
php artisan queue:work --queue=images
```

Optimize Command
----------------

[](#optimize-command)

The `moonshine:image:optimize` Artisan command allows you to batch-optimize existing images. It scans a storage disk (or specific paths), applies optimization, and optionally generates WebP/AVIF conversions — using settings from your config.

### Basic Usage

[](#basic-usage-1)

```
# Optimize all images on the default disk (from config)
php artisan moonshine:image:optimize

# Optimize specific directories or files (relative to disk root)
php artisan moonshine:image:optimize banners/ uploads/gallery/

# Use a different storage disk
php artisan moonshine:image:optimize --disk=s3
```

### Queue vs Sync

[](#queue-vs-sync)

By default, the command reads `moonshine-intervention-image.queue.enabled` from config. Override with flags:

```
# Force queue processing
php artisan moonshine:image:optimize --queue

# Force synchronous (direct) processing
php artisan moonshine:image:optimize --sync
```

### Apply a Preset

[](#apply-a-preset)

```
php artisan moonshine:image:optimize --preset=gallery
```

### Override Options

[](#override-options)

All processing options can be overridden per run:

```
# Generate WebP and AVIF
php artisan moonshine:image:optimize --generate-webp --generate-avif

# Disable format generation (even if enabled in config)
php artisan moonshine:image:optimize --no-webp --no-avif

# Override quality
php artisan moonshine:image:optimize --quality=75 --quality-webp=70 --quality-avif=55

# Strip EXIF/IPTC metadata
php artisan moonshine:image:optimize --strip-metadata

# Resize images (keeps aspect ratio)
php artisan moonshine:image:optimize --max-width=1200 --max-height=800
```

### Combined Example

[](#combined-example)

```
php artisan moonshine:image:optimize banners/ uploads/ \
    --disk=public \
    --preset=gallery \
    --queue \
    --quality=80 \
    --strip-metadata
```

### Config

[](#config)

```
// config/moonshine-intervention-image.php
'optimize' => [
    'disk' => env('MOONSHINE_INTERVENTION_IMAGE_OPTIMIZE_DISK', 'public'),
    'exclude_paths' => [],  // Paths to skip (relative to disk root)
],
```

`exclude_paths` is an array of directory paths that will be skipped during full-disk scans:

```
'exclude_paths' => [
    'assets/icons',
    'avatars/raw',
],
```

### Command Options

[](#command-options)

OptionDescription`paths`Specific file or directory paths to optimize (positional, optional)`--disk=`Storage disk to scan (default: from config)`--preset=`Apply a named preset from config`--queue`Force queue processing`--sync`Force synchronous processing`--quality=`Override quality for original image (1-100)`--quality-webp=`Override quality for WebP (1-100)`--quality-avif=`Override quality for AVIF (1-100)`--generate-webp`Generate WebP versions`--no-webp`Disable WebP generation`--generate-avif`Generate AVIF versions`--no-avif`Disable AVIF generation`--strip-metadata`Strip EXIF/IPTC metadata`--max-width=`Maximum image width (keeps aspect ratio)`--max-height=`Maximum image height (keeps aspect ratio)Methods
-------

[](#methods)

MethodDescription`preset(string $name)`Apply preset from config`generateWebp(bool $generate = true)`Generate WebP version of the image`generateAvif(bool $generate = true)`Generate AVIF version of the image`quality(int $quality)`Set quality for original image (1-100, default: 85)`qualityWebp(int $quality)`Set quality for WebP (1-100, default: 80)`qualityAvif(int $quality)`Set quality for AVIF (1-100, default: 65)`pngIndexed(bool $indexed = true, int $colors)`Optimize PNG with indexed colors (default: 256)`stripMetadata(bool $strip = true)`Strip EXIF/IPTC metadata from images`maxDimensions(?int $width, ?int $height = null)`Resize images while keeping aspect ratio`watermarkImage(...)`Add image watermark`watermarkText(...)`Add text watermark`watermarkTextFont(?string $fontPath)`Set font for text watermark`watermarkTextStroke(?string $color, int $width)`Add stroke to text watermark`watermarkTextAngle(?int $angle)`Rotate text watermark`disableWatermark(bool $disable = true)`Disable watermark for this field`queue(bool $enabled, ?string $connection, ?string $queue, $delay)`Enable queue processing`queueDelay(...)`Set queue delay`logging(bool $enabled = true)`Enable logging (disabled by default)PNG Optimization
----------------

[](#png-optimization)

PNG is a lossless format, so the `quality` parameter doesn't reduce file size. To optimize PNG files, use the `pngIndexed()` method which converts the image to use a palette of indexed colors (like GIF):

```
InterventionImage::make('Image', 'image')
    ->pngIndexed()           // 256 colors (default)
    ->pngIndexed(true, 128)  // 128 colors - smaller file
    ->pngIndexed(true, 64)   // 64 colors - even smaller
```

This can significantly reduce PNG file size, especially for images with limited colors.

AVIF Support
------------

[](#avif-support)

AVIF provides superior compression compared to WebP and JPEG. Use `qualityAvif()` to control the quality:

```
InterventionImage::make('Image', 'image')
    ->generateAvif()
    ->qualityAvif(65)  // Lower values = smaller files, lower quality
```

Recommended AVIF quality values:

- **50-60**: Maximum compression, acceptable quality for thumbnails
- **60-70**: Good balance between size and quality (default: 65)
- **70-80**: High quality, still smaller than WebP/JPEG **Note**: AVIF requires Imagick or GD with AVIF support compiled in.

Logging
-------

[](#logging)

Enable logging to debug and monitor image processing:

```
// Via field method
InterventionImage::make('Image', 'image')
    ->logging()
// Via config
'default' => [
    'logging' => true,
],
```

Logs will appear in `storage/logs/laravel.log` with `[InterventionImage]` prefix:

```
[InterventionImage] Text watermark applied {"text":"© My Site","position":"bottom-right","offset_x":20,"offset_y":30}
[InterventionImage] Optimized {"path":"...","format":"jpg","before_bytes":186455,"after_bytes":194607,"saved_percent":-4.37}

```

---

Complete Examples
-----------------

[](#complete-examples)

### 1. Simple Usage (without layouts-field)

[](#1-simple-usage-without-layouts-field)

For single and multiple images without the [moonshine/layouts-field](https://github.com/moonshine-software/layouts-field) package.

#### Layout

[](#layout)

Add the `removeImage` JavaScript function to your MoonShine layout:

```