eZPublishCommunityProject  2013.4
eZ\Publish\SPI\Variation\VariationHandler Interface Reference

Interface for Variant services. More...

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

Public Member Functions

 getVariation (Field $field, VersionInfo $versionInfo, $variantName, array $parameters=array())
 Returns a Variant object for $field's $variantName. More...
 

Detailed Description

Interface for Variant services.

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

Member Function Documentation

eZ\Publish\SPI\Variation\VariationHandler::getVariation ( Field  $field,
VersionInfo  $versionInfo,
  $variantName,
array  $parameters = array() 
)

Returns a Variant object for $field's $variantName.

This method is responsible to create the variant if needed. Variants 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$variantName
array$parametersHash of arbitrary parameters useful to generate the variation
Returns

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