1. class
  2. Drupal
  3. \
  4. content_translation
  5. \
  6. ContentTranslationMetadataWrapper

ContentTranslationMetadataWrapper

class ContentTranslationMetadataWrapper implements ContentTranslationMetadataWrapperInterface (View source)

Base class for content translation metadata wrappers.

Properties

protected FieldableEntityInterface|TranslatableInterface $translation

The wrapped entity translation.
protected ContentTranslationHandlerInterface $handler

The content translation handler.

Methods

__construct(EntityInterface $translation, ContentTranslationHandlerInterface $handler)

Initializes an instance of the content translation metadata handler.

string
getSource()

Retrieves the source language for this translation.

$this
setSource(string $source)

Sets the source language for this translation.

bool
isOutdated()

Returns the translation outdated status.

$this
setOutdated(bool $outdated)

Sets the translation outdated status.

UserInterface
getAuthor()

Returns the translation author.

$this
setAuthor(UserInterface $account)

Sets the translation author.

bool
isPublished()

Returns the translation published status.

$this
setPublished(bool $published)

Sets the translation published status.

int
getCreatedTime()

Returns the translation creation timestamp.

$this
setCreatedTime(int $timestamp)

Sets the translation creation timestamp.

int
getChangedTime()

Returns the timestamp of the last entity change from current translation.

$this
setChangedTime(int $timestamp)

Sets the translation modification timestamp.

setFieldOnlyIfTranslatable(string $field_name, mixed $value)

Updates a field value, only if the field is translatable.

Details

at line 35
__construct(EntityInterface $translation, ContentTranslationHandlerInterface $handler)

Initializes an instance of the content translation metadata handler.

Parameters

EntityInterface $translation

The entity translation to be wrapped.
ContentTranslationHandlerInterface $handler

The content translation handler.

at line 43
string getSource()

Retrieves the source language for this translation.

Return Value

string

The source language code.

at line 50
$this setSource(string $source)

Sets the source language for this translation.

Parameters

string $source

The source language code.

Return Value

$this

at line 58
bool isOutdated()

Returns the translation outdated status.

Return Value

bool

TRUE if the translation is outdated, FALSE otherwise.

at line 65
$this setOutdated(bool $outdated)

Sets the translation outdated status.

Parameters

bool $outdated

TRUE if the translation is outdated, FALSE otherwise.

Return Value

$this

at line 73
UserInterface getAuthor()

Returns the translation author.

Return Value

UserInterface

The user entity for the translation author.

at line 80
$this setAuthor(UserInterface $account)

Sets the translation author.

The metadata field will be updated, only if it's translatable.

Parameters

UserInterface $account

The translation author user entity.

Return Value

$this

at line 89
bool isPublished()

Returns the translation published status.

Return Value

bool

TRUE if the translation is published, FALSE otherwise.

at line 97
$this setPublished(bool $published)

Sets the translation published status.

The metadata field will be updated, only if it's translatable.

Parameters

bool $published

TRUE if the translation is published, FALSE otherwise.

Return Value

$this

at line 106
int getCreatedTime()

Returns the translation creation timestamp.

Return Value

int

The UNIX timestamp of when the translation was created.

at line 114
$this setCreatedTime(int $timestamp)

Sets the translation creation timestamp.

The metadata field will be updated, only if it's translatable.

Parameters

int $timestamp

The UNIX timestamp of when the translation was created.

Return Value

$this

at line 123
int getChangedTime()

Returns the timestamp of the last entity change from current translation.

Return Value

int

The timestamp of the last entity save operation.

at line 130
$this setChangedTime(int $timestamp)

Sets the translation modification timestamp.

The metadata field will be updated, only if it's translatable.

Parameters

int $timestamp

The UNIX timestamp of when the translation was last modified.

Return Value

$this

at line 144
protected setFieldOnlyIfTranslatable(string $field_name, mixed $value)

Updates a field value, only if the field is translatable.

Parameters

string $field_name

The name of the field.
mixed $value

The field value to be set.