Spatie Image Optimizer

https://github.com/spatie/image-optimizer
Admin
A PHP package that optimizes images (PNG, JPG, WEBP, AVIF, SVG, GIF) by running them through a chain...
Tokens:26,286
Snippets:310
Trust Score:10
License:MIT
Update:5 months ago
Show doc for...
Tokens:
Raw
### Configuration Array Example Structure

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/types.md

An example demonstrating the structure of the configuration array used for creating an OptimizerChain.

```php
[
    'Spatie\ImageOptimizer\Optimizers\Jpegoptim' => ['-m85', '--strip-all'],
    'Spatie\ImageOptimizer\Optimizers\Optipng' => ['-i0', '-o2'],
    'quality' => 80,
]
```

--------------------------------

### Install Package via Composer

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Install the spatie/image-optimizer package using Composer.

```bash
composer require spatie/image-optimizer
```

--------------------------------

### Optimizer Interface: getCommand Example (Svgo)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

This example shows the expected output format for the getCommand method when used with Svgo, including binary path, options, and escaped image path.

```text
"/usr/bin/svgo" --input='/path/to/chart.svg' --output='/path/to/chart.svg'
```

--------------------------------

### Install Optimizers on Ubuntu/Debian

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Install all supported image optimization binaries on Ubuntu or Debian systems using apt-get and npm.

```bash
sudo apt-get install jpegoptim
sudo apt-get install optipng
sudo apt-get install pngquant
sudo npm install -g svgo
sudo apt-get install gifsicle
sudo apt-get install webp
sudo apt-get install libavif-bin # minimum 0.9.3
```

--------------------------------

### Optimizer Interface: getCommand Example (Jpegoptim)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

This example shows the expected output format for the getCommand method when used with Jpegoptim, including binary path, options, and escaped image path.

```text
"/path/to/jpegoptim" -m85 --strip-all --all-progressive '/path/to/image.jpg'
```

--------------------------------

### Create Default Optimizer Chain

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Instantiate a default optimizer chain that includes all supported optimizers. This is the simplest way to get started.

```php
// Default (all optimizers)
$chain = OptimizerChainFactory::create();
```

--------------------------------

### Install Optimizers on Fedora/RHEL/CentOS

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Install all supported image optimization binaries on Fedora, RHEL, or CentOS systems using dnf and npm.

```bash
sudo dnf install epel-release
sudo dnf install jpegoptim
sudo dnf install optipng
sudo dnf install pngquant
sudo npm install -g svgo
sudo dnf install gifsicle
sudo dnf install libwebp-tools
sudo dnf install libavif-tools
```

--------------------------------

### Optimizer Interface: setOptions Method Example

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Instantiate an optimizer with command-line options. Each option in the array becomes a separate argument to the command.

```php
$optimizer = new Jpegoptim(['-m85', '--strip-all', '--all-progressive']);
```

--------------------------------

### Checking for Optimizer Binary Installation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/errors.md

This function checks if a given optimizer binary is installed and accessible in the system's PATH. It uses the `which` command to locate the binary. This is useful for verifying prerequisites before attempting optimization.

```php
function isOptimizerInstalled(string $binaryName): bool {
    $command = "which {$binaryName} 2>/dev/null";
    $output = shell_exec($command);
    return !empty($output);
}

if (!isOptimizerInstalled('jpegoptim')) {
    // Install jpegoptim or inform user
}
```

--------------------------------

### Install Optimizers on MacOS

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Install all supported image optimization binaries on MacOS using Homebrew and npm.

```bash
brew install jpegoptim
brew install optipng
brew install pngquant
npm install -g svgo
brew install gifsicle
brew install webp
brew install libavif
```

--------------------------------

### Optimizer Interface: getTmpPath Example (Avifenc)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

This example demonstrates how to handle temporary files created by an optimizer like Avifenc. The OptimizerChain deletes the temporary file after optimization.

```php
$tmpPath = $optimizer->getTmpPath();
if ($tmpPath && file_exists($tmpPath)) {
    unlink($tmpPath);
}
```

--------------------------------

### Image Conversion Example using Spatie/Image

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

This snippet demonstrates how to load an image, resize it, and save it in different formats using the spatie/image package. It's a prerequisite for optimizing images with image-optimizer.

```php
Spatie\Image\Image::load('original.jpg')
    ->width(2048)
    ->save('image.jpg'); // image.png, image.webp, image.avif
```

--------------------------------

### Create OptimizerChain with Default Optimizers

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChainFactory.md

Use this when you need an OptimizerChain with all default optimizers and their standard configurations. No setup is required beyond calling the static method.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$optimizerChain = OptimizerChainFactory::create();
$optimizerChain->optimize('/path/to/image.jpg');
```

--------------------------------

### Configure JPG, PNG, and Optipng Optimizers

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Provides a custom configuration for Jpegoptim, Pngquant, and Optipng, specifying options for each. This example shows how to optimize JPG and PNG images with specific settings.

```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;
use Spatie\ImageOptimizer\Optimizers\Pngquant;
use Spatie\ImageOptimizer\Optimizers\Optipng;

$config = [
    Jpegoptim::class => [
        '-m85',
        '--force',
        '--strip-all',
        '--all-progressive',
    ],
    Pngquant::class => [
        '--quality=85',
        '--force',
    ],
    Optipng::class => [
        '-i0',
        '-o2',
        '-quiet',
    ],
];

$chain = OptimizerChainFactory::create($config);
$chain->optimize('/path/to/image.jpg'); // Uses Jpegoptim
$chain->optimize('/path/to/image.png'); // Uses Pngquant + Optipng
// GIF, WebP, AVIF, SVG images are skipped
```

--------------------------------

### Optimize to a New File

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/INDEX.md

This example shows how to optimize an image and save the result to a different file, preserving the original image. Specify both the input and output paths in the optimize method.

```php
$chain = OptimizerChainFactory::create();
$chain->optimize('/original.jpg', '/output.jpg');
```

--------------------------------

### Common Imports for Image Optimization

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/INDEX.md

Import the most frequently used classes for image optimization tasks. This setup is common for starting with the library.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Image;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;
use Spatie\ImageOptimizer\Optimizers\Optipng;
```

--------------------------------

### Create Custom Optimization Chain

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Customize the chain of optimizers by adding `Optimizer`s manually to an `OptimizerChain`. This example uses only `optipng` and `jpegoptim` with specific options passed to their constructors.

```php
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;
use Spatie\ImageOptimizer\Optimizers\Pngquant;

$optimizerChain = (new OptimizerChain)
   ->addOptimizer(new Jpegoptim([
       '--strip-all',
       '--all-progressive',
   ]))

   ->addOptimizer(new Pngquant([
       '--force',
   ]));
```

--------------------------------

### Set Optimizer Timeout

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

You can set the maximum time in seconds that each individual optimizer in a chain can use by calling `setTimeout`. In this example, each optimizer gets a maximum of 10 seconds.

```php
$optimizerChain
    ->setTimeout(10)
    ->optimize($pathToImage);
```

--------------------------------

### Get Full Command for Optimizer Execution

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Constructs and returns the complete shell command required to run the optimizer. This includes the binary path, options, and the escaped image path.

```php
$optimizer = new Jpegoptim(['-m85', '--strip-all']);
$optimizer->setImagePath('/var/www/images/photo.jpg');
echo $optimizer->getCommand();
// Output: "jpegoptim" -m85 --strip-all '/var/www/images/photo.jpg'
```

--------------------------------

### Implementing a Custom PSR-3 Logger

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/errors.md

This example shows how to create a custom logger that implements the PSR-3 LoggerInterface to capture detailed information during the optimization process. It includes methods for logging informational and error messages, which can be directed to various outputs like the console.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Psr\Log\LoggerInterface;

class DebugLogger implements LoggerInterface {
    public function error($message, array $context = []): void {
        echo "ERROR: $message\n";
        // Could also log to file, send alert, etc.
    }
    
    public function info($message, array $context = []): void {
        echo "INFO: $message\n";
    }
    
    // ... other PSR-3 methods as no-ops
}

$chain = OptimizerChainFactory::create();
$chain->useLogger(new DebugLogger());
$chain->optimize('/path/to/image.jpg');

// Output might include:
// INFO: Start optimizing /path/to/image.jpg
// INFO: Using optimizer: `Spatie\ImageOptimizer\Optimizers\Jpegoptim`
// INFO: Executing `"jpegoptim" -m85 --strip-all --all-progressive '/path/to/image.jpg'`
// INFO: Process successfully ended with output ``
```

--------------------------------

### Replace DummyLogger with a Real Logger

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/DummyLogger.md

Shows how to replace the default DummyLogger with a PSR-3 compliant logger, such as Monolog, to enable actual logging. Logs will be directed to stdout in this example.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$log = new Logger('optimizer');
$log->pushHandler(new StreamHandler('php://stdout'));

$chain = OptimizerChainFactory::create();
$chain->useLogger($log);
$chain->optimize('/path/to/image.jpg');
// Logs will be written to stdout
```

--------------------------------

### Handling Missing Optimizer Binaries

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/errors.md

This snippet illustrates how the optimizer chain behaves when a required binary is missing. The optimizer is skipped, and if no optimizers are available, the image remains unmodified. This allows for partial installations.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$chain = OptimizerChainFactory::create();

// If jpegoptim is not installed, the Jpegoptim optimizer will be skipped
// If ALL optimizers are missing, the image is not modified
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### Detecting Optimization Failures by Size

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/errors.md

This example shows how to detect potential optimization failures by comparing the original image size with the optimized image size. If the optimized size is not smaller than the original, it suggests that the optimization may have failed or was ineffective.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$inputPath = '/path/to/image.jpg';
$outputPath = '/path/to/optimized.jpg';

$originalSize = filesize($inputPath);

$chain = OptimizerChainFactory::create();
$chain->optimize($inputPath, $outputPath);

$optimizedSize = filesize($outputPath);

if ($optimizedSize >= $originalSize) {
    // Optimization likely failed or didn't reduce size
}
```

--------------------------------

### Get Image Path

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Retrieves the file system path of the image as provided to the constructor.

```php
$image = new Image('/var/www/images/photo.jpg');
echo $image->path(); // /var/www/images/photo.jpg
```

--------------------------------

### Optimizer Interface: canHandle Method (Jpegoptim)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Implement this method to check if the optimizer can process a given image, typically by verifying the image's MIME type. This example is for Jpegoptim.

```php
public function canHandle(Image $image): bool {
    return $image->mime() === 'image/jpeg';
}
```

--------------------------------

### BaseOptimizer Methods

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Abstract base class implementing the `Optimizer` interface with common functionality. Provides methods for setting binary path, image path, options, and getting the command.

```APIDOC
## BaseOptimizer Methods

### Description
Abstract base class implementing the `Optimizer` interface with common functionality.

### Methods
- `__construct($options = [])`
- `binaryName(): string`
- `setBinaryPath(string $binaryPath): self`
- `setImagePath(string $imagePath): self`
- `setOptions(array $options = []): self`
- `getCommand(): string`
- `getTmpPath(): ?string`

### Usage
```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85', '--strip-all']);
$optimizer->setImagePath('/path/to/image.jpg');
echo $optimizer->getCommand();
```
```

--------------------------------

### Optimizer Interface: canHandle Method (Svgo)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Implement this method to check if the optimizer can process a given image, typically by verifying the image's MIME type and extension. This example is for Svgo, which handles SVG images.

```php
public function canHandle(Image $image): bool {
    if ($image->extension() !== 'svg') {
        return false;
    }
    return in_array($image->mime(), [
        'text/html',
        'image/svg',
        'image/svg+xml',
        'text/plain',
    ]);
}
```

--------------------------------

### Instantiate and Configure BaseOptimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Create a concrete optimizer, set its image path, and retrieve the command to be executed. Subclasses like Jpegoptim must define their binary name.

```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85', '--strip-all']);
$optimizer->setImagePath('/path/to/image.jpg');
echo $optimizer->getCommand();
```

--------------------------------

### Get Image MIME Type

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Determines and returns the MIME type of the image by inspecting its contents using the fileinfo extension. Requires the 'fileinfo' PHP extension to be installed.

```php
$image = new Image('/var/www/images/photo.jpg');
echo $image->mime(); // image/jpeg

$svgImage = new Image('/var/www/images/chart.svg');
echo $svgImage->mime(); // image/svg+xml (or text/html, text/plain depending on SVG type)
```

--------------------------------

### Instantiate Cwebp Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Cwebp optimizer with compression and quality settings.

```php
use Spatie\ImageOptimizer\Optimizers\Cwebp;

$optimizer = new Cwebp(['-m 6', '-pass 10', '-mt', '-q 90']);
```

--------------------------------

### Get Current Optimizers

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChain.md

Retrieves the array of all optimizers currently configured in the chain. Useful for inspection or debugging.

```php
$chain = new OptimizerChain();
$optimizers = $chain->getOptimizers();
echo count($optimizers); // 0 (empty chain)
```

--------------------------------

### Instantiate Optipng Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Optipng optimizer with specific optimization levels.

```php
use Spatie\ImageOptimizer\Optimizers\Optipng;

$optimizer = new Optipng(['-i0', '-o2']);
```

--------------------------------

### Instantiate Pngquant Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Pngquant optimizer with quality and force options.

```php
use Spatie\ImageOptimizer\Optimizers\Pngquant;

$optimizer = new Pngquant(['--quality=85', '--force']);
```

--------------------------------

### Instantiate Jpegoptim Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Initializes the Jpegoptim optimizer with specific command-line options. These options are passed directly to the jpegoptim binary.

```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85', '--strip-all', '--all-progressive']);
```

--------------------------------

### Image Methods

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Represents an image file and provides utilities for determining its type. Used to interact with image files and get their properties.

```APIDOC
## Image Methods

### Description
Represents an image file and provides utilities for determining its type.

### Methods
- `__construct(string $pathToImage)` — Throws `InvalidArgumentException` if file invalid
- `path(): string`
- `extension(): string`
- `mime(): string`

### Usage
```php
use Spatie\ImageOptimizer\Image;

$image = new Image('/path/to/image.jpg');
echo $image->mime(); // image/jpeg
```
```

--------------------------------

### Get Image Extension

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Returns the file extension in lowercase, without the leading dot. This method uses pathinfo() and converts the result to lowercase for consistency.

```php
$image = new Image('/var/www/images/photo.JPG');
echo $image->extension(); // jpg

$image2 = new Image('/var/www/images/image.SVG');
echo $image2->extension(); // svg
```

--------------------------------

### Instantiate Svgo Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Svgo optimizer with no default options.

```php
use Spatie\ImageOptimizer\Optimizers\Svgo;

$optimizer = new Svgo([]);
```

--------------------------------

### Optimize an Image with Error Handling

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Demonstrates how to optimize an image and catch potential invalid argument exceptions. Optimizer process failures are logged but not thrown.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

try {
    $chain = OptimizerChainFactory::create();
    $chain->optimize('/path/to/image.jpg');
} catch (InvalidArgumentException $e) {
    // Handle file not found or copy error
    echo "Error: " . $e->getMessage();
}

// Optimizer process failures are only logged, not thrown

```

--------------------------------

### Create and Use Optimizer Chain

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Instantiate an OptimizerChain and add specific optimizers to it. Then, use the chain to optimize an image file.

```php
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$chain = new OptimizerChain();
$chain->addOptimizer(new Jpegoptim(['-m85']));
$chain->optimize($pathToImage);
```

--------------------------------

### Instantiate Avifenc Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Avifenc optimizer with constant quality and multithreading options.

```php
use Spatie\ImageOptimizer\Optimizers\Avifenc;

$optimizer = new Avifenc([
    '-a cq-level=23',
    '-j all',
    // ... other options
]);
```

--------------------------------

### Constructor

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChain.md

Creates a new OptimizerChain instance. It initializes with no optimizers and a default DummyLogger.

```APIDOC
## Constructor

Creates a new `OptimizerChain` with no optimizers and a `DummyLogger` as the default logger. No parameters required.

### Signature

```php
public function __construct()
```

### Examples

```php
use Spatie\ImageOptimizer\OptimizerChain;

$chain = new OptimizerChain();
```
```

--------------------------------

### Factory Instantiation (Recommended)

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Use OptimizerChainFactory to create a pre-configured optimizer chain with default settings. This is the recommended approach for most use cases.

```APIDOC
## Factory Instantiation (Recommended)

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$chain = OptimizerChainFactory::create();
$chain->optimize($pathToImage);
```

Creates a chain with all seven optimizers using default configurations.
```

--------------------------------

### BaseOptimizer Constructor

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Initializes the optimizer with command-line options. Subclasses must define a $binaryName property.

```APIDOC
## BaseOptimizer Constructor

### Description
Initializes the optimizer with options. Subclasses must define a `$binaryName` property.

### Parameters
#### Parameters
- **`$options`** (array) - Optional - `[]` - Array of command-line option strings to pass to the binary.

### Examples
```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85', '--strip-all', '--all-progressive']);
```
```

--------------------------------

### Instantiate Image Class

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Creates a new Image instance for a given file path. The constructor validates file existence, supported protocols (file://), and correct Windows drive letter recognition.

```php
use Spatie\ImageOptimizer\Image;

$image = new Image('/path/to/image.jpg');
```

--------------------------------

### Instantiate Jpegoptim Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Jpegoptim optimizer with custom quality settings.

```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85']);
```

--------------------------------

### Basic Optimizer Chain Usage

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Demonstrates the fundamental usage of an OptimizerChain by adding JPEG and PNG optimizers and then optimizing an image.

```php
$chain = new OptimizerChain();
$chain->addOptimizer($jpegOptimizer);
$chain->addOptimizer($pngOptimizer);
$chain->optimize($imagePath);
```

--------------------------------

### Run Tests

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Execute the test suite for the image-optimizer package using Composer.

```bash
composer test
```

--------------------------------

### Create OptimizerChain Instance

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChain.md

Instantiate a new OptimizerChain. This creates an empty chain with a default logger.

```php
use Spatie\ImageOptimizer\OptimizerChain;

$chain = new OptimizerChain();
```

--------------------------------

### Create Optimizer Chain with Quality Setting

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Create an optimizer chain and set a global quality parameter for JPEG, WebP, and AVIF images. The default quality varies by image type.

```php
$chain = OptimizerChainFactory::create(['quality' => 75]);
```

--------------------------------

### Instantiate Gifsicle Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate the Gifsicle optimizer with batch mode and optimization level.

```php
use Spatie\ImageOptimizer\Optimizers\Gifsicle;

$optimizer = new Gifsicle(['-b', '-O3']);
```

--------------------------------

### Basic Optimizer Configuration

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Shows a basic configuration array for the optimizer chain, including JPEG quality and specific optimizer options.

```php
[
    'quality' => 85,  // 0-100, applied to JPEG/WebP/AVIF
    'Spatie\ImageOptimizer\Optimizers\Jpegoptim' => ['-m85', ...],
    // ... other optimizer class => options mappings
]
```

--------------------------------

### Create Optimizer Chain with Aggressive Compression

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Instantiate an optimizer chain with aggressive quality settings (e.g., quality 60) for smaller file sizes. Also sets a shorter timeout for faster processing.

```php
$chain = OptimizerChainFactory::create(['quality' => 60]);
$chain->setTimeout(20); // Faster processing
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### setOptions

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Sets the command-line options to pass to the binary. Options are provided as an array of strings.

```APIDOC
## setOptions

### Description

Sets the command-line options to pass to the binary.

### Method

`setOptions(array $options = []): self`

### Parameters

#### Path Parameters

- **$options** (array) - Optional - Default: `[]` - An array of command-line option strings (e.g., `['-m85', '--strip-all']`).

### Return Type

`self` — The optimizer instance for method chaining.

### Description

Options are typically provided by `OptimizerChainFactory` or directly when instantiating an optimizer. Each element in the array becomes a separate argument to the command.

### Examples

```php
$optimizer = new Jpegoptim(['-m85', '--strip-all', '--all-progressive']);
```
```

--------------------------------

### Optimize Image (Save to New Path)

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

To keep the original image, pass a second argument to `optimize` which specifies the output path. The package will not modify the original image.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$optimizerChain = OptimizerChainFactory::create();

$optimizerChain->optimize($pathToImage, $pathToOutput);
```

--------------------------------

### Create Optimizer Chain for High Quality Output

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Create an optimizer chain prioritizing high quality output (e.g., quality 95). This is suitable when visual fidelity is more important than file size reduction.

```php
$chain = OptimizerChainFactory::create(['quality' => 95]);
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### Create Default Optimizer Chain with Factory

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Use the OptimizerChainFactory to create a pre-configured optimizer chain with all default optimizers. This is the recommended approach for general use.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$chain = OptimizerChainFactory::create();
$chain->optimize($pathToImage);
```

--------------------------------

### Optimizer Interface: binaryName Method

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Implement this method to return the name of the command-line binary for the optimizer. The OptimizerChain handles path prepending and escaping.

```php
public function binaryName(): string {
    return 'jpegoptim';
}
```

--------------------------------

### Create Optimizer Chain with Configuration

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Use OptimizerChainFactory to create a preconfigured OptimizerChain instance. Pass an array of configuration options to customize the optimizers.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$chain = OptimizerChainFactory::create(['quality' => 85]);
```

--------------------------------

### getCommand

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Returns the complete shell command to execute for this optimizer, properly escaped and formatted.

```APIDOC
## getCommand

### Description

Returns the complete shell command to execute for this optimizer.

### Method

`getCommand(): string`

### Return Type

`string` — A complete command string ready for shell execution via `Process::fromShellCommandline()`.

### Description

The command must be properly escaped and formatted. The image path must be properly shell-escaped using `escapeshellarg()` to prevent shell injection. The binary name should be quoted if a binary path is set.

### Examples

```php
// Expected output from Jpegoptim::getCommand():
// "/path/to/jpegoptim" -m85 --strip-all --all-progressive '/path/to/image.jpg'

// Expected output from Svgo::getCommand():
// "/usr/bin/svgo" --input='/path/to/chart.svg' --output='/path/to/chart.svg'
```
```

--------------------------------

### Create OptimizerChain with Custom Quality Setting

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChainFactory.md

Use this to create an OptimizerChain with default optimizers but override the default quality setting for JPG and WEBP images. This is useful for enforcing a specific compression level across supported formats.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$optimizerChain = OptimizerChainFactory::create(['quality' => 75]);
$optimizerChain->optimize('/path/to/image.jpg');
```

--------------------------------

### Instantiate DummyLogger

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/DummyLogger.md

Create a new instance of the DummyLogger. This is the default logger used by OptimizerChain.

```php
use Spatie\ImageOptimizer\DummyLogger;

$logger = new DummyLogger();
```

--------------------------------

### Configure Custom Optimizers

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Specify exactly which optimizers to use and their command-line options. This allows for fine-grained control over the optimization process for specific image types.

```php
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$config = [
    Jpegoptim::class => ['-m85', '--strip-all'],
];

$chain = OptimizerChainFactory::create($config);
```

--------------------------------

### Basic Optimizer Chain Usage

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

Instantiate OptimizerChain, add specific optimizers with their options, and then optimize an image. The DummyLogger can be used to disable logging.

```php
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$chain = new OptimizerChain();
$chain->addOptimizer(new Jpegoptim(['-m85']));
$chain->optimize('/path/to/image.jpg');
```

```php
use Spatie\ImageOptimizer\DummyLogger;

$logger = new DummyLogger();
$chain->useLogger($logger); // Disables logging
```

--------------------------------

### Create OptimizerChain with Custom Optimizers and Options

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChainFactory.md

Use this to create an OptimizerChain with a specific selection of optimizers and fine-tune their individual options. This provides maximum control over the optimization process for specific needs.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;
use Spatie\ImageOptimizer\Optimizers\Optipng;

$config = [
    Jpegoptim::class => [
        '-m85',
        '--force',
        '--strip-all',
        '--all-progressive',
    ],
    Optipng::class => [
        '-i0',
        '-o2',
        '-quiet',
    ],
];

$optimizerChain = OptimizerChainFactory::create($config);
$optimizerChain->optimize('/path/to/image.jpg');
```

--------------------------------

### Define a Custom Optimizer Interface

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Implement this interface to create your own image optimizer using a command-line utility. It defines methods for binary name, handling images, setting paths and options, and generating the command.

```php
namespace Spatie\ImageOptimizer\Optimizers;

use Spatie\ImageOptimizer\Image;

interface Optimizer
{
    /**
     * Returns the name of the binary to be executed.
     *
     * @return string
     */
    public function binaryName(): string;

    /**
     * Determines if the given image can be handled by the optimizer.
     *
     * @param \Spatie\ImageOptimizer\Image $image
     *
     * @return bool
     */
    public function canHandle(Image $image): bool;

    /**
     * Set the path to the image that should be optimized.
     *
     * @param string $imagePath
     *
     * @return $this
     */
    public function setImagePath(string $imagePath);

    /**
     * Set the options the optimizer should use.
     *
     * @param array $options
     *
     * @return $this
     */
    public function setOptions(array $options = []);

    /**
     * Get the command that should be executed.
     *
     * @return string
     */
    public function getCommand(): string;
}
```

--------------------------------

### Create Optimizer Chain with Custom Quality

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Create an optimizer chain with a specific quality setting for relevant optimizers. This allows fine-tuning the compression level.

```php
// Custom quality
$chain = OptimizerChainFactory::create(['quality' => 75]);
```

--------------------------------

### Optimize Image with Logging Enabled

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Integrate a PSR-3 compliant logger to capture optimization process details. This is helpful for debugging and monitoring the optimization steps.

```php
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$log = new Logger('optimizer');
$log->pushHandler(new StreamHandler('php://stdout'));

$chain = OptimizerChainFactory::create();
$chain->useLogger($log);
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### Cwebp Optimizer Implementation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Extends BaseOptimizer for WebP image optimization using the cwebp command-line tool. It specifies default options for compression and quality.

```php
class Cwebp extends BaseOptimizer
{
    public $binaryName = 'cwebp';

    public function canHandle(Image $image): bool
    {
        return $image->mime() === 'image/webp';
    }

    public function getCommand(): string
    {
        // Output: "cwebp" <options> '<imagePath>' -o '<imagePath>'
    }
}
```

--------------------------------

### Direct Instantiation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/README.md

Instantiate OptimizerChain directly to have full control over the selection and configuration of optimizers. This allows for custom optimization chains.

```APIDOC
## Direct Instantiation

```php
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$chain = new OptimizerChain();
$chain->addOptimizer(new Jpegoptim(['-m85']));
$chain->optimize($pathToImage);
```

Allows full control over optimizer selection and configuration.
```

--------------------------------

### Enable Logging for Image Optimization

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Integrate a PSR-3 compliant logger with the OptimizerChain to monitor the optimization process. This will log which optimizers are used, the commands executed, and their output.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$optimizerChain = OptimizerChainFactory::create();

$optimizerChain
   ->useLogger(new MyLogger())
   ->optimize($pathToImage);
```

--------------------------------

### Image Constructor

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Creates an Image instance for a file path. It validates that the file exists and uses a supported protocol (file://).

```APIDOC
## Image Constructor

### Description

Creates an `Image` instance for a file path. Validates that the file exists and uses a supported protocol.

### Signature

```php
public function __construct(string $pathToImage)
```

### Parameters

#### Path Parameters

- **$pathToImage** (string) - Required - Absolute or relative file path to the image. Must exist and use the `file://` protocol (or local path).

### Throws

- **InvalidArgumentException** - If the file does not exist, the path uses an unsupported protocol, or the filename is invalid.

### Description

The constructor validates that:
- The file at `$pathToImage` exists on the filesystem
- The protocol is `file://` (local files only; remote URLs are not supported)
- Windows drive letters (e.g., `C:\path\to\file`) are correctly recognized as local paths

### Examples

```php
use Spatie\ImageOptimizer\Image;

$image = new Image('/path/to/image.jpg');
```
```

--------------------------------

### Default Optipng Configuration

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Presents the default configuration for Optipng, which uses lossless compression for PNG images. These settings are applied after Pngquant.

```php
[
    '-i0',
    '-o2',
    '-quiet',
]
```

--------------------------------

### Set Up Logger for Optimizer Chain

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Configure a Monolog logger and attach it to the optimizer chain to log optimization processes. This is useful for debugging and monitoring.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$log = new Logger('optimizer');
$log->pushHandler(new StreamHandler('php://stdout'));

$chain = OptimizerChainFactory::create();
$chain->useLogger($log);
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### Build and Use Optimizer Chain Manually

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/quick-start.md

Manually construct an OptimizerChain, add specific optimizers with their configurations, and then execute the optimization. This provides maximum control over the optimization process.

```php
$chain = new OptimizerChain();
$chain->addOptimizer(new Jpegoptim(['-m85']));
$chain->setTimeout(30);
$chain->useLogger($myLogger);
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### DummyLogger Constructor

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/DummyLogger.md

Initializes a new instance of the DummyLogger. This constructor requires no parameters.

```APIDOC
## DummyLogger Constructor

### Description
Initializes a new instance of the DummyLogger. This constructor requires no parameters.

### Signature
```php
public function __construct()
```

### Usage Example
```php
use Spatie\ImageOptimizer\DummyLogger;

$logger = new DummyLogger();
```
```

--------------------------------

### setOptions Method

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Sets the command-line options for the optimizer. Allows dynamic modification of optimizer parameters.

```APIDOC
## setOptions

### Description
Sets the command-line options for the optimizer.

### Method Signature
```php
public function setOptions(array $options = []): self
```

### Parameters
#### Parameters
- **`$options`** (array) - Optional - `[]` - Array of option strings.

### Return Type
`self` — The optimizer instance for method chaining.
```

--------------------------------

### Pngquant Optimizer Implementation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Extends BaseOptimizer for lossy PNG optimization with pngquant. It handles PNG images and defines the command structure, including the use of the --output flag.

```php
class Pngquant extends BaseOptimizer
{
    public $binaryName = 'pngquant';

    public function canHandle(Image $image): bool
    {
        return $image->mime() === 'image/png';
    }

    public function getCommand(): string
    {
        // Output: "pngquant" <options> '<imagePath>' --output='<imagePath>'
    }
}
```

--------------------------------

### Default Usage with OptimizerChain

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/DummyLogger.md

Demonstrates how DummyLogger is used by default when creating an OptimizerChain via OptimizerChainFactory. No log output is produced.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$chain = OptimizerChainFactory::create();
// DummyLogger is automatically set here
$chain->optimize('/path/to/image.jpg');
// No log output
```

--------------------------------

### Configure Custom Binary Path for Optimizer

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Specify a custom directory for optimizer binaries when they are not in the system's default PATH. This ensures the correct executables are found and used.

```php
use Spatie\ImageOptimizer\OptimizerChain;
use Spatie\ImageOptimizer\Optimizers\Jpegoptim;

$optimizer = new Jpegoptim(['-m85']);
$optimizer->setBinaryPath('/usr/local/bin/');

$chain = new OptimizerChain();
$chain->addOptimizer($optimizer);
$chain->optimize('/path/to/image.jpg');
```

--------------------------------

### Optipng Optimizer Implementation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Extends BaseOptimizer to handle PNG optimization using the optipng command-line tool. It checks if the image MIME type is 'image/png'.

```php
class Optipng extends BaseOptimizer
{
    public $binaryName = 'optipng';

    public function canHandle(Image $image): bool
    {
        return $image->mime() === 'image/png';
    }
}
```

--------------------------------

### path Method

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Image.md

Returns the file system path to the image.

```APIDOC
## path Method

### Description

Returns the file system path to the image.

### Signature

```php
public function path(): string
```

### Return Type

`string` — The exact path provided to the constructor.

### Examples

```php
$image = new Image('/var/www/images/photo.jpg');
echo $image->path(); // /var/www/images/photo.jpg
```
```

--------------------------------

### Logging Optimizer Errors with Monolog

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/errors.md

This snippet demonstrates how to set up a Monolog logger to capture error messages from the optimizer chain. It shows how to push a stream handler to log to standard output. If an optimizer fails (e.g., due to missing binaries), the error will be logged.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$log = new Logger('optimizer');
$log->pushHandler(new StreamHandler('php://stdout'));

$chain = OptimizerChainFactory::create();
$chain->useLogger($log);
$chain->optimize('/path/to/image.jpg');

// If jpegoptim is not installed:
// - Process will fail
// - Error is logged: "Process errored with `...`"
// - No exception is thrown
// - Image remains unchanged
```

--------------------------------

### Avifenc Optimizer Implementation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Extends BaseOptimizer for AVIF image optimization using avifenc. This implementation involves a two-step process: decoding to PNG and then re-encoding to AVIF, with specific handling for PHP versions.

```php
class Avifenc extends BaseOptimizer
{
    public $binaryName = 'avifenc';
    public $decodeBinaryName = 'avifdec';

    public function canHandle(Image $image): bool
    {
        if (version_compare(PHP_VERSION, '8.1.0', '<')) {
            return $image->extension() === 'avif';
        }
        return $image->mime() === 'image/avif';
    }

    public function getCommand(): string
    {
        // Two-step process: decode to PNG, then re-encode to AVIF
        // Output: "avifdec" <options> '<imagePath>' '<tmpPath>.png' && "avifenc" <options> '<tmpPath>.png' '<imagePath>'
    }
}
```

--------------------------------

### Create Optimizer Chain with Custom Quality

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Creates an optimizer chain with a globally specified quality setting. This affects JPG, WebP, and AVIF optimizers.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

// Custom quality setting
$chain = OptimizerChainFactory::create(['quality' => 75]);
```

--------------------------------

### Optipng

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Optimizes PNG images using the `optipng` command-line tool. It is configured to handle images with the MIME type `image/png` and uses specific default options for optimization.

```APIDOC
## Optipng

### Description
Optimizes PNG images using the `optipng` command-line tool. This optimizer is specifically designed for PNG files and applies a set of default optimization options.

### MIME Type
`image/png`

### Default Options
- `-i0`: Non-interlaced output
- `-o2`: Optimization level 2 (multiple IDAT trials)
- `-quiet`: Suppress output
```

--------------------------------

### Configure Custom SVG and WebP Optimization

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Set up an optimizer chain to specifically process SVG and WebP images with custom parameters. This allows fine-grained control over optimization for specific formats.

```php
use Spatie\ImageOptimizer\Optimizers\Svgo;
use Spatie\ImageOptimizer\Optimizers\Cwebp;

$config = [
    Svgo::class => [],
    Cwebp::class => ['-m 6', '-pass 10', '-mt', '-q 85'],
];

$chain = OptimizerChainFactory::create($config);
```

--------------------------------

### optimize

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChain.md

Executes all configured optimizers sequentially against a specified image file. Optionally saves the output to a different file.

```APIDOC
## optimize

Executes all optimizers in the chain against an image file.

### Signature

```php
public function optimize(string $pathToImage, ?string $pathToOutput = null): void
```

### Parameters

#### Path Parameters

- **pathToImage** (string) - Required - Absolute or relative path to the image file to optimize.
- **pathToOutput** (string|null) - Optional - If provided, the optimized image is written to this path instead of overwriting the original.

### Return Type

`void` — No return value.

### Throws

- **InvalidArgumentException** - If `$pathToImage` does not exist, is not a valid file path, or if `$pathToOutput` is provided but the file cannot be copied.
```

--------------------------------

### Optimize Image with Logging and Timeout

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/OptimizerChain.md

Configures the optimizer chain to use a Monolog logger for output and sets a specific timeout in seconds for the optimization process. This is useful for monitoring optimization progress and preventing excessively long operations.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;
use Monolog\Logger;
use Monolog\Handlers\StreamHandler;

$log = new Logger('optimizer');
$log->pushHandler(new StreamHandler('php://stdout'));

$chain = OptimizerChainFactory::create();
$chain
    ->useLogger($log)
    ->setTimeout(20)
    ->optimize('/path/to/image.jpg');
```

--------------------------------

### Optimize an Image

Source: https://github.com/spatie/image-optimizer/blob/main/README.md

Instantiate the optimizer chain and use it to optimize a given image path. The original image will be overwritten with an optimized version.

```php
use Spatie\ImageOptimizer\OptimizerChainFactory;

$optimizerChain = OptimizerChainFactory::create();

$optimizerChain->optimize($pathToImage);
```

--------------------------------

### Default Pngquant Configuration

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Displays the default configuration for Pngquant, which includes quality and force options. This is used for lossy compression of PNG images.

```php
[
    '--quality=' . ($config['quality'] ?? 85),
    '--force',
]
```

--------------------------------

### Pngquant

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Provides lossy PNG optimization using the `pngquant` command-line tool. It's often used before `Optipng` for further compression and supports PNG images.

```APIDOC
## Pngquant

### Description
Performs lossy PNG optimization using the `pngquant` command-line tool. This optimizer is suitable for PNG files and can be used in conjunction with other optimizers like `Optipng`. It uses the `--output=` flag to overwrite the original file.

### MIME Type
`image/png`

### Default Options
- `--quality=85`: Quality level (configurable via `quality` config)
- `--force`: Force overwrite
```

--------------------------------

### binaryName

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/Optimizer.md

Returns the name of the command-line binary to be executed. This should be just the command name without any path or extension.

```APIDOC
## binaryName

### Description

Returns the name of the command-line binary to be executed.

### Method

`binaryName(): string`

### Return Type

`string` — The name of the executable (e.g., `jpegoptim`, `optipng`, `svgo`).

### Description

This should return just the command name without any path or extension. The `OptimizerChain` may prepend a binary path and shell escaping.

### Examples

```php
// In Jpegoptim implementation:
public function binaryName(): string {
    return 'jpegoptim';
}
```
```

--------------------------------

### binaryName Method

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Returns the name of the binary to execute. Subclasses must define the $binaryName property.

```APIDOC
## binaryName

### Description
Subclasses must define the `$binaryName` property. This method returns it.

### Method Signature
```php
public function binaryName(): string
```

### Return Type
`string` — The value of the `$binaryName` property.
```

--------------------------------

### setBinaryPath Method

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Sets the directory path to the optimizer binary. Useful if the binary is not in the system PATH.

```APIDOC
## setBinaryPath

### Description
If the binary is not in the system `PATH`, you can specify a custom directory. The method automatically adds a trailing directory separator if needed.

### Method Signature
```php
public function setBinaryPath(string $binaryPath): self
```

### Parameters
#### Parameters
- **`$binaryPath`** (string) - Required - Directory path to prepend to the binary name.

### Return Type
`self` — The optimizer instance for method chaining.

### Examples
```php
$optimizer = new Jpegoptim(['-m85']);
$optimizer->setBinaryPath('/usr/local/bin');
// Will execute: "/usr/local/bin/jpegoptim" -m85 '/path/to/image.jpg'
```
```

--------------------------------

### Svgo Optimizer Implementation

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/api-reference/BaseOptimizer.md

Extends BaseOptimizer for SVG optimization with the svgo tool. It supports multiple MIME types and uses --input and --output flags for file handling.

```php
class Svgo extends BaseOptimizer
{
    public $binaryName = 'svgo';

    public function canHandle(Image $image): bool
    {
        if ($image->extension() !== 'svg') {
            return false;
        }

        return in_array($image->mime(), [
            'text/html',
            'image/svg',
            'image/svg+xml',
            'text/plain',
        ]);
    }

    public function getCommand(): string
    {
        // Output: "svgo" <options> --input='<imagePath>' --output='<imagePath>'
    }
}
```

--------------------------------

### DummyLogger Methods

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/module-reference.md

No-operation PSR-3 logger. Serves as the default logger for `OptimizerChain` when no specific logger is provided.

```APIDOC
## DummyLogger Methods

### Description
No-operation PSR-3 logger. Default logger for `OptimizerChain`.

### Methods
- `emergency($message, array $context = []): void`
- `alert($message, array $context = []): void`
- `critical($message, array $context = []): void`
- `error($message, array $context = []): void`
- `warning($message, array $context = []): void`
- `notice($message, array $context = []): void`
- `info($message, array $context = []): void`
- `debug($message, array $context = []): void`
- `log($level, $message, array $context = []): void`

All methods are no-ops (do nothing).

### Usage
```php
use Spatie\ImageOptimizer\DummyLogger;

$logger = new DummyLogger();
$chain->useLogger($logger); // Disables logging
```
```

--------------------------------

### Set Quality to 95

Source: https://github.com/spatie/image-optimizer/blob/main/_autodocs/configuration.md

Demonstrates setting the global quality to the highest level (95) for maximum image quality.

```php
// Set quality to 95 (highest quality)
$chain = OptimizerChainFactory::create(['quality' => 95]);
```
Tokens:
Raw