class LocalTranslatorUi in Translation Management Tool 8

Drupal user provider plugin UI.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\tmgmt\TranslatorPluginUiBase implements TranslatorPluginUiInterface
      • class \Drupal\tmgmt_local\LocalTranslatorUi

File

translators/tmgmt_local/src/LocalTranslatorUi.php, line 14

Namespace

Drupal\tmgmt_local

class LocalTranslatorUi extends TranslatorPluginUiBase {

  /**
   * {@inheritdoc}
   */
  public function checkoutSettingsForm(array $form, FormStateInterface $form_state, JobInterface $job) {
    if ($translators = tmgmt_local_assignees($job
      ->getSourceLangcode(), array(
      $job
        ->getTargetLangcode(),
    ))) {
      $form['translator'] = array(
        '#title' => t('Assign job to'),
        '#type' => 'select',
        '#options' => array(
          '' => t('- Select user -'),
        ) + $translators,
        '#default_value' => $job
          ->getSetting('translator'),
      );
    }
    else {
      $form['message'] = array(
        '#markup' => t('There are no users available to assign.'),
      );
    }
    $form['job_comment'] = array(
      '#type' => 'textarea',
      '#title' => t('Comment for the translation'),
      '#description' => t('You can provide a comment so that the assigned user will better understand your requirements.'),
      '#default_value' => $job
        ->getSetting('job_comment'),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function checkoutInfo(JobInterface $job) {
    $tuid = $job
      ->getSetting('translator');
    if ($tuid && ($translator = User::load($tuid))) {
      $form['job_status'] = array(
        '#type' => 'item',
        '#title' => t('Job status'),
        '#markup' => t('Translation job is assigned to %name.', array(
          '%name' => $translator
            ->getDisplayName(),
        )),
      );
    }
    else {
      $form['job_status'] = array(
        '#type' => 'item',
        '#title' => t('Job status'),
        '#markup' => t('Translation job is not assigned to any user.'),
      );
    }
    if ($job
      ->getSetting('job_comment')) {
      $form['job_comment'] = array(
        '#type' => 'item',
        '#title' => t('Job comment'),
        '#markup' => Xss::filter($job
          ->getSetting('job_comment')),
      );
    }
    return $form;
  }

}

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
LocalTranslatorUi::checkoutInfo	public	function	Retrieves information about a translation job. Overrides TranslatorPluginUiBase::checkoutInfo
LocalTranslatorUi::checkoutSettingsForm	public	function	Form callback for the checkout settings form. Overrides TranslatorPluginUiBase::checkoutSettingsForm
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::checkoutInfoWrapper	public	function	Provides a simple wrapper for the checkout info fieldset.
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