1. interface
  2. Drupal
  3. \
  4. content_translation
  5. \
  6. ContentTranslationHandlerInterface

ContentTranslationHandlerInterface

interface ContentTranslationHandlerInterface (View source)

Interface for providing content translation.

Defines a set of methods to allow any entity to be processed by the entity translation UI.

Methods

FieldDefinitionInterface[]
getFieldDefinitions()

Returns a set of field definitions to be used to store metadata items.

AccessResultInterface
getTranslationAccess(EntityInterface $entity, $op)

Checks if the user can perform the given operation on translations of the wrapped entity.

string
getSourceLangcode(FormStateInterface $form_state)

Retrieves the source language for the translation being created.

retranslate(EntityInterface $entity, string $langcode = NULL)

Marks translations as outdated.

entityFormAlter(array $form, FormStateInterface $form_state, EntityInterface $entity)

Performs the needed alterations to the entity form.

Details

at line 21
FieldDefinitionInterface[] getFieldDefinitions()

Returns a set of field definitions to be used to store metadata items.

Return Value

FieldDefinitionInterface[]

at line 38
AccessResultInterface getTranslationAccess(EntityInterface $entity, $op)

Checks if the user can perform the given operation on translations of the wrapped entity.

Parameters

EntityInterface $entity

The entity whose translation has to be accessed.
$op

The operation to be performed on the translation. Possible values are:

  • "create"
  • "update"
  • "delete"

Return Value

AccessResultInterface

The access result.

at line 49
string getSourceLangcode(FormStateInterface $form_state)

Retrieves the source language for the translation being created.

Parameters

FormStateInterface $form_state

The current state of the form.

Return Value

string

The source language code.

at line 60
retranslate(EntityInterface $entity, string $langcode = NULL)

Marks translations as outdated.

Parameters

EntityInterface $entity

The entity being translated.
string $langcode

(optional) The language code of the updated language: all the other translations will be marked as outdated. Defaults to the entity language.

at line 72
entityFormAlter(array $form, FormStateInterface $form_state, EntityInterface $entity)

Performs the needed alterations to the entity form.

Parameters

array $form

The entity form to be altered to provide the translation workflow.
FormStateInterface $form_state

The current state of the form.
EntityInterface $entity

The entity being created or edited.