class LingotekSettingsTabConfigurationForm in Lingotek Translation 3.4.x

Configure Lingotek

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\lingotek\Form\LingotekConfigFormBase
      • class \Drupal\lingotek\Form\LingotekSettingsTabConfigurationForm

1 file declares its use of LingotekSettingsTabConfigurationForm

LingotekSettingsController.php in src/Controller/LingotekSettingsController.php

File

src/Form/LingotekSettingsTabConfigurationForm.php, line 16

Namespace

Drupal\lingotek\Form

class LingotekSettingsTabConfigurationForm extends LingotekConfigFormBase {
  protected $profile_options;
  protected $profiles;
  protected $bundles;
  protected $translatable_bundles;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The Lingotek configuration service.
   *
   * @var \Drupal\lingotek\LingotekConfigurationServiceInterface
   */
  protected $lingotekConfig;

  /**
   * The Lingotek config translation service.
   *
   * @var \Drupal\lingotek\LingotekConfigTranslationServiceInterface
   */
  protected $translationService;

  /**
   * A array of configuration mapper instances.
   *
   * @var \Drupal\config_translation\ConfigMapperInterface[]
   */
  protected $mappers;

  /**
   * The Entity Type Manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new LingotekManagementForm object.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_config
   *   The Lingotek config service.
   * @param \Drupal\lingotek\LingotekConfigTranslationServiceInterface $translation_service
   *   The Lingotek config translation service.
   * @param \Drupal\config_translation\ConfigMapperInterface[] $mappers
   *   The configuration mapper manager.
   */
  public function __construct(LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, LingotekConfigurationServiceInterface $lingotek_config, LingotekConfigTranslationServiceInterface $translation_service, array $mappers) {
    $this->languageManager = $language_manager;
    $this->entityTypeManager = $entity_type_manager;
    $this->lingotekConfig = $lingotek_config;
    $this->translationService = $translation_service;
    $this->mappers = $mappers;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('language_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('lingotek.configuration'), $container
      ->get('lingotek.config_translation'), $container
      ->get('plugin.manager.config_translation.mapper')
      ->getMappers());
  }

  /**
   * {@inheritdoc}
   */
  public function getFormID() {
    return 'lingotek.settings_tab_configuration_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $profile_options = $this->lingotekConfig
      ->getProfileOptions();
    $header = [
      'enabled' => $this
        ->t('Enable'),
      'type' => $this
        ->t('Configuration Type'),
      'profile' => $this
        ->t('Translation Profile'),
    ];
    $table = [
      '#type' => 'table',
      '#header' => $header,
      '#empty' => $this
        ->t('No Entries'),
    ];
    foreach ($this->mappers as $mapper) {

      // We don't want to show config objects, where we only have one instance.
      // Just show config entities.
      if ($mapper instanceof ConfigEntityMapper) {
        $enabled = $this->translationService
          ->isEnabled($mapper
          ->getPluginId());
        $row = [];
        $row['enabled'] = [
          '#type' => 'checkbox',
          '#default_value' => $enabled,
        ];
        $row['type'] = [
          '#markup' => $mapper
            ->getTypeLabel(),
        ];
        $row['profile'] = [
          '#type' => 'select',
          '#options' => $this->lingotekConfig
            ->getProfileOptions(),
          '#default_value' => $this->lingotekConfig
            ->getConfigEntityDefaultProfileId($mapper
            ->getPluginId()),
        ];
        $table[$mapper
          ->getPluginId()] = $row;
      }
    }
    ksort($table);
    $form['config'] = [
      '#type' => 'details',
      '#title' => 'Translate Configuration Types',
    ];
    $form['config']['table'] = $table;
    $form['config']['actions']['#type'] = 'actions';
    $form['config']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue([
      'table',
    ]);
    foreach ($values as $plugin_id => $data) {

      // We only save the enabled status if it changed.
      if ($data['enabled'] && !$this->translationService
        ->isEnabled($plugin_id)) {
        $this->translationService
          ->setEnabled($plugin_id, TRUE);
      }
      if (!$data['enabled'] && $this->translationService
        ->isEnabled($plugin_id)) {
        $this->translationService
          ->setEnabled($plugin_id, FALSE);
      }

      // If we enable it, we save the profile.
      if ($data['enabled'] && $data['profile'] !== $this->lingotekConfig
        ->getConfigEntityDefaultProfileId($plugin_id, FALSE)) {
        $this->lingotekConfig
          ->setConfigEntityDefaultProfileId($plugin_id, $data['profile']);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	264
LingotekConfigFormBase::$lingotek	protected	property
LingotekConfigFormBase::$linkGenerator	protected	property	The link generator.
LingotekConfigFormBase::$urlGenerator	protected	property	The URL generator.
LingotekConfigFormBase::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LingotekSettingsTabConfigurationForm::$bundles	protected	property
LingotekSettingsTabConfigurationForm::$entityTypeManager	protected	property	The Entity Type Manager service.
LingotekSettingsTabConfigurationForm::$languageManager	protected	property	The language manager.
LingotekSettingsTabConfigurationForm::$lingotekConfig	protected	property	The Lingotek configuration service.
LingotekSettingsTabConfigurationForm::$mappers	protected	property	A array of configuration mapper instances.
LingotekSettingsTabConfigurationForm::$profiles	protected	property
LingotekSettingsTabConfigurationForm::$profile_options	protected	property
LingotekSettingsTabConfigurationForm::$translatable_bundles	protected	property
LingotekSettingsTabConfigurationForm::$translationService	protected	property	The Lingotek config translation service.
LingotekSettingsTabConfigurationForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LingotekSettingsTabConfigurationForm::create	public static	function	Instantiates a new instance of this class. Overrides LingotekConfigFormBase::create
LingotekSettingsTabConfigurationForm::getFormID	public	function
LingotekSettingsTabConfigurationForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
LingotekSettingsTabConfigurationForm::__construct	public	function	Constructs a new LingotekManagementForm object. Overrides LingotekConfigFormBase::__construct
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.