Interface

eZ\Publish\SPI\Repository\Values\MultiLanguageDescription

interface MultiLanguageDescription

This is the interface for all ValueObjects implementing translated description logic.

Provides a uniform way for API consuming logic to generate translated description labels for API objects.

Methods

string[] getDescriptions()

Return the human readable description in all provided languages.

string|null getDescription(string|null $languageCode = null)

Return the human readable description of the domain object in a given language.

Details

at line 29
public string[] getDescriptions()

Return the human readable description in all provided languages.

The structure of the return value is: array( 'eng' => '', 'de' => '' );

Return Value

string[]

at line 43
public string|null getDescription(string|null $languageCode = null)

Return the human readable description of the domain object in a given language.

Parameters

string|null $languageCode

Return Value

string|null The description for a given language, or null if $languageCode is not set or does not exist.