Configuration translation overview form.
Expanded class hierarchy of ConfigTranslateForm
class ConfigTranslateForm extends FormBase {
/**
* The configuration mapper manager.
*
* @var \Drupal\config_translation\ConfigMapperManagerInterface
*/
protected $configMapperManager;
/**
* The RouteMatch service.
*
* @var \Drupal\Core\Routing\RouteMatch
*/
protected $routeMatch;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'tmgmt_config_translate_form';
}
/**
* Constructs a ConfigTranslationController.
*
* @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
* The configuration mapper manager.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The RouteMatch service.
*/
public function __construct(ConfigMapperManagerInterface $config_mapper_manager, RouteMatchInterface $route_match) {
$this->configMapperManager = $config_mapper_manager;
$this->routeMatch = $route_match;
}
/**
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* @return static
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('plugin.manager.config_translation.mapper'), $container
->get('current_route_match'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, array $build = NULL, $plugin_id = NULL) {
// Store the entity in the form state so we can easily create the job in the
// submit handler.
$mapper_definition = \Drupal::service('plugin.manager.config_translation.mapper')
->getDefinition($plugin_id);
/** @var \Drupal\config_translation\ConfigMapperInterface $mapper */
$mapper = $this->configMapperManager
->createInstance($plugin_id);
$mapper
->populateFromRouteMatch($this->routeMatch);
$form_state
->set('mapper', $mapper);
if (!isset($mapper_definition['entity_type'])) {
$form_state
->set('item_type', ConfigSource::SIMPLE_CONFIG);
$form_state
->set('item_id', $mapper_definition['id']);
}
else {
$id = $mapper
->getConfigNames()[0];
$form_state
->set('id', $id);
$form_state
->set('item_type', $plugin_id);
$form_state
->set('item_id', $id);
}
$form['#title'] = $this
->t('Translations of @title', array(
'@title' => $mapper
->getTitle(),
));
$overview = $build['languages'];
$form['top_actions'] = array(
'#type' => 'details',
'#title' => t('Operations'),
'#open' => TRUE,
'#attributes' => array(
'class' => array(
'tmgmt-source-operations-wrapper',
),
),
);
$form['top_actions']['request'] = array(
'#type' => 'submit',
'#button_type' => 'primary',
'#value' => $this
->t('Request translation'),
'#submit' => array(
'::submitForm',
),
);
tmgmt_add_cart_form($form['top_actions'], $form_state, 'config', $form_state
->get('item_type'), $form_state
->get('item_id'));
// Inject our additional column into the header.
array_splice($overview['#header'], -1, 0, array(
t('Pending Translations'),
));
// Make this a tableselect form.
$form['languages'] = array(
'#type' => 'tableselect',
'#header' => $overview['#header'],
'#options' => array(),
);
$languages = \Drupal::languageManager()
->getLanguages();
// Check if there is a job / job item that references this translation.
$items = tmgmt_job_item_load_latest('config', $form_state
->get('item_type'), $form_state
->get('item_id'), $mapper
->getLangcode());
foreach ($languages as $langcode => $language) {
if ($langcode == LanguageInterface::LANGCODE_DEFAULT) {
// Never show language neutral on the overview.
continue;
}
// Since the keys are numeric and in the same order we can shift one element
// after the other from the original non-form rows.
$option = $overview[$langcode];
if ($langcode == $mapper
->getLangcode()) {
$additional = array(
'data' => array(
'#markup' => '<strong>' . t('Source') . '</strong>',
),
);
// This is the source object so we disable the checkbox for this row.
$form['languages'][$langcode] = array(
'#type' => 'checkbox',
'#disabled' => TRUE,
);
}
elseif (isset($items[$langcode])) {
$item = $items[$langcode];
$states = JobItem::getStates();
$additional = Link::fromTextAndUrl($item
->getStateIcon() ?: $states[$item
->getState()], $item
->toUrl()
->setOption('query', array(
'destination' => Url::fromRoute('<current>')
->getInternalPath(),
)))
->toString();
// Disable the checkbox for this row since there is already a translation
// in progress that has not yet been finished. This way we make sure that
// we don't stack multiple active translations for the same item on top
// of each other.
$form['languages'][$langcode] = array(
'#type' => 'checkbox',
'#disabled' => TRUE,
);
}
else {
// There is no translation job / job item for this target language.
$additional = t('None');
}
// Inject the additional column into the array.
// The generated form structure has changed, support both an additional
// 'data' key (that is not supported by tableselect) and the old version
// without.
if (isset($option['data'])) {
array_splice($option['data'], -1, 0, array(
$additional,
));
// Append the current option array to the form.
$form['languages']['#options'][$langcode] = $option['data'];
}
else {
array_splice($option, -1, 0, array(
$additional,
));
// Append the current option array to the form.
$form['languages']['#options'][$langcode] = array(
\Drupal::service('renderer')
->render($option['language']),
$additional,
\Drupal::service('renderer')
->render($option['operations']),
);
}
}
return $form;
}
/**
* {@inheritdoc}
*/
function validateForm(array &$form, FormStateInterface $form_state) {
$selected = array_filter($form_state
->getValue('languages'));
if (empty($selected)) {
$form_state
->setErrorByName('languages', $this
->t('You have to select at least one language for requesting a translation.'));
}
}
/**
* {@inheritdoc}
*/
function submitForm(array &$form, FormStateInterface $form_state) {
/** @var \Drupal\config_translation\ConfigMapperManagerInterface $mapper */
$mapper = $form_state
->get('mapper');
$values = $form_state
->getValues();
$item_type = $form_state
->get('item_type');
$item_id = $form_state
->get('item_id');
$jobs = array();
foreach (array_keys(array_filter($values['languages'])) as $langcode) {
// Create the job object.
$job = tmgmt_job_create($mapper
->getLangcode(), $langcode, \Drupal::currentUser()
->id());
try {
// Add the job item.
$job
->addItem('config', $item_type, $item_id);
// Append this job to the array of created jobs so we can redirect the user
// to a multistep checkout form if necessary.
$jobs[$job
->id()] = $job;
} catch (TMGMTException $e) {
watchdog_exception('tmgmt', $e);
$languages = \Drupal::languageManager()
->getLanguages();
$target_lang_name = $languages[$langcode]->language;
$this
->messenger()
->addError(t('Unable to add job item for target language %name. Make sure the source content is not empty.', array(
'%name' => $target_lang_name,
)));
}
}
\Drupal::service('tmgmt.job_checkout_manager')
->checkoutAndRedirect($form_state, $jobs);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConfigTranslateForm:: |
protected | property | The configuration mapper manager. | |
ConfigTranslateForm:: |
protected | property | The RouteMatch service. | |
ConfigTranslateForm:: |
public | function | ||
ConfigTranslateForm:: |
public static | function | ||
ConfigTranslateForm:: |
public | function | ||
ConfigTranslateForm:: |
function | |||
ConfigTranslateForm:: |
function | |||
ConfigTranslateForm:: |
public | function | Constructs a ConfigTranslationController. |