You are here

class LingotekProfileFormBase in Lingotek Translation 3.2.x

Same name and namespace in other branches
  1. 8 src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  2. 8.2 src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  3. 4.0.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  4. 3.0.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  5. 3.1.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  6. 3.3.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  7. 3.4.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  8. 3.5.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  9. 3.6.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  10. 3.7.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase
  11. 3.8.x src/Form/LingotekProfileFormBase.php \Drupal\lingotek\Form\LingotekProfileFormBase

Provides a common base class for Profile forms.

Hierarchy

Expanded class hierarchy of LingotekProfileFormBase

File

src/Form/LingotekProfileFormBase.php, line 17

Namespace

Drupal\lingotek\Form
View source
class LingotekProfileFormBase extends EntityForm {

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

  /**
   * The Lingotek Filter manager.
   *
   * @var \Drupal\lingotek\LingotekFilterManagerInterface
   */
  protected $lingotekFilterManager;

  /**
   * Constructs a LingotekProfileFormBase object.
   *
   * @param \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotek_configuration
   *   The Lingotek configuration service.
   * @param \Drupal\lingotek\LingotekFilterManagerInterface $lingotek_filter_manager
   *   The Lingotek Filter manager.
   */
  public function __construct(LingotekConfigurationServiceInterface $lingotek_configuration, LingotekFilterManagerInterface $lingotek_filter_manager) {
    $this->lingotekConfiguration = $lingotek_configuration;
    $this->lingotekFilterManager = $lingotek_filter_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('lingotek.configuration'), $container
      ->get('lingotek.filter_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'lingotek_profile_add_form';
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\lingotek\LingotekProfileInterface $profile */
    $profile = $this->entity;
    $form['id'] = [
      '#type' => 'machine_name',
      '#description' => t('A unique machine-readable name. Can only contain lowercase letters, numbers, and underscores.'),
      '#disabled' => !$profile
        ->isNew(),
      '#default_value' => $profile
        ->id(),
      '#machine_name' => [
        'exists' => '\\Drupal\\lingotek\\Entity\\LingotekProfile::load',
        'source' => [
          'label',
        ],
        'replace_pattern' => '([^a-z0-9_]+)|(^custom$)',
        'error' => $this
          ->t('The machine-readable name must be unique, and can only contain lowercase letters, numbers, and underscores. Additionally, it can not be the reserved word "custom".'),
      ],
    ];
    $form['label'] = [
      '#id' => 'label',
      '#type' => 'textfield',
      '#title' => $this
        ->t('Profile Name'),
      '#required' => TRUE,
      '#default_value' => $profile
        ->label(),
    ];
    $form['current_future_note'] = [
      '#type' => 'markup',
      '#markup' => '<h3>' . $this
        ->t('Profile settings impacting all entities (new and existing)') . '</h3><hr />',
    ];
    $form['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' => $profile
        ->isLocked(),
      '#default_value' => $profile
        ->hasAutomaticUpload(),
    ];
    $form['auto_request'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Request Translations Automatically'),
      '#description' => $this
        ->t('When enabled, translations will automatically be requested from Lingotek. When disabled, you are required to manually request translations by clicking the "Request translation" button on the Translations tab.'),
      '#disabled' => $profile
        ->isLocked(),
      '#default_value' => $profile
        ->hasAutomaticRequest(),
    ];
    $form['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' => $profile
        ->isLocked(),
      '#default_value' => $profile
        ->hasAutomaticDownload(),
    ];
    $form['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.'),
      '#disabled' => $profile
        ->isLocked(),
      '#default_value' => $profile
        ->hasAutomaticDownloadWorker(),
      '#states' => [
        'visible' => [
          ':input[name="auto_download"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $options = [
      'global_setting' => $this
        ->t('Use global setting'),
      'yes' => $this
        ->t('Yes'),
      'no' => $this
        ->t('No'),
    ];
    $form['append_type_to_title'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Append Entity Type to TMS Document Name'),
      '#description' => $this
        ->t('When enabled, the content/entity type will be appended to the title when uploading to TMS. The source and target titles will remain unchanged.'),
      '#options' => $options,
      '#default_value' => $profile
        ->getAppendContentTypeToTitle(),
      '#disabled' => $profile
        ->isLocked(),
    ];
    $form['future_only_note'] = [
      '#type' => 'markup',
      '#markup' => '<h3>' . $this
        ->t('Profile settings impacting only new nodes') . '</h3><hr />',
    ];
    $projects = $this
      ->config('lingotek.settings')
      ->get('account.resources.project');
    $default_project = $this
      ->config('lingotek.settings')
      ->get('default.project');
    $form['project'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Project'),
      '#options' => [
        'default' => 'Default (' . $projects[$default_project] . ')',
      ] + $projects,
      '#description' => $this
        ->t('The default Translation Memory Project where translations are saved.'),
      '#default_value' => $profile
        ->getProject(),
    ];
    $workflows = $this
      ->config('lingotek.settings')
      ->get('account.resources.workflow');
    $default_workflow = $this
      ->config('lingotek.settings')
      ->get('default.workflow');
    $form['workflow'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Workflow'),
      '#options' => [
        'default' => 'Default (' . $workflows[$default_workflow] . ')',
      ] + $workflows,
      '#description' => $this
        ->t('The default Workflow which would be used for translations.'),
      '#default_value' => $profile
        ->getWorkflow(),
    ];
    $vaults = $this
      ->config('lingotek.settings')
      ->get('account.resources.vault');
    $default_vault = $this
      ->config('lingotek.settings')
      ->get('default.vault');

    // We have two defaults: default vault, or the Project Workflow Template
    // Default vault.
    $form['vault'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Vault'),
      '#options' => [
        'default' => 'Default (' . $vaults[$default_vault] . ')',
        'project_workflow_vault' => 'Use Project Workflow Template Default',
      ] + $vaults,
      '#description' => $this
        ->t('The default Translation Memory Vault where translations are saved.'),
      '#default_value' => $profile
        ->getVault(),
    ];

    /** @var \Drupal\lingotek\LingotekFilterManagerInterface $filter_manager */
    $filters = $this->lingotekFilterManager
      ->getLocallyAvailableFilters();
    $form['filter'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Filter'),
      '#options' => [
        'default' => $this
          ->t('Use Global Default (%filter)', [
          '%filter' => $this->lingotekFilterManager
            ->getDefaultFilterLabel(),
        ]),
        'project_default' => $this
          ->t('Use Project Default'),
        'drupal_default' => $this
          ->t('Use Drupal Default'),
      ] + $filters,
      '#description' => $this
        ->t('The default FPRM Filter used when uploading or updating a document.'),
      '#default_value' => $profile
        ->getFilter(),
    ];
    $form['subfilter'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default Subfilter'),
      '#options' => [
        'default' => $this
          ->t('Use Global Default (%filter)', [
          '%filter' => $this->lingotekFilterManager
            ->getDefaultSubfilterLabel(),
        ]),
        'project_default' => $this
          ->t('Use Project Default'),
        'drupal_default' => $this
          ->t('Use Drupal Default'),
      ] + $filters,
      '#description' => $this
        ->t('The default FPRM Subfilter used when uploading or updating a document.'),
      '#default_value' => $profile
        ->getSubfilter(),
    ];

    // We add the overrides.
    $form['intelligence_metadata_overrides'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Lingotek Intelligence Metadata overrides'),
      '#tree' => TRUE,
    ];

    // We include the Lingotek Intelligence Metadata form and alter it for
    // adapting it to profiles. We want to make this optional.
    $subform = \Drupal::formBuilder()
      ->getForm(LingotekIntelligenceMetadataForm::class, $this
      ->getRequest(), $this
      ->getEntity());
    $form['intelligence_metadata_overrides']['override'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Override general Lingotek Intelligence metadata when using this profile'),
      '#description' => $this
        ->t('When enabled, general Lingotek Intelligence metadata will be overridden by the options here when using this profile.'),
      '#default_value' => $profile
        ->hasIntelligenceMetadataOverrides(),
    ];
    $form['intelligence_metadata_overrides']['form'] = $subform['intelligence_metadata'];
    $form['intelligence_metadata_overrides']['form']['#states'] = [
      'visible' => [
        ':input[name="intelligence_metadata_overrides[override]"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
    unset($form['intelligence_metadata_overrides']['form']['actions']);
    $form['language_overrides'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Target language specific settings'),
      '#tree' => TRUE,
    ];
    $languages = \Drupal::languageManager()
      ->getLanguages();

    // Filter the disabled languages.
    $languages = array_filter($languages, function (LanguageInterface $language) {
      $configLanguage = ConfigurableLanguage::load($language
        ->getId());
      return $this->lingotekConfiguration
        ->isLanguageEnabled($configLanguage);
    });

    // We want to have them alphabetically.
    ksort($languages);
    foreach ($languages as $langcode => $language) {
      $form['language_overrides'][$langcode] = [
        'overrides' => [
          '#type' => 'select',
          '#title' => $language
            ->getName() . ' (' . $language
            ->getId() . ')',
          '#options' => [
            'default' => $this
              ->t('Use default settings'),
            'custom' => $this
              ->t('Use custom settings'),
          ],
          '#default_value' => $profile
            ->hasCustomSettingsForTarget($langcode) ? 'custom' : 'default',
        ],
        'custom' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => 'profile-language-overrides-container',
          ],
          '#states' => [
            'visible' => [
              ':input[name="language_overrides[' . $langcode . '][overrides]"]' => [
                'value' => 'custom',
              ],
            ],
          ],
          'workflow' => [
            '#type' => 'select',
            '#title' => $this
              ->t('Default Workflow'),
            '#options' => [
              'default' => 'Default (' . $workflows[$default_workflow] . ')',
            ] + $workflows,
            '#description' => $this
              ->t('The default Workflow which would be used for translations.'),
            '#default_value' => $profile
              ->hasCustomSettingsForTarget($langcode) ? $profile
              ->getWorkflowForTarget($langcode) : 'default',
          ],
          // If using overrides, we can never specify the document vault as this
          // cannot be empty, nor force to use the project template vault, as it
          // is unknown to us.
          'vault' => [
            '#type' => 'select',
            '#title' => $this
              ->t('Target Save-To Vault'),
            '#options' => [
              'default' => 'Default (' . $vaults[$default_vault] . ')',
            ] + $vaults,
            '#description' => $this
              ->t("The Translation Memory Vault where this target's translations are saved."),
            '#default_value' => $profile
              ->hasCustomSettingsForTarget($langcode) ? $profile
              ->getVaultForTarget($langcode) : 'default',
          ],
          'auto_request' => [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Request Translations Automatically'),
            '#description' => $this
              ->t('When enabled, translations will automatically be requested from Lingotek. When disabled, you are required to manually request translations by clicking the "Request translation" button on the Translations tab.'),
            '#disabled' => $profile
              ->isLocked(),
            '#default_value' => $profile
              ->hasAutomaticRequestForTarget($langcode),
          ],
          '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' => $profile
              ->isLocked(),
            '#default_value' => $profile
              ->hasAutomaticDownloadForTarget($langcode),
          ],
        ],
      ];
    }
    $form['#attached']['library'][] = 'lingotek/lingotek.settings';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\lingotek\Entity\LingotekProfile $profile */
    $profile = $this
      ->getEntity();

    /** @var \Drupal\Core\Form\FormInterface $subform */
    $form_object = new LingotekIntelligenceMetadataForm();
    $input = $form_state
      ->getUserInput();
    $inner_form_state = new FormState();
    $inner_form_state
      ->addBuildInfo('args', [
      $this
        ->getRequest(),
      $profile,
    ]);
    $inner_form_state
      ->setFormObject($form_object);
    $inner_form_state
      ->setUserInput($form_state
      ->getUserInput());
    $inner_form_state
      ->setValue('intelligence_metadata', $input['intelligence_metadata']);
    $subform = [];
    $form_object
      ->submitForm($subform, $inner_form_state);
    $profile
      ->setIntelligenceMetadataOverrides($form_state
      ->getValue([
      'intelligence_metadata_overrides',
      'override',
    ]));
    parent::save($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entity protected property The entity being used by this form. 11
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 35
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 3
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 13
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 3
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form state… Overrides FormInterface::submitForm 20
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
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
LingotekProfileFormBase::$lingotekConfiguration protected property The Lingotek configuration service.
LingotekProfileFormBase::$lingotekFilterManager protected property The Lingotek Filter manager.
LingotekProfileFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LingotekProfileFormBase::form public function Gets the actual form array to be built. Overrides EntityForm::form
LingotekProfileFormBase::getFormId public function Returns a unique string identifying the form. Overrides EntityForm::getFormId 1
LingotekProfileFormBase::save public function Form submission handler for the 'save' action. Overrides EntityForm::save 2
LingotekProfileFormBase::__construct public function Constructs a LingotekProfileFormBase object.
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.