# elgentos/magento2-imgproxy-prismic-support

> Integration between Elgentos Imgproxy and Prismic IO modules for Magento 2

`composer require elgentos/magento2-imgproxy-prismic-support`

Canonical URL: https://packagento.com/elgentos/magento2-imgproxy-prismic-support

## At a glance

- **Vendor**: elgentos (https://packagento.com/elgentos.md)
- **Latest version**: 1.0.1 — released 2026-05-12
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/elgentos/magento2-imgproxy-prismic-support and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require elgentos/magento2-imgproxy-prismic-support:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Integration between Elgentos Imgproxy and Prismic IO modules for Magento 2

## README

Integration module that connects the [elgentos/magento2-imgproxy](https://github.com/elgentos/magento2-imgproxy) and the [elgentos/magento2-prismicio](https://github.com/elgentos/magento2-prismicio) extensions for Magento 2.

### What it does

Automatically transforms Prismic CDN image URLs through imgproxy before rendering, with the main goal of Prismic API usage reduction.

These are also benefits, but these are also handled by Prismic (which uses Imgix internally);
- On-the-fly image optimization
- Responsive image sizing
- Format conversion (WebP, AVIF)
- Bandwidth savings

### Requirements

- PHP 8.3+
- Magento 2.4+
- `elgentos/magento2-imgproxy` - installed and configured
- `elgentos/module-prismicio` - installed and configured

### Installation

```bash
composer require elgentos/magento2-imgproxy-prismic-support
bin/magento setup:upgrade
bin/magento cache:flush
```

### Configuration

No additional configuration needed. The module:
1. Respects imgproxy enable/disable setting
2. Automatically detects Prismic image blocks
3. Transforms URLs before rendering

### Scope

**Supported:**
- Standalone Prismic Image blocks (`Elgentos\PrismicIO\Block\Dom\Image`)

**Not supported:**
- Images embedded in RichText blocks (different rendering pipeline)

### How it works

The module uses a BEFORE plugin that:

1. Intercepts `Elgentos\PrismicIO\Block\Dom\Image::fetchDocumentView()` before it renders the HTML
2. Checks if imgproxy is enabled
3. Retrieves the image context (URL, width, height)
4. Transforms the URL through imgproxy's `getCustomUrl()` method
5. Modifies the context URL in-place
6. Allows the original method to proceed with the transformed URL

This ensures all standalone Prismic images are optimized through imgproxy without any template modifications.

### Troubleshooting

#### Images not transforming

1. Verify imgproxy module is enabled and configured:
   ```bash
   bin/magento module:status | grep Imgproxy
   ```

2. Check if imgproxy is enabled in system configuration:
   - Admin > Stores > Configuration > Imgproxy > General > Enabled

3. Check logs for transformation errors:
   ```bash
   tail -f var/log/system.log | grep IMGPROXY-PRISMIC
   ```

#### Inspect rendered HTML

To verify URL transformation is working:

```html
<!-- Before (original Prismic URL): -->
<img src="https://images.prismic.io/example/image.jpg" alt="..." width="800" height="600" />

<!-- After (imgproxy transformed URL): -->
<img src="https://imgproxy.example.com/[signature]/resize:fit:800:600/plain/https://images.prismic.io/example/image.jpg" alt="..." width="800" height="600" />
```

#### Enable debug logging

The module logs all transformations and errors with the `[IMGPROXY-PRISMIC]` prefix. Errors are logged at the ERROR level, so check:

```bash
grep IMGPROXY-PRISMIC var/log/system.log
```

### Architecture

- **Plugin Type:** BEFORE
- **Target:** `Elgentos\PrismicIO\Block\Dom\Image::fetchDocumentView()`
- **Dependencies:** Config and Image model from `elgentos/magento2-imgproxy`

The BEFORE plugin intercepts the method before HTML rendering, allowing clean URL transformation by reference modification of the context object.

### License

MIT

### Support

For issues or feature requests, please contact info@elgentos.nl

## Recent Versions

| Version | Released |
|---|---|
| 1.0.1 | 2026-05-12 |
| 1.0.0 | 2026-01-19 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| elgentos/magento2-imgproxy | * |
| elgentos/module-prismicio | * |
| magento/framework | * |
| php | ^8.3 |

## Quality

Latest release (1.0.1) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | 1 | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 |  |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | 58 | – | – |
| 2.4.8 | – | 58 | 58 | – |
| 2.4.9 | – | – | 61 | 61 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["elgentos/magento2-imgproxy-prismic-support"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

elgentos is a Magento 2 vendor on Packagento. See https://packagento.com/elgentos.md for their full catalogue.