MENU
Edit
In Place Editing Advanced Editing

ContentTranslationHandler::entityFormAlter

public ContentTranslationHandler::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.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

\Drupal\Core\Entity\EntityInterface $entity: The entity being created or edited.

Overrides ContentTranslationHandlerInterface::entityFormAlter

File

core/modules/content_translation/src/ContentTranslationHandler.php, line 266

Class

ContentTranslationHandler
Base class for content translation handlers.

Namespace

Drupal\content_translation

Code

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
public function entityFormAlter(array &$form, FormStateInterface $form_state, EntityInterface $entity) {
  $form_object = $form_state->getFormObject();
  $form_langcode = $form_object->getFormLangcode($form_state);
  $entity_langcode = $entity->getUntranslated()->language()->getId();
  $source_langcode = $this->getSourceLangcode($form_state);
 
  $new_translation = !empty($source_langcode);
  $translations = $entity->getTranslationLanguages();
  if ($new_translation) {
    // Make sure a new translation does not appear as existing yet.
    unset($translations[$form_langcode]);
  }
  $is_translation = !$form_object->isDefaultFormLangcode($form_state);
  $has_translations = count($translations) > 1;
 
  // Adjust page title to specify the current language being edited, if we
  // have at least one translation.
  $languages = $this->languageManager->getLanguages();
  if (isset($languages[$form_langcode]) && ($has_translations || $new_translation)) {
    $title = $this->entityFormTitle($entity);
    // When editing the original values display just the entity label.
    if ($form_langcode != $entity_langcode) {
      $t_args = array('%language' => $languages[$form_langcode]->getName(), '%title' => $entity->label(), '@title' => $title);
      $title = empty($source_langcode) ? t('@title [%language translation]', $t_args) : t('Create %language translation of %title', $t_args);
    }
    $form['#title'] = $title;
  }
 
  // Display source language selector only if we are creating a new
  // translation and there are at least two translations available.
  if ($has_translations && $new_translation) {
    $form['source_langcode'] = array(
      '#type' => 'details',
      '#title' => t('Source language: @language', array('@language' => $languages[$source_langcode]->getName())),
      '#tree' => TRUE,
      '#weight' => -100,
      '#multilingual' => TRUE,
      'source' => array(
        '#title' => t('Select source language'),
        '#title_display' => 'invisible',
        '#type' => 'select',
        '#default_value' => $source_langcode,
        '#options' => array(),
      ),
      'submit' => array(
        '#type' => 'submit',
        '#value' => t('Change'),
        '#submit' => array(array($this, 'entityFormSourceChange')),
      ),
    );
    foreach ($this->languageManager->getLanguages() as $language) {
      if (isset($translations[$language->getId()])) {
        $form['source_langcode']['source']['#options'][$language->getId()] = $language->getName();
      }
    }
  }
 
  // Locate the language widget.
  $langcode_key = $this->entityType->getKey('langcode');
  if (isset($form[$langcode_key])) {
    $language_widget = &$form[$langcode_key];
  }
 
  // If we are editing the source entity, limit the list of languages so that
  // it is not possible to switch to a language for which a translation
  // already exists. Note that this will only work if the widget is structured
  // like \Drupal\Core\Field\Plugin\Field\FieldWidget\LanguageSelectWidget.
  if (isset($language_widget['widget'][0]['value']) && !$is_translation && $has_translations) {
    $language_select = &$language_widget['widget'][0]['value'];
    if ($language_select['#type'] == 'language_select') {
      $options = array();
      foreach ($this->languageManager->getLanguages() as $language) {
        // Show the current language, and the languages for which no
        // translation already exists.
        if (empty($translations[$language->getId()]) || $language->getId() == $entity_langcode) {
          $options[$language->getId()] = $language->getName();
        }
      }
      $language_select['#options'] = $options;
    }
  }
  if ($is_translation) {
    if (isset($language_widget)) {
      $language_widget['widget']['#access'] = FALSE;
    }
 
    // Replace the delete button with the delete translation one.
    if (!$new_translation) {
      $weight = 100;
      foreach (array('delete', 'submit') as $key) {
        if (isset($form['actions'][$key]['weight'])) {
          $weight = $form['actions'][$key]['weight'];
          break;
        }
      }
      $access = $this->getTranslationAccess($entity, 'delete')->isAllowed() || ($entity->access('delete') && $this->entityType->hasLinkTemplate('delete-form'));
      $form['actions']['delete_translation'] = array(
        '#type' => 'submit',
        '#value' => t('Delete translation'),
        '#weight' => $weight,
        '#submit' => array(array($this, 'entityFormDeleteTranslation')),
        '#access' => $access,
      );
    }
 
    // Always remove the delete button on translation forms.
    unset($form['actions']['delete']);
  }
 
  // We need to display the translation tab only when there is at least one
  // translation available or a new one is about to be created.
  if ($new_translation || $has_translations) {
    $form['content_translation'] = array(
      '#type' => 'details',
      '#title' => t('Translation'),
      '#tree' => TRUE,
      '#weight' => 10,
      '#access' => $this->getTranslationAccess($entity, $source_langcode ? 'create' : 'update')->isAllowed(),
      '#multilingual' => TRUE,
    );
 
    // A new translation is enabled by default.
    $metadata = $this->manager->getTranslationMetadata($entity);
    $status = $new_translation || $metadata->isPublished();
    // If there is only one published translation we cannot unpublish it,
    // since there would be nothing left to display.
    $enabled = TRUE;
    if ($status) {
      $published = 0;
      foreach ($entity->getTranslationLanguages() as $langcode => $language) {
        $published += $this->manager->getTranslationMetadata($entity->getTranslation($langcode))
          ->isPublished();
      }
      $enabled = $published > 1;
    }
    $description = $enabled ?
      t('An unpublished translation will not be visible without translation permissions.') :
      t('Only this translation is published. You must publish at least one more translation to unpublish this one.');
 
    $form['content_translation']['status'] = array(
      '#type' => 'checkbox',
      '#title' => t('This translation is published'),
      '#default_value' => $status,
      '#description' => $description,
      '#disabled' => !$enabled,
    );
 
    $translate = !$new_translation && $metadata->isOutdated();
    if (!$translate) {
      $form['content_translation']['retranslate'] = array(
        '#type' => 'checkbox',
        '#title' => t('Flag other translations as outdated'),
        '#default_value' => FALSE,
        '#description' => t('If you made a significant change, which means the other translations should be updated, you can flag all translations of this content as outdated. This will not change any other property of them, like whether they are published or not.'),
      );
    }
    else {
      $form['content_translation']['outdated'] = array(
        '#type' => 'checkbox',
        '#title' => t('This translation needs to be updated'),
        '#default_value' => $translate,
        '#description' => t('When this option is checked, this translation needs to be updated. Uncheck when the translation is up to date again.'),
      );
      $form['content_translation']['#open'] = TRUE;
    }
 
    // Default to the anonymous user.
    $uid = 0;
    if ($new_translation) {
      $uid = $this->currentUser->id();
    }
    elseif (($account = $metadata->getAuthor()) && $account->id()) {
      $uid = $account->id();
    }
    $form['content_translation']['uid'] = array(
      '#type' => 'entity_autocomplete',
      '#title' => t('Authored by'),
      '#target_type' => 'user',
      '#default_value' => User::load($uid),
      // Validation is done by static::entityFormValidate().
      '#validate_reference' => FALSE,
      '#maxlength' => 60,
      '#description' => t('Leave blank for %anonymous.', array('%anonymous' => \Drupal::config('user.settings')->get('anonymous'))),
    );
 
    $date = $new_translation ? REQUEST_TIME : $metadata->getCreatedTime();
    $form['content_translation']['created'] = array(
      '#type' => 'textfield',
      '#title' => t('Authored on'),
      '#maxlength' => 25,
      '#description' => t('Format: %time. The date format is YYYY-MM-DD and %timezone is the time zone offset from UTC. Leave blank to use the time of form submission.', array('%time' => format_date(REQUEST_TIME, 'custom', 'Y-m-d H:i:s O'), '%timezone' => format_date(REQUEST_TIME, 'custom', 'O'))),
      '#default_value' => $new_translation || !$date ? '' : format_date($date, 'custom', 'Y-m-d H:i:s O'),
    );
 
    if (isset($language_widget)) {
      $language_widget['#multilingual'] = TRUE;
    }
 
    $form['#process'][] = array($this, 'entityFormSharedElements');
  }
 
  // Process the submitted values before they are stored.
  $form['#entity_builders'][] = array($this, 'entityFormEntityBuild');
 
  // Handle entity validation.
  $form['#validate'][] = array($this, 'entityFormValidate');
 
  // Handle entity deletion.
  if (isset($form['actions']['delete'])) {
    $form['actions']['delete']['#submit'][] = array($this, 'entityFormDelete');
  }
 
  // Handle entity form submission before the entity has been saved.
  foreach (Element::children($form['actions']) as $action) {
    if (isset($form['actions'][$action]['#type']) && $form['actions'][$action]['#type'] == 'submit') {
      array_unshift($form['actions'][$action]['#submit'], [$this, 'entityFormSubmit']);
    }
  }
}
doc_Drupal
doc_Drupal
2025-01-10 15:47:30
Comments
Leave a Comment

Please login to continue.