class LingotekSettingsContentSingleForm in Lingotek Translation 8.2
Same name and namespace in other branches
- 4.0.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.0.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.1.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.2.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.3.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.4.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.5.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.6.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.7.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- 3.8.x src/Form/LingotekSettingsContentSingleForm.php \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
Configure Lingotek
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\lingotek\Form\LingotekConfigFormBase
- class \Drupal\lingotek\Form\LingotekSettingsContentSingleForm
- class \Drupal\lingotek\Form\LingotekConfigFormBase
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of LingotekSettingsContentSingleForm
1 string reference to 'LingotekSettingsContentSingleForm'
File
- src/
Form/ LingotekSettingsContentSingleForm.php, line 16
Namespace
Drupal\lingotek\FormView source
class LingotekSettingsContentSingleForm extends LingotekConfigFormBase {
protected $profile_options;
protected $profiles;
protected $bundles;
protected $translatable_bundles;
protected $entity_type_id = NULL;
protected $bundle_id = NULL;
/**
* {@inheritdoc}
*/
public function getFormID() {
return 'lingotek.settings_content_single_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $entity_type = NULL, $bundle = NULL) {
$this->entity_type_id = $entity_type;
$this->bundle_id = $bundle;
/** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
$lingotek_config = \Drupal::service('lingotek.configuration');
$entity_type_definitions = \Drupal::entityTypeManager()
->getDefinitions();
// Get the profiles
$this
->retrieveProfileOptions();
// Retrieve bundles
$this
->retrieveBundles();
// Retrieve translatable bundles
$this
->retrieveTranslatableBundles();
$form['parent_details'] = [
'#type' => 'details',
'#title' => t('Translate Content Entities'),
'#open' => TRUE,
];
$form['parent_details']['list']['#type'] = 'container';
$form['parent_details']['list']['#attributes']['class'][] = 'entity-meta';
$entity_key = 'entity-' . $entity_type;
/** @var \Drupal\lingotek\Moderation\LingotekModerationFactoryInterface $moderationFactory */
$moderationFactory = \Drupal::service('lingotek.moderation_factory');
/** @var \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface $moderationForm */
$moderationForm = $moderationFactory
->getModerationSettingsForm();
$bundle_label = $entity_type_definitions[$entity_type]
->getBundleLabel();
$header = [
$this
->t('Enable'),
$bundle_label,
$this
->t('Translation Profile'),
'moderation' => $moderationForm
->getColumnHeader(),
$this
->t('Fields'),
];
if (!$moderationForm
->needsColumn($entity_type)) {
unset($header['moderation']);
}
$table = [
'#type' => 'table',
'#header' => $header,
'#empty' => $this
->t('No Entries'),
];
$row = [];
$row['enabled'] = [
'#type' => 'checkbox',
'#label' => $this
->t('Enabled'),
'#default_value' => $lingotek_config
->isEnabled($entity_type, $bundle),
'#ajax' => [
'callback' => [
$this,
'ajaxRefreshEntityFieldsForm',
],
'progress' => [
'type' => 'throbber',
'message' => NULL,
],
'wrapper' => 'container-' . str_replace('_', '-', $entity_type) . '-' . $bundle,
],
];
$row['content_type'] = [
'#markup' => $this->bundles[$entity_type][$bundle]['label'],
];
$row['profiles'] = $this
->retrieveProfiles($entity_type, $bundle);
$moderation = $moderationForm
->form($entity_type, $bundle);
if (!empty($moderation)) {
$row['moderation'] = $moderation;
}
$row['fields_container'] = $this
->generateFieldsForm($form_state, $entity_type, $bundle);
$table[$bundle] = $row;
$form['parent_details']['list'][$entity_key]['content'][$entity_type] = $table;
$form['actions']['#type'] = 'actions';
$form['actions']['submit'] = [
'#type' => 'submit',
'#id' => 'submit-settings-content-single-form',
'#value' => $this
->t('Save Lingotek content settings'),
'#button_type' => 'primary',
];
$form['#attached']['library'][] = 'lingotek/lingotek.settings';
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
/** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
$lingotek_config = \Drupal::service('lingotek.configuration');
$form_values = $form_state
->getValues();
$entity_id = $this->entity_type_id;
foreach ($form_values[$entity_id] as $bundle_id => $bundle) {
// Only process if we have marked the checkbox.
if ($bundle['enabled']) {
if (!$lingotek_config
->isEnabled($entity_id, $bundle_id)) {
$lingotek_config
->setEnabled($entity_id, $bundle_id);
}
foreach ($bundle['fields_container']['fields'] as $field_id => $ignore) {
$field_choice = isset($bundle['fields'][$field_id]) ? $bundle['fields'][$field_id] : 0;
if ($field_choice == 1) {
$lingotek_config
->setFieldLingotekEnabled($entity_id, $bundle_id, $field_id);
if (isset($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties'])) {
// We need to add both arrays, as the first one only includes the checked properties.
$property_values = $form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties'] + $form_values[$entity_id][$bundle_id]['fields_container']['fields'][$field_id . ':properties'];
$lingotek_config
->setFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id, $property_values);
}
}
elseif ($field_choice == 0) {
$lingotek_config
->setFieldLingotekEnabled($entity_id, $bundle_id, $field_id, FALSE);
if (isset($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties'])) {
$properties = array_keys($form_values[$entity_id][$bundle_id]['fields'][$field_id . ':properties']);
$properties = array_fill_keys($properties, 0);
$lingotek_config
->setFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id, $properties);
}
}
}
if (isset($form_values[$entity_id][$bundle_id]['profiles'])) {
$lingotek_config
->setDefaultProfileId($entity_id, $bundle_id, $form_values[$entity_id][$bundle_id]['profiles']);
}
/** @var \Drupal\lingotek\Moderation\LingotekModerationFactoryInterface $moderationFactory */
$moderationFactory = \Drupal::service('lingotek.moderation_factory');
/** @var \Drupal\lingotek\Moderation\LingotekModerationSettingsFormInterface $moderationForm */
$moderationForm = $moderationFactory
->getModerationSettingsForm();
$moderationForm
->submitHandler($entity_id, $bundle_id, $bundle);
}
else {
// If we removed it, unable it.
$lingotek_config
->setEnabled($entity_id, $bundle_id, FALSE);
}
}
// There is some bug than local tasks block cache is not cleared. Let's do
// that manually.
$this
->invalidateLocalTaskCacheBlocks();
$form_state
->setRedirect('lingotek.settings');
parent::submitForm($form, $form_state);
}
protected function retrieveProfileOptions() {
$this->profiles = \Drupal::entityTypeManager()
->getListBuilder('lingotek_profile')
->load();
foreach ($this->profiles as $profile) {
$this->profile_options[$profile
->id()] = $profile
->label();
}
}
protected function retrieveBundles() {
$entities = \Drupal::entityTypeManager()
->getDefinitions();
$this->bundles = [];
foreach ($entities as $entity) {
if ($entity instanceof ContentEntityType && $entity
->hasKey('langcode')) {
$bundle = \Drupal::service('entity_type.bundle.info')
->getBundleInfo($entity
->id());
$this->bundles[$entity
->id()] = $bundle;
}
}
}
protected function retrieveTranslatableBundles() {
$this->translatable_bundles = [];
foreach ($this->bundles as $bundle_group_id => $bundle_group) {
foreach ($bundle_group as $bundle_id => $bundle) {
if ($bundle['translatable']) {
$this->translatable_bundles[$bundle_group_id][$bundle_id] = $bundle;
}
}
}
}
protected function retrieveProfiles($entity_id, $bundle_id) {
/** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
$lingotek_config = \Drupal::service('lingotek.configuration');
$enable_bulk_management = $lingotek_config
->getPreference('contrib.paragraphs.enable_bulk_management');
if ($entity_id !== 'paragraph' || $enable_bulk_management) {
$select = [
'#type' => 'select',
'#options' => $lingotek_config
->getProfileOptions(),
'#default_value' => $lingotek_config
->getDefaultProfileId($entity_id, $bundle_id),
];
}
else {
$select = [
'#markup' => $this
->t("A profile doesn't apply for paragraphs. Not recommended, but you may want to <a href=':link'>translate paragraphs independently</a>.", [
':link' => '#edit-contrib-paragraphs-enable-bulk-management',
]),
];
}
return $select;
}
protected function retrieveFields(FormStateInterface $form_state, $entity_id, $bundle_id) {
$provideDefaults = $form_state
->getTemporaryValue('provideDefaults') ?: [];
$entity_type = \Drupal::entityTypeManager()
->getDefinition($entity_id);
/** @var \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config */
$lingotek_config = \Drupal::service('lingotek.configuration');
$content_translation_manager = \Drupal::service('content_translation.manager');
$storage_definitions = \Drupal::service('entity_field.manager')
->getFieldStorageDefinitions($entity_id);
$field_checkboxes = [];
if ($content_translation_manager
->isSupported($entity_id)) {
$fields = \Drupal::service('entity_field.manager')
->getFieldDefinitions($entity_id, $bundle_id);
// Find which fields the user previously selected
foreach ($fields as $field_id => $field_definition) {
$checkbox_choice = 0;
// We allow non-translatable entity_reference_revisions fields through.
// See https://www.drupal.org/node/2788285
if (!empty($storage_definitions[$field_id]) && $storage_definitions[$field_id]
->getProvider() != 'content_translation' && !in_array($storage_definitions[$field_id]
->getName(), [
$entity_type
->getKey('langcode'),
$entity_type
->getKey('default_langcode'),
'revision_translation_affected',
]) && ($field_definition
->isTranslatable() || ($field_definition
->getType() == 'entity_reference_revisions' || $field_definition
->getType() == 'path')) && !$field_definition
->isComputed() && !$field_definition
->isReadOnly()) {
$checkbox_choice = 0;
if ($value = $lingotek_config
->isFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
$checkbox_choice = $value;
}
if (isset($provideDefaults[$entity_id][$bundle_id]) && $provideDefaults[$entity_id][$bundle_id] && $lingotek_config
->shouldFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
$checkbox_choice = '1';
}
$id = 'edit-' . str_replace('_', '-', $entity_id) . '-' . str_replace('_', '-', $bundle_id) . '-fields-' . str_replace('_', '-', $field_id);
$field_checkbox = [
'#type' => 'checkbox',
'#title' => $field_definition
->getLabel(),
'#default_value' => $checkbox_choice,
'#checked' => $checkbox_choice,
'#name' => $entity_id . '[' . $bundle_id . '][fields][' . $field_id . ']',
'#id' => $id,
'#attributes' => [
'data-drupal-selector' => $id,
'id' => $id,
'name' => $entity_id . '[' . $bundle_id . '][fields][' . $field_id . ']',
],
];
$field_checkboxes[$field_id] = $field_checkbox;
// Display the column translatability configuration widget.
module_load_include('inc', 'content_translation', 'content_translation.admin');
$column_element = content_translation_field_sync_widget($field_definition);
if ($column_element) {
$default_properties = $lingotek_config
->getDefaultFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id);
$properties_checkbox_choice = $lingotek_config
->getFieldPropertiesLingotekEnabled($entity_id, $bundle_id, $field_id);
if ($provideDefaults && !$properties_checkbox_choice) {
$properties_checkbox_choice = $default_properties;
}
foreach ($column_element['#options'] as $property_id => $property) {
$checked = FALSE;
if ($checkbox_choice) {
$checked = isset($properties_checkbox_choice[$property_id]) ? $properties_checkbox_choice[$property_id] == '1' || $properties_checkbox_choice[$property_id] === $property_id : FALSE;
}
$id = 'edit-' . str_replace('_', '-', $entity_id) . '-' . str_replace('_', '-', $bundle_id) . '-fields-' . str_replace('_', '-', $field_id) . 'properties-' . str_replace('_', '-', $property_id);
$property_checkbox = [
'#type' => 'checkbox',
'#title' => $property,
'#default_value' => $checked,
'#checked' => $checked,
'#name' => $entity_id . '[' . $bundle_id . '][fields][' . $field_id . ':properties][' . $property_id . ']',
'#id' => $id,
'#attributes' => [
'data-drupal-selector' => $id,
'id' => $id,
'name' => $entity_id . '[' . $bundle_id . '][fields][' . $field_id . ':properties][' . $property_id . ']',
'class' => [
'field-property-checkbox',
],
],
];
$property_checkbox['#states']['checked'] = [
[
':input[name="' . $field_checkbox['#name'] . '"]' => [
'checked' => TRUE,
],
':input[name="' . $property_checkbox['#name'] . '"]' => [
'checked' => TRUE,
],
],
];
if ($checked || isset($default_properties[$property_id]) && $default_properties[$property_id] === $property_id) {
$property_checkbox['#states']['unchecked'] = [
':input[name="' . $field_checkbox['#name'] . '"]' => [
'unchecked' => TRUE,
],
];
}
$field_checkboxes[$field_id . ':properties'][$property_id] = $property_checkbox;
}
}
}
elseif ($field_definition
->getType() == 'path' && $field_definition
->isComputed()) {
if ($value = $lingotek_config
->isFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
$checkbox_choice = $value;
}
if (isset($provideDefaults[$entity_id][$bundle_id]) && $provideDefaults[$entity_id][$bundle_id] && $lingotek_config
->shouldFieldLingotekEnabled($entity_id, $bundle_id, $field_id)) {
$checkbox_choice = '1';
}
$id = 'edit-' . str_replace('_', '-', $entity_id) . '-' . str_replace('_', '-', $bundle_id) . '-fields-' . str_replace('_', '-', $field_id);
$field_checkbox = [
'#type' => 'checkbox',
'#title' => $field_definition
->getLabel(),
'#checked' => $checkbox_choice,
'#default_value' => $checkbox_choice,
'#name' => $entity_id . '[' . $bundle_id . '][fields][' . $field_id . ']',
'#id' => $id,
'#attributes' => [
'data-drupal-selector' => $id,
],
];
$field_checkboxes[$field_id] = $field_checkbox;
}
}
}
return $field_checkboxes;
}
public function ajaxRefreshEntityFieldsForm(array $form, FormStateInterface $form_state, Request $request) {
$triggering_element = $form_state
->getTriggeringElement();
$entity_type_id = $triggering_element['#parents'][0];
$bundle = $triggering_element['#parents'][1];
$active = $triggering_element['#value'];
$provideDefaults = $form_state
->getTemporaryValue('provideDefaults') ?: [];
$provideDefaults[$entity_type_id][$bundle] = $active;
$form_state
->setTemporaryValue('provideDefaults', $provideDefaults);
// We only need to force the rebuild. No need to do anything else.
$response = new AjaxResponse();
// Extra divs will be added. See https://www.drupal.org/node/736066.
$response
->addCommand(new ReplaceCommand('#container-' . str_replace('_', '-', $entity_type_id) . '-' . $bundle, $this
->generateFieldsForm($form_state, $entity_type_id, $bundle)));
return $response;
}
/**
* @param $entity_id
* @param $bundle_id
* @param $row
* @return mixed
*/
protected function generateFieldsForm(FormStateInterface $form_state, $entity_type_id, $bundle_id) {
$fields_container = [
'#type' => 'container',
'#id' => 'container-' . str_replace('_', '-', $entity_type_id) . '-' . $bundle_id,
'#attributes' => [
'id' => 'container-' . str_replace('_', '-', $entity_type_id) . '-' . $bundle_id,
],
'fields' => $this
->retrieveFields($form_state, $entity_type_id, $bundle_id),
];
return $fields_container;
}
/**
* Invalidates the local task cache blocks.
*/
private function invalidateLocalTaskCacheBlocks() {
if (\Drupal::moduleHandler()
->moduleExists('block')) {
// There is some bug than local tasks block cache is not cleared. Let's do
// that manually.
$ids = \Drupal::entityQuery('block')
->condition('plugin', 'local_tasks_block')
->execute();
$tags = [];
foreach ($ids as $id) {
$block = Block::load($id);
$tags = array_merge($tags, $block
->getCacheTagsToInvalidate());
}
Cache::invalidateTags($tags);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
FormInterface:: |
public | function | Returns a unique string identifying the form. | 236 |
LingotekConfigFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
5 |
LingotekConfigFormBase:: |
public | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
LingotekConfigFormBase:: |
public | function |
Constructs a \Drupal\lingotek\Form\LingotekConfigFormBase object. Overrides ConfigFormBase:: |
5 |
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
protected | property | ||
LingotekSettingsContentSingleForm:: |
public | function | ||
LingotekSettingsContentSingleForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
public | function | ||
LingotekSettingsContentSingleForm:: |
private | function | Invalidates the local task cache blocks. | |
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
protected | function | ||
LingotekSettingsContentSingleForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |