class LingotekSettingsTabProfilesEditForm 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\LingotekSettingsTabProfilesEditForm

1 file declares its use of LingotekSettingsTabProfilesEditForm

LingotekSettingsController.php in src/Controller/LingotekSettingsController.php

File

src/Form/LingotekSettingsTabProfilesEditForm.php, line 11

Namespace

Drupal\lingotek\Form

class LingotekSettingsTabProfilesEditForm extends LingotekConfigFormBase {
  protected $profile;
  protected $profile_vaults;
  protected $auto_upload_disabled;
  protected $auto_download_disabled;
  protected $profile_name_disabled;
  protected $profile_index;
  protected $profile_usage;

  // Disallow removing for now.
  protected $is_custom_id = 1;

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this
      ->retrieveProfileFromUrl();
    $this
      ->retrieveProfileVaults();
    $this
      ->retrieveEnabledSettings();
    $form['defaults']['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Profile Name'),
      '#default_value' => $this
        ->t(ucwords($this->profile['name'])),
      '#disabled' => $this->profile_name_disabled,
    ];
    $form['defaults']['current_future_note'] = [
      '#type' => 'markup',
      '#markup' => '<h3>' . t('Profile settings impacting all entities (new and existing)') . '</h3><hr />',
    ];
    $form['defaults']['auto_upload'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Upload Content Automatically'),
      '#description' => $this
        ->t('When enabled, your Drupal content (including saved edits) will automatically be uploaded to Lingotek for translation. When disabled, you are required to manually upload your content by clicking the "Upload" button on the Translations tab.'),
      '#disabled' => $this->auto_upload_disabled,
      '#default_value' => $this->profile['auto_upload'],
    ];
    $form['defaults']['auto_download'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Download Translations Automatically'),
      '#description' => $this
        ->t('When enabled, completed translations will automatically be downloaded from Lingotek. When disabled, you are required to manually download translations by clicking the "Download" button on the Translations tab.'),
      '#disabled' => $this->auto_download_disabled,
      '#default_value' => $this->profile['auto_download'],
    ];
    $form['defaults']['auto_download_worker'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use a Queue Worker to Download Translations'),
      '#description' => $this
        ->t('When enabled, completed translations will automatically be queued for download. This worker can be processed multiple ways, e.g. using cron.'),
      '#default_value' => $this->profile['auto_download_worker'],
    ];
    $form['defaults']['future_only_note'] = [
      '#type' => 'markup',
      '#markup' => '<h3>' . $this
        ->t('Profile settings impacting only new nodes') . '</h3><hr />',
    ];
    $form['defaults']['vault'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Vault'),
      '#options' => $this->profile_vaults,
      '#description' => $this
        ->t('The default Translation Memory Vault where translations are saved.'),
      '#default_value' => FALSE,
    ];
    $form['defaults']['actions']['#type'] = 'actions';
    $form['defaults']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
      '#button_type' => 'primary',
    ];
    $form['defaults']['actions']['cancel'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Cancel'),
      '#button_type' => 'primary',
      '#submit' => [
        '::cancel',
      ],
    ];

    // User cannot delete a non-custom profile
    if (!$this->is_custom_id) {
      $form['defaults']['actions']['cant_delete_button'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('This profile cannot be deleted'),
        '#button_type' => 'primary',
        '#disabled' => TRUE,
      ];
    }
    elseif ($this->profile_usage > 0 and $this->is_custom_id) {
      $form['defaults']['actions']['cant_delete_usage_button'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('You can only delete this profile when there are no entities or bundles using it'),
        '#button_type' => 'primary',
        '#disabled' => TRUE,
      ];
    }
    else {
      $form['defaults']['actions']['delete'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Delete'),
        '#button_type' => 'primary',
        '#submit' => [
          '::deleteButton',
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();

    // Save a new profile
    if (!$this->profile) {
      $this
        ->saveNewProfile(strtolower($form_values['name']), $form_values['auto_upload'], $form_values['auto_download'], $form_values['auto_upload_worker']);
    }
    elseif ($this->is_custom_id) {
      $this
        ->updateCustomProfile(strtolower($form_values['name']), $form_values['auto_upload'], $form_values['auto_download'], $form_values['auto_upload_worker']);
    }
    $config = \Drupal::configFactory()
      ->getEditable('lingotek.settings');
    $config
      ->set('default.vault', $form_values['vault']);
    $config
      ->save();
    $form_state
      ->setRedirect('lingotek.settings');
    parent::submitForm($form, $form_state);
  }
  public function deleteButton(array &$form, FormStateInterface $form_state) {
    if ($this->profile_usage == 0 and $this->is_custom_id) {
      $this
        ->deleteCustomProfile();
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('The profile has been deleted.'));
    $form_state
      ->setRedirect('lingotek.settings');
  }
  public function cancel(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('lingotek.settings');
  }
  protected function retrieveProfileFromUrl() {
    if (isset($_GET['profile_choice']) and isset($_GET['profile_index']) and isset($_GET['profile_usage'])) {
      $this->profile = LingotekProfile::load($_GET['profile_choice']);
      $this->profile_index = $_GET['profile_index'];

      // $_GET['profile_usage'];
      $this->profile_usage = 1;
    }
  }
  protected function retrieveProfileVaults() {
    $personal_vault = [];
    $personal_vault_key = $this
      ->config('lingotek.settings')
      ->get('default.vault');
    $community_vault = $this
      ->config('lingotek.settings')
      ->get('account.resources.vault');
    if (isset($community_vault[$personal_vault_key])) {
      $personal_vault = [
        $personal_vault_key => $community_vault[$personal_vault_key],
      ];
    }
    $this->profile_vaults = [
      'Personal Vaults' => $personal_vault,
      'Community Vaults' => $community_vault,
    ];
  }
  protected function retrieveEnabledSettings() {

    // Adding a new profile
    if (!$this->profile) {
      $this->auto_upload_disabled = FALSE;
      $this->auto_download_disabled = FALSE;
      $this->profile_name_disabled = FALSE;
    }
    elseif (!$this->is_custom_id) {
      $this->auto_upload_disabled = TRUE;
      $this->auto_download_disabled = TRUE;
      $this->profile_name_disabled = TRUE;
    }
    elseif ($this->is_custom_id) {
      $this->auto_upload_disabled = FALSE;
      $this->auto_download_disabled = FALSE;
      $this->profile_name_disabled = FALSE;
    }
  }
  protected function saveNewProfile($name, $auto_upload, $auto_download, $auto_download_worker) {
    $profile = LingotekProfile::create([
      'id' => \Drupal::transliteration()
        ->transliterate($name),
      'label' => $name,
      'auto_upload' => $auto_upload,
      'auto_download' => $auto_download,
      'auto_download_worker' => $auto_download_worker,
    ]);
  }
  protected function updateCustomProfile($name, $auto_upload, $auto_download, $auto_download_worker) {

    /** @var \Drupal\lingotek\Entity\LingotekProfile $current_profile */
    $current_profile = $this->profile;
    $current_profile
      ->set('label', $name);
    $current_profile
      ->setAutomaticDownload($auto_download);
    $current_profile
      ->setAutomaticUpload($auto_upload);
    $current_profile
      ->setAutomaticDownloadWorker($auto_download_worker);
    $current_profile
      ->save();
  }
  protected function deleteCustomProfile() {
    $current_profile = $this->profile;
    if (!$current_profile
      ->isLocked()) {
      $current_profile
        ->save();
    }
  }

}

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::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create	5
LingotekConfigFormBase::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
LingotekConfigFormBase::__construct	public	function	Constructs a \Drupal\lingotek\Form\LingotekConfigFormBase object. Overrides ConfigFormBase::__construct	5
LingotekSettingsTabProfilesEditForm::$auto_download_disabled	protected	property
LingotekSettingsTabProfilesEditForm::$auto_upload_disabled	protected	property
LingotekSettingsTabProfilesEditForm::$is_custom_id	protected	property
LingotekSettingsTabProfilesEditForm::$profile	protected	property
LingotekSettingsTabProfilesEditForm::$profile_index	protected	property
LingotekSettingsTabProfilesEditForm::$profile_name_disabled	protected	property
LingotekSettingsTabProfilesEditForm::$profile_usage	protected	property
LingotekSettingsTabProfilesEditForm::$profile_vaults	protected	property
LingotekSettingsTabProfilesEditForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
LingotekSettingsTabProfilesEditForm::cancel	public	function
LingotekSettingsTabProfilesEditForm::deleteButton	public	function
LingotekSettingsTabProfilesEditForm::deleteCustomProfile	protected	function
LingotekSettingsTabProfilesEditForm::getFormID	public	function
LingotekSettingsTabProfilesEditForm::retrieveEnabledSettings	protected	function
LingotekSettingsTabProfilesEditForm::retrieveProfileFromUrl	protected	function
LingotekSettingsTabProfilesEditForm::retrieveProfileVaults	protected	function
LingotekSettingsTabProfilesEditForm::saveNewProfile	protected	function
LingotekSettingsTabProfilesEditForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
LingotekSettingsTabProfilesEditForm::updateCustomProfile	protected	function
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.