interface ContinuousSourceInterface in Translation Management Tool 8

Interface for continuous sources.

Hierarchy

• interface \Drupal\tmgmt\ContinuousSourceInterface

Related topics

Translation source

A source plugin represents translatable elements on a site.

3 files declare their use of ContinuousSourceInterface

ContentEntitySource.php in sources/content/src/Plugin/tmgmt/Source/ContentEntitySource.php

JobForm.php in src/Form/JobForm.php

SourceOverviewForm.php in src/Form/SourceOverviewForm.php

File

src/ContinuousSourceInterface.php, line 13

Namespace

Drupal\tmgmt

interface ContinuousSourceInterface {

  /**
   * Creates "Continuous settings" form element.
   *
   * @param array $form
   *   The job form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param \Drupal\tmgmt\Entity\Job $job
   *   Continuous job.
   *
   * @return array
   *   Continuous settings form elements
   */
  public function continuousSettingsForm(array &$form, FormStateInterface $form_state, Job $job);

  /**
   * Checks whether the continuous job item should be created.
   *
   * @param \Drupal\tmgmt\Entity\Job $job
   *   Continuous job.
   * @param string $plugin
   *   The plugin name.
   * @param string $item_type
   *   The source item type.
   * @param string $item_id
   *   The source item id.
   *
   * @return bool
   *   TRUE if continuous job item should be created, FALSE if not.
   */
  public function shouldCreateContinuousItem(Job $job, $plugin, $item_type, $item_id);

}

Members

Name	Modifiers	Type	Description	Overrides
ContinuousSourceInterface::continuousSettingsForm	public	function	Creates "Continuous settings" form element.	1
ContinuousSourceInterface::shouldCreateContinuousItem	public	function	Checks whether the continuous job item should be created.	1