interface TranslatorPluginUiInterface in Translation Management Tool 8

Interface for translator ui controllers.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\tmgmt\TranslatorPluginUiInterface

Related topics

Translators

A translator plugin integrates a translation service.

File

src/TranslatorPluginUiInterface.php, line 14

Namespace

Drupal\tmgmt

interface TranslatorPluginUiInterface extends PluginInspectionInterface, PluginFormInterface {

  /**
   * Form callback for the checkout settings form.
   */
  public function checkoutSettingsForm(array $form, FormStateInterface $form_state, JobInterface $job);

  /**
   * Retrieves information about a translation job.
   *
   * Services based translators with remote states should place a Poll button
   * here to sync the job state.
   *
   * @param \Drupal\tmgmt\JobInterface $job
   *   The translation job.
   */
  public function checkoutInfo(JobInterface $job);

  /**
   * Form callback for the job item review form.
   */
  public function reviewForm(array $form, FormStateInterface $form_state, JobItemInterface $item);

  /**
   * Form callback for the data item element form.
   */
  public function reviewDataItemElement(array $form, FormStateInterface $form_state, $data_item_key, $parent_key, array $data_item, JobItemInterface $item);

  /**
   * Validation callback for the job item review form.
   */
  public function reviewFormValidate(array $form, FormStateInterface $form_state, JobItemInterface $item);

  /**
   * Submit callback for the job item review form.
   */
  public function reviewFormSubmit(array $form, FormStateInterface $form_state, JobItemInterface $item);

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
TranslatorPluginUiInterface::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	1
TranslatorPluginUiInterface::checkoutInfo	public	function	Retrieves information about a translation job.	1
TranslatorPluginUiInterface::checkoutSettingsForm	public	function	Form callback for the checkout settings form.	1
TranslatorPluginUiInterface::reviewDataItemElement	public	function	Form callback for the data item element form.	1
TranslatorPluginUiInterface::reviewForm	public	function	Form callback for the job item review form.	1
TranslatorPluginUiInterface::reviewFormSubmit	public	function	Submit callback for the job item review form.	1
TranslatorPluginUiInterface::reviewFormValidate	public	function	Validation callback for the job item review form.	1
TranslatorPluginUiInterface::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
TranslatorPluginUiInterface::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1