class LingotekJobAssignToMultipleConfigForm in Lingotek Translation 8.2
Same name and namespace in other branches
- 4.0.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.0.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.1.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.2.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.3.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.4.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.5.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.6.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.7.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
- 3.8.x src/Form/LingotekJobAssignToMultipleConfigForm.php \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm
Form for bulk assignation of Job ID to config entities.
@package Drupal\lingotek\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\lingotek\Form\LingotekJobAssignToMultipleConfigForm uses RedirectDestinationTrait
Expanded class hierarchy of LingotekJobAssignToMultipleConfigForm
1 string reference to 'LingotekJobAssignToMultipleConfigForm'
File
- src/
Form/ LingotekJobAssignToMultipleConfigForm.php, line 29
Namespace
Drupal\lingotek\FormView source
class LingotekJobAssignToMultipleConfigForm extends FormBase {
use RedirectDestinationTrait;
/**
* A array of configuration mapper instances.
*
* @var \Drupal\config_translation\ConfigMapperInterface[]
*/
protected $mappers;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The tempstore.
*
* @var \Drupal\Core\TempStore\SharedTempStore
*/
protected $tempStore;
/**
* The messenger service.
*
* @var \Drupal\Core\Messenger\MessengerInterface
*/
protected $messenger;
/**
* The Lingotek content translation service.
*
* @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface
*/
protected $translationService;
/**
* The selection, in the $entity_type_id => entity_id => langcodes format.
*
* @var array
*/
protected $selection = [];
/**
* Constructs a new LingotekJobAssignToMultipleConfigForm object.
*
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
* The tempstore factory.
* @param \Drupal\Core\Messenger\MessengerInterface $messenger
* The messenger service.
* @param \Drupal\lingotek\LingotekConfigTranslationServiceInterface $translation_service
* The Lingotek config translation service.
* @param \Drupal\config_translation\ConfigMapperInterface[] $mappers
* The configuration mappers.
*/
public function __construct(AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, PrivateTempStoreFactory $temp_store_factory, MessengerInterface $messenger, LingotekConfigTranslationServiceInterface $translation_service, array $mappers) {
$this->currentUser = $current_user;
$this->entityTypeManager = $entity_type_manager;
$this->tempStore = $temp_store_factory
->get('lingotek_assign_job_config_multiple_confirm');
$this->messenger = $messenger;
$this->translationService = $translation_service;
$this->mappers = $mappers;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('current_user'), $container
->get('entity_type.manager'), $container
->get('tempstore.private'), $container
->get('messenger'), $container
->get('lingotek.config_translation'), $container
->get('plugin.manager.config_translation.mapper')
->getMappers());
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'lingotek.assign_job_config_multiple_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$this->selection = $this->tempStore
->get($this->currentUser
->id());
if (empty($this->selection)) {
$form_state
->setRedirectUrl(Url::fromUserInput('/' . $form_state
->getValue('destination')));
}
$mappers = $this
->getSelectedMappers($this->selection);
$items = array_map(function ($mapper) {
return $this
->getMapperLabel($mapper);
}, $mappers);
$form['job_id'] = [
'#type' => 'lingotek_job_id',
'#title' => $this
->t('Job ID'),
'#description' => $this
->t('Assign a job id that you can filter on later on the TMS or in this page.'),
];
$form['update_tms'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Notify the Lingotek TMS'),
'#description' => $this
->t('Notify the Lingotek TMS (when applicable)'),
];
$form['entities'] = [
'#theme' => 'item_list',
'#title' => $this
->t('Affected content'),
'#items' => $items,
];
$form['actions']['submit'] = [
'#type' => 'submit',
'#value' => $this
->t('Assign Job ID'),
'#submit' => [
'::submitForm',
],
'#button_type' => 'primary',
];
$form['actions']['cancel'] = [
'#type' => 'submit',
'#value' => $this
->t('Cancel'),
'#submit' => [
'::cancelForm',
],
'#attributes' => [
'class' => [
'button',
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function cancelForm(array &$form, FormStateInterface $form_state) {
$form_state
->setRedirectUrl(Url::fromUserInput('/' . $form_state
->getValue('destination')));
// Clear selected data.
$this->tempStore
->delete($this->currentUser
->id());
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$job_id = $form_state
->getValue('job_id');
$updateTMS = $form_state
->getValue('update_tms');
$errors = FALSE;
$mappers = $this
->getSelectedMappers($this->selection);
foreach ($mappers as $mapper) {
if ($mapper instanceof ConfigEntityMapper) {
try {
$entity = $mapper
->getEntity();
$this->translationService
->setJobId($entity, $job_id, $updateTMS);
} catch (LingotekPaymentRequiredException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
} catch (LingotekDocumentArchivedException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Document @entity_type %title has been archived. Please upload again.', [
'@entity_type' => $entity
->getEntityTypeId(),
'%title' => $entity
->label(),
]));
} catch (LingotekDocumentLockedException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Document @entity_type %title has a new version. The document id has been updated for all future interactions. Please try again.', [
'@entity_type' => $entity
->getEntityTypeId(),
'%title' => $entity
->label(),
]));
} catch (LingotekApiException $exception) {
$errors = TRUE;
$this
->messenger()
->addError(t('The Job ID change submission for @entity_type %title failed. Please try again.', [
'@entity_type' => $entity
->getEntityTypeId(),
'%title' => $entity
->label(),
]));
}
}
else {
try {
$this->translationService
->setConfigJobId($mapper, $job_id, $updateTMS);
} catch (LingotekPaymentRequiredException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Community has been disabled. Please contact support@lingotek.com to re-enable your community.'));
} catch (LingotekDocumentArchivedException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Document %label has been archived. Please upload again.', [
'%label' => $mapper
->getTitle(),
]));
} catch (LingotekDocumentLockedException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('Document %label has a new version. The document id has been updated for all future interactions. Please try again.', [
'%label' => $mapper
->getTitle(),
]));
} catch (LingotekApiException $exception) {
$errors = TRUE;
$this->messenger
->addError(t('The Job ID change submission for %label failed. Please try again.', [
'%label' => $mapper
->getTitle(),
]));
}
}
}
$form_state
->setRedirectUrl(Url::fromUserInput('/' . $form_state
->getValue('destination')));
if (!$errors) {
$this
->postStatusMessage();
}
else {
$this->messenger
->addWarning($this
->t('Job ID for some config failed to sync to the TMS.'));
}
// Clear selected data.
$this->tempStore
->delete($this->currentUser
->id());
}
/**
* Post a status message when succeeded.
*/
protected function postStatusMessage() {
$this->messenger
->addStatus('Job ID was assigned successfully.');
}
/**
* Gets the select mappers from their IDs.
*
* @param $values
* Array of ids.
*
* @return \Drupal\config_translation\ConfigNamesMapper[]
* The mappers.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
protected function getSelectedMappers($values) {
$mappers = [];
foreach ($values as $type => $data) {
if ($type === 'config') {
foreach ($data as $key => $languages) {
$mappers[$key] = $this->mappers[$key];
}
}
elseif (substr($type, -7) == '_fields') {
$mapper = $this->mappers[$type];
$ids = \Drupal::entityQuery('field_config')
->condition('id', array_keys($data))
->execute();
$fields = FieldConfig::loadMultiple($ids);
$mappers = [];
foreach ($fields as $id => $field) {
$new_mapper = clone $mapper;
$new_mapper
->setEntity($field);
$mappers[$field
->id()] = $new_mapper;
}
}
else {
$entities = $this->entityTypeManager
->getStorage($type)
->loadMultiple(array_keys($data));
foreach ($entities as $entity) {
$mapper = clone $this->mappers[$type];
$mapper
->setEntity($entity);
$mappers[$entity
->id()] = $mapper;
}
}
}
return $mappers;
}
/**
* Gets a user-friendly label for a mapper.
*
* @param \Drupal\config_translation\ConfigMapperInterface $mapper
* The mapper.
*
* @return string
* A user-friendly label.
*/
protected function getMapperLabel(ConfigMapperInterface $mapper) {
$label = '';
if ($mapper instanceof ConfigFieldMapper) {
$label = $mapper
->getTitle() . '(' . $this
->getFieldBundleLabel($mapper) . ')';
}
elseif ($mapper instanceof ConfigEntityMapper) {
$label = $mapper
->getTitle();
}
else {
$label = $mapper
->getTitle();
}
return $label;
}
/**
* Gets a user-friendly label for a mapper bundle.
*
* @param \Drupal\config_translation\ConfigFieldMapper $mapper
* The mapper.
*
* @return string
* A user-friendly label.
*/
protected function getFieldBundleLabel(ConfigFieldMapper $mapper) {
$label = '';
$entity_type_id = $mapper
->getEntity()
->get('entity_type');
$bundle = $mapper
->getEntity()
->get('bundle');
$bundle_info = \Drupal::service('entity_type.bundle.info')
->getBundleInfo($entity_type_id);
if (isset($bundle_info[$bundle])) {
$label = $bundle_info[$bundle]['label'];
}
else {
$label = $bundle;
}
return $label;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | Retrieves a configuration object. | |
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 |
LingotekJobAssignToMultipleConfigForm:: |
protected | property | The current user. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | property | The entity type manager. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | property | A array of configuration mapper instances. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | property |
The messenger service. Overrides MessengerTrait:: |
|
LingotekJobAssignToMultipleConfigForm:: |
protected | property | The selection, in the $entity_type_id => entity_id => langcodes format. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | property | The tempstore. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | property | The Lingotek content translation service. | |
LingotekJobAssignToMultipleConfigForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
1 |
LingotekJobAssignToMultipleConfigForm:: |
public | function | ||
LingotekJobAssignToMultipleConfigForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
LingotekJobAssignToMultipleConfigForm:: |
protected | function | Gets a user-friendly label for a mapper bundle. | |
LingotekJobAssignToMultipleConfigForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
1 |
LingotekJobAssignToMultipleConfigForm:: |
protected | function | Gets a user-friendly label for a mapper. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | function | Gets the select mappers from their IDs. | |
LingotekJobAssignToMultipleConfigForm:: |
protected | function | Post a status message when succeeded. | 1 |
LingotekJobAssignToMultipleConfigForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
1 |
LingotekJobAssignToMultipleConfigForm:: |
public | function | Constructs a new LingotekJobAssignToMultipleConfigForm object. | |
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:: |
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. |