class TranslatorPluginUiBase in Translation Management Tool 8

Default ui controller class for translator plugins.

View source

class TranslatorPluginUiBase extends PluginBase implements TranslatorPluginUiInterface {

  /**
   * {@inheritdoc}
   */
  public function checkoutSettingsForm(array $form, FormStateInterface $form_state, JobInterface $job) {
    if (!Element::children($form)) {
      $form['#description'] = t("The @translator translator doesn't provide any checkout settings.", array(
        '@translator' => $job
          ->getTranslator()
          ->label(),
      ));
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function checkoutInfo(JobInterface $job) {
    return array();
  }

  /**
   * Provides a simple wrapper for the checkout info fieldset.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   *   Translation job object.
   * @param $form
   *   Partial form structure to be wrapped in the fieldset.
   *
   * @return
   *   The provided form structure wrapped in a collapsed fieldset.
   */
  public function checkoutInfoWrapper(JobInterface $job, $form) {
    $label = $job
      ->getTranslator()
      ->label();
    $form += array(
      '#title' => t('@translator translation job information', array(
        '@translator' => $label,
      )),
      '#type' => 'details',
      '#open' => FALSE,
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function reviewForm(array $form, FormStateInterface $form_state, JobItemInterface $item) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function reviewDataItemElement(array $form, FormStateInterface $form_state, $data_item_key, $parent_key, array $data_item, JobItemInterface $item) {
    return $form;
  }

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

    // Nothing to do here by default.
  }

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

    // Nothing to do here by default.
  }

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

  /**
   * Handles submit call of "Connect" button.
   */
  public function submitConnect(array $form, FormStateInterface $form_state) {

    // When this method is called the form already passed validation and we can
    // assume that credentials are valid.
    $this
      ->messenger()
      ->addStatus(t('Successfully connected!'));
  }

  /**
   * Adds a "Connect" button to a form.
   *
   * @return array
   *   A form array containing "Connect" button.
   */
  public function addConnectButton() {
    $form['connect'] = array(
      '#type' => 'submit',
      '#value' => t('Connect'),
      '#submit' => [
        [
          TranslatorForm::class,
          'updateRemoteLanguagesMappings',
        ],
        [
          $this,
          'submitConnect',
        ],
      ],
      '#limit_validation_errors' => array(
        array(
          'settings',
        ),
      ),
      '#executes_submit_callback' => TRUE,
      '#ajax' => [
        'callback' => [
          TranslatorForm::class,
          'ajaxTranslatorPluginSelect',
        ],
        'wrapper' => 'tmgmt-plugin-wrapper',
      ],
    );
    return $form;
  }

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

    // Nothing to do here by default.
  }

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

    // Nothing to do here by default.
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
TranslatorPluginUiBase::addConnectButton	public	function	Adds a "Connect" button to a form.
TranslatorPluginUiBase::buildConfigurationForm	public	function	Form constructor. Overrides TranslatorPluginUiInterface::buildConfigurationForm	2
TranslatorPluginUiBase::checkoutInfo	public	function	Retrieves information about a translation job. Overrides TranslatorPluginUiInterface::checkoutInfo	2
TranslatorPluginUiBase::checkoutInfoWrapper	public	function	Provides a simple wrapper for the checkout info fieldset.
TranslatorPluginUiBase::checkoutSettingsForm	public	function	Form callback for the checkout settings form. Overrides TranslatorPluginUiInterface::checkoutSettingsForm	3
TranslatorPluginUiBase::reviewDataItemElement	public	function	Form callback for the data item element form. Overrides TranslatorPluginUiInterface::reviewDataItemElement	1
TranslatorPluginUiBase::reviewForm	public	function	Form callback for the job item review form. Overrides TranslatorPluginUiInterface::reviewForm
TranslatorPluginUiBase::reviewFormSubmit	public	function	Submit callback for the job item review form. Overrides TranslatorPluginUiInterface::reviewFormSubmit
TranslatorPluginUiBase::reviewFormValidate	public	function	Validation callback for the job item review form. Overrides TranslatorPluginUiInterface::reviewFormValidate
TranslatorPluginUiBase::submitConfigurationForm	public	function	Form submission handler. Overrides TranslatorPluginUiInterface::submitConfigurationForm
TranslatorPluginUiBase::submitConnect	public	function	Handles submit call of "Connect" button.
TranslatorPluginUiBase::validateConfigurationForm	public	function	Form validation handler. Overrides TranslatorPluginUiInterface::validateConfigurationForm

You are here

class TranslatorPluginUiBase in Translation Management Tool 8

Hierarchy

Related topics

File

Namespace

Members

API Navigation