MultiLanguageDescription
MultiLanguageDescription.php
:
18
Interface
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¶
getDescription()
¶
MultiLanguageDescription.php
:
44
Return the human readable description of the domain object in a given language.
|
|
|
- If $languageCode is defined, return if available, otherwise null
- If not, pick it using prioritized language (if provided to api on object retrieval), otherwise in main language
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $languageCode | string|null | null | - |
Return values
string|null
The description for a given language, or null if $languageCode is not set or does not exist.
getDescriptions()
¶
MultiLanguageDescription.php
:
30
Return the human readable description in all provided languages.
|
|
|
The structure of the return value is:
array( 'eng' => '<description_eng>', 'de' => '<description_de>' );
Return values
array<string|int, string>