Newer
Older
Angie Byron
committed
<?php
/**
* @file
* Contains \Drupal\content_translation\ContentTranslationHandler.
Angie Byron
committed
*/
Alex Pott
committed
namespace Drupal\content_translation;
Angie Byron
committed
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeInterface;
Dries Buytaert
committed
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\LanguageInterface;
Angie Byron
committed
use Drupal\Core\Render\Element;
Angie Byron
committed
/**
* Base class for content translation handlers.
Angie Byron
committed
*
* @ingroup entity_api
Angie Byron
committed
*/
class ContentTranslationHandler implements ContentTranslationHandlerInterface {
Angie Byron
committed
/**
* The type of the entity being translated.
*
* @var string
*/
protected $entityTypeId;
Angie Byron
committed
/**
* Information about the entity type.
Angie Byron
committed
*
Alex Pott
committed
* @var \Drupal\Core\Entity\EntityTypeInterface
Angie Byron
committed
*/
protected $entityType;
Angie Byron
committed
/**
Alex Pott
committed
* Initializes an instance of the content translation controller.
Angie Byron
committed
*
Alex Pott
committed
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
Angie Byron
committed
* The info array of the given entity type.
*/
public function __construct(EntityTypeInterface $entity_type) {
Alex Pott
committed
$this->entityTypeId = $entity_type->id();
$this->entityType = $entity_type;
Angie Byron
committed
}
/**
* {@inheritdoc}
Angie Byron
committed
*/
public function retranslate(EntityInterface $entity, $langcode = NULL) {
$updated_langcode = !empty($langcode) ? $langcode : $entity->language()->id;
Angie Byron
committed
$translations = $entity->getTranslationLanguages();
foreach ($translations as $langcode => $language) {
$entity->translation[$langcode]['outdated'] = $langcode != $updated_langcode;
Angie Byron
committed
}
}
/**
* {@inheritdoc}
Angie Byron
committed
*/
Angie Byron
committed
public function getTranslationAccess(EntityInterface $entity, $op) {
// @todo Move this logic into a translation access control handler checking also
Angie Byron
committed
// the translation language and the given account.
Alex Pott
committed
$entity_type = $entity->getEntityType();
Angie Byron
committed
$translate_permission = TRUE;
// If no permission granularity is defined this entity type does not need an
// explicit translate permission.
$current_user = \Drupal::currentUser();
if (!$current_user->hasPermission('translate any entity') && $permission_granularity = $entity_type->getPermissionGranularity()) {
$translate_permission = $current_user->hasPermission($permission_granularity == 'bundle' ? "translate {$entity->bundle()} {$entity->getEntityTypeId()}" : "translate {$entity->getEntityTypeId()}");
Angie Byron
committed
}
return $translate_permission && $current_user->hasPermission("$op content translations");
Angie Byron
committed
}
/**
* {@inheritdoc}
Angie Byron
committed
*/
Alex Pott
committed
public function getSourceLangcode(FormStateInterface $form_state) {
return isset($form_state['content_translation']['source']) ? $form_state['content_translation']['source']->id : FALSE;
Angie Byron
committed
}
/**
* {@inheritdoc}
Angie Byron
committed
*/
Dries Buytaert
committed
public function entityFormAlter(array &$form, FormStateInterface $form_state, EntityInterface $entity) {
Alex Pott
committed
$form_controller = content_translation_form_controller($form_state);
Angie Byron
committed
$form_langcode = $form_controller->getFormLangcode($form_state);
$entity_langcode = $entity->getUntranslated()->language()->id;
Angie Byron
committed
$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_controller->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 = language_list();
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) {
Angie Byron
committed
$t_args = array('%language' => $languages[$form_langcode]->name, '%title' => $entity->label());
$title = empty($source_langcode) ? $title . ' [' . t('%language translation', $t_args) . ']' : t('Create %language translation of %title', $t_args);
}
catch
committed
$form['#title'] = $title;
Angie Byron
committed
}
// 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',
Angie Byron
committed
'#title' => t('Source language: @language', array('@language' => $languages[$source_langcode]->name)),
'#tree' => TRUE,
'#weight' => -100,
'#multilingual' => TRUE,
'source' => array(
Angie Byron
committed
'#title' => t('Select source language'),
'#title_display' => 'invisible',
Angie Byron
committed
'#type' => 'select',
'#default_value' => $source_langcode,
'#options' => array(),
),
'submit' => array(
'#type' => 'submit',
'#value' => t('Change'),
'#submit' => array(array($this, 'entityFormSourceChange')),
),
);
foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
if (isset($translations[$language->id])) {
$form['source_langcode']['source']['#options'][$language->id] = $language->name;
Angie Byron
committed
}
}
}
// Disable languages for existing translations, so it is not possible to
// switch this node to some language which is already in the translation
// set.
$language_widget = isset($form['langcode']) && $form['langcode']['#type'] == 'language_select';
if ($language_widget && $has_translations) {
$form['langcode']['#options'] = array();
foreach (language_list(LanguageInterface::STATE_CONFIGURABLE) as $language) {
if (empty($translations[$language->id]) || $language->id == $entity_langcode) {
$form['langcode']['#options'][$language->id] = $language->name;
Angie Byron
committed
}
}
}
if ($is_translation) {
if ($language_widget) {
$form['langcode']['#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;
}
}
$form['actions']['delete_translation'] = array(
'#type' => 'submit',
'#value' => t('Delete translation'),
'#weight' => $weight,
'#submit' => array(array($this, 'entityFormDeleteTranslation')),
Angie Byron
committed
'#access' => $this->getTranslationAccess($entity, 'delete'),
Angie Byron
committed
);
}
// 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) {
Alex Pott
committed
$form['content_translation'] = array(
'#type' => 'details',
Angie Byron
committed
'#title' => t('Translation'),
'#tree' => TRUE,
'#weight' => 10,
Angie Byron
committed
'#access' => $this->getTranslationAccess($entity, $source_langcode ? 'create' : 'update'),
Angie Byron
committed
'#multilingual' => TRUE,
);
// A new translation is enabled by default.
$status = $new_translation || $entity->translation[$form_langcode]['status'];
// If there is only one published translation we cannot unpublish it,
// since there would be nothing left to display.
$enabled = TRUE;
if ($status) {
// A new translation is not available in the translation metadata, hence
// it should count as one more.
$published = $new_translation;
// When creating a brand new translation, $entity->translation is not
// set.
if (!$new_translation) {
foreach ($entity->translation as $translation) {
$published += $translation['status'];
}
}
$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.');
Alex Pott
committed
$form['content_translation']['status'] = array(
'#type' => 'checkbox',
'#title' => t('This translation is published'),
'#default_value' => $status,
'#description' => $description,
'#disabled' => !$enabled,
);
$translate = !$new_translation && $entity->translation[$form_langcode]['outdated'];
Angie Byron
committed
if (!$translate) {
Alex Pott
committed
$form['content_translation']['retranslate'] = array(
Angie Byron
committed
'#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 {
Alex Pott
committed
$form['content_translation']['outdated'] = array(
Angie Byron
committed
'#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.'),
);
}
// Default to the anonymous user.
$name = '';
if ($new_translation) {
Angie Byron
committed
$name = \Drupal::currentUser()->getUsername();
}
elseif ($entity->translation[$form_langcode]['uid']) {
$name = user_load($entity->translation[$form_langcode]['uid'])->getUsername();
}
Alex Pott
committed
$form['content_translation']['name'] = array(
'#type' => 'textfield',
'#title' => t('Authored by'),
'#maxlength' => 60,
'#autocomplete_route_name' => 'user.autocomplete',
'#default_value' => $name,
'#description' => t('Leave blank for %anonymous.', array('%anonymous' => \Drupal::config('user.settings')->get('anonymous'))),
);
$date = $new_translation ? REQUEST_TIME : $entity->translation[$form_langcode]['created'];
Alex Pott
committed
$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($date, 'custom', 'Y-m-d H:i:s O'), '%timezone' => format_date($date, 'custom', 'O'))),
'#default_value' => $new_translation ? '' : format_date($date, 'custom', 'Y-m-d H:i:s O'),
);
Angie Byron
committed
if ($language_widget) {
$form['langcode']['#multilingual'] = TRUE;
Angie Byron
committed
}
$form['#process'][] = array($this, 'entityFormSharedElements');
}
// Process the submitted values before they are stored.
$form['#entity_builders'][] = array($this, 'entityFormEntityBuild');
// Handle entity validation.
if (isset($form['actions']['submit'])) {
$form['actions']['submit']['#validate'][] = array($this, 'entityFormValidate');
}
Angie Byron
committed
// Handle entity deletion.
if (isset($form['actions']['delete'])) {
$form['actions']['delete']['#submit'][] = array($this, 'entityFormDelete');
}
}
/**
Angie Byron
committed
* Process callback: determines which elements get clue in the form.
Angie Byron
committed
*
* @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
Angie Byron
committed
*/
Alex Pott
committed
public function entityFormSharedElements($element, FormStateInterface $form_state, $form) {
Angie Byron
committed
static $ignored_types;
// @todo Find a more reliable way to determine if a form element concerns a
// multilingual value.
if (!isset($ignored_types)) {
$ignored_types = array_flip(array('actions', 'value', 'hidden', 'vertical_tabs', 'token', 'details'));
Angie Byron
committed
}
Angie Byron
committed
foreach (Element::children($element) as $key) {
Angie Byron
committed
if (!isset($element[$key]['#type'])) {
Angie Byron
committed
$this->entityFormSharedElements($element[$key], $form_state, $form);
Angie Byron
committed
}
else {
// Ignore non-widget form elements.
if (isset($ignored_types[$element[$key]['#type']])) {
continue;
}
// Elements are considered to be non multilingual by default.
if (empty($element[$key]['#multilingual'])) {
Angie Byron
committed
// If we are displaying a multilingual entity form we need to provide
// translatability clues, otherwise the shared form elements should be
// hidden.
Alex Pott
committed
if (empty($form_state['content_translation']['translation_form'])) {
Angie Byron
committed
$this->addTranslatabilityClue($element[$key]);
}
else {
$element[$key]['#access'] = FALSE;
}
Angie Byron
committed
}
}
}
return $element;
}
/**
* Adds a clue about the form element translatability.
*
* If the given element does not have a #title attribute, the function is
* recursively applied to child elements.
*
* @param array $element
* A form element array.
*/
protected function addTranslatabilityClue(&$element) {
static $suffix, $fapi_title_elements;
// Elements which can have a #title attribute according to FAPI Reference.
if (!isset($suffix)) {
$suffix = ' <span class="translation-entity-all-languages">(' . t('all languages') . ')</span>';
$fapi_title_elements = array_flip(array('checkbox', 'checkboxes', 'date', 'details', 'fieldset', 'file', 'item', 'password', 'password_confirm', 'radio', 'radios', 'select', 'text_format', 'textarea', 'textfield', 'weight'));
Angie Byron
committed
}
// Update #title attribute for all elements that are allowed to have a
// #title attribute according to the Form API Reference. The reason for this
// check is because some elements have a #title attribute even though it is
// not rendered, e.g. field containers.
if (isset($element['#type']) && isset($fapi_title_elements[$element['#type']]) && isset($element['#title'])) {
$element['#title'] .= $suffix;
}
// If the current element does not have a (valid) title, try child elements.
Angie Byron
committed
elseif ($children = Element::children($element)) {
Angie Byron
committed
foreach ($children as $delta) {
$this->addTranslatabilityClue($element[$delta], $suffix);
}
}
// If there are no children, fall back to the current #title attribute if it
// exists.
elseif (isset($element['#title'])) {
$element['#title'] .= $suffix;
}
}
/**
* Entity builder method.
*
* @param string $entity_type
* The type of the entity.
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose form is being built.
*
* @see \Drupal\content_translation\ContentTranslationHandler::entityFormAlter()
Angie Byron
committed
*/
Dries Buytaert
committed
public function entityFormEntityBuild($entity_type, EntityInterface $entity, array $form, FormStateInterface $form_state) {
Alex Pott
committed
$form_controller = content_translation_form_controller($form_state);
Angie Byron
committed
$form_langcode = $form_controller->getFormLangcode($form_state);
if (!isset($entity->translation[$form_langcode])) {
$entity->translation[$form_langcode] = array();
Angie Byron
committed
}
Alex Pott
committed
$values = $form_state->getValue('content_translation', array());
$translation = &$entity->translation[$form_langcode];
Angie Byron
committed
// @todo Use the entity setter when all entities support multilingual
// properties.
Dries Buytaert
committed
$translation['uid'] = !empty($values['name']) && ($account = user_load_by_name($values['name'])) ? $account->id() : 0;
$translation['status'] = !empty($values['status']);
$translation['created'] = !empty($values['created']) ? strtotime($values['created']) : REQUEST_TIME;
$translation['changed'] = REQUEST_TIME;
Angie Byron
committed
$source_langcode = $this->getSourceLangcode($form_state);
if ($source_langcode) {
$translation['source'] = $source_langcode;
}
$translation['outdated'] = !empty($values['outdated']);
Angie Byron
committed
if (!empty($values['retranslate'])) {
$this->retranslate($entity, $form_langcode);
}
// Set contextual information that can be reused during the storage phase.
// @todo Remove this once translation metadata are converted to regular
// fields.
$attributes = \Drupal::request()->attributes;
$attributes->set('source_langcode', $source_langcode);
Angie Byron
committed
}
/**
* Form validation handler for ContentTranslationHandler::entityFormAlter().
Alex Pott
committed
* Validates the submitted content translation metadata.
*/
Dries Buytaert
committed
function entityFormValidate($form, FormStateInterface $form_state) {
Alex Pott
committed
if (!$form_state->isValueEmpty('content_translation')) {
$translation = $form_state->getValue('content_translation');
// Validate the "authored by" field.
if (!empty($translation['name']) && !($account = user_load_by_name($translation['name']))) {
Angie Byron
committed
form_set_error('content_translation][name', $form_state, t('The translation authoring username %name does not exist.', array('%name' => $translation['name'])));
}
// Validate the "authored on" field.
if (!empty($translation['created']) && strtotime($translation['created']) === FALSE) {
Angie Byron
committed
form_set_error('content_translation][created', $form_state, t('You have to specify a valid translation authoring date.'));
}
}
}
Angie Byron
committed
/**
* Form submission handler for ContentTranslationHandler::entityFormAlter().
Angie Byron
committed
*
* Takes care of the source language change.
*/
Dries Buytaert
committed
public function entityFormSourceChange($form, FormStateInterface $form_state) {
Alex Pott
committed
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller->getEntity();
Alex Pott
committed
$source = $form_state->getValue(array('source_langcode', 'source'));
$entity_type_id = $entity->getEntityTypeId();
$form_state->setRedirect('content_translation.translation_add_' . $entity_type_id, array(
$entity_type_id => $entity->id(),
'source' => $source,
'target' => $form_controller->getFormLangcode($form_state),
));
Angie Byron
committed
$languages = language_list();
drupal_set_message(t('Source language set to: %language', array('%language' => $languages[$source]->name)));
}
/**
* Form submission handler for ContentTranslationHandler::entityFormAlter().
Angie Byron
committed
*
* Takes care of entity deletion.
*/
Dries Buytaert
committed
function entityFormDelete($form, FormStateInterface $form_state) {
Alex Pott
committed
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller->getEntity();
Angie Byron
committed
if (count($entity->getTranslationLanguages()) > 1) {
drupal_set_message(t('This will delete all the translations of %label.', array('%label' => $entity->label())), 'warning');
}
}
/**
* Form submission handler for ContentTranslationHandler::entityFormAlter().
Angie Byron
committed
*
Alex Pott
committed
* Takes care of content translation deletion.
Angie Byron
committed
*/
Dries Buytaert
committed
function entityFormDeleteTranslation($form, FormStateInterface $form_state) {
Alex Pott
committed
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller->getEntity();
$entity_type_id = $entity->getEntityTypeId();
$form_state->setRedirect('content_translation.translation_delete_' . $entity_type_id, array(
$entity_type_id => $entity->id(),
'language' => $form_controller->getFormLangcode($form_state),
));
Angie Byron
committed
}
/**
* Returns the title to be used for the entity form page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity whose form is being altered.
*/
protected function entityFormTitle(EntityInterface $entity) {
return $entity->label();
}
}