Exponential 5.x Kernel 7.5.40 Exponential New Stack (Symfony-based) Kernel — PHP Class Reference

Public Member Functions | List of all members
eZ\Publish\SPI\Variation\VariationHandler Interface Reference

Interface for Variation services. More...

Inheritance diagram for eZ\Publish\SPI\Variation\VariationHandler:

## Public Member Functions
| getVariation (Field $field, VersionInfo $versionInfo, $variationName, array $parameters=[])
| Returns a Variation object for $field's $variationName. More...

## Detailed Description

Interface for Variation services.

A variation service allows to generate variation from a given content field/version info (i.e. image aliases, variations of a document - doc, pdf...).

Definition at line 17 of file VariationHandler.php.

## Member Function Documentation

## ◆ getVariation()

eZ\Publish\SPI\Variation\VariationHandler::getVariation | ( | Field | $field,
|  | VersionInfo | $versionInfo,
|  |  | $variationName,
|  | array | $parameters = `[]`
| ) |  |

Returns a Variation object for $field's $variationName.

This method is responsible to create the variation if needed. Variations might be applicable for images (aliases), documents...

Parameters

  \eZ\Publish\API\Repository\Values\Content\Field | $field |
  \eZ\Publish\API\Repository\Values\Content\VersionInfo | $versionInfo |
  string | $variationName |
  array | $parameters | Hash of arbitrary parameters useful to generate the variation

Returns
  \eZ\Publish\SPI\Variation\Values\Variation

Implemented in eZ\Bundle\EzPublishCoreBundle\Imagine\ImageAsset\AliasGenerator, and eZ\Bundle\EzPublishCoreBundle\Imagine\Cache\AliasGeneratorDecorator.

The documentation for this interface was generated from the following file:

- VariationHandler.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.