interface WebformTranslationManagerInterface in Webform 6.x

Defines an interface for webform element translation classes.

Hierarchy

• interface \Drupal\webform\WebformTranslationManagerInterface

File

src/WebformTranslationManagerInterface.php, line 8

Namespace

Drupal\webform

interface WebformTranslationManagerInterface {

  /**
   * Determine if the translated webform should be displayed.
   *
   * @return bool
   *   TRUE if the translated webform should be displayed.
   */
  public function isAdminRoute();

  /**
   * Get webform elements for specific language.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   * @param string $langcode
   *   The language code for the webform elements.
   * @param bool $reset
   *   (optional) Whether to reset the translated config cache. Defaults to
   *   FALSE.
   *
   * @return array
   *   A webform's translated elements.
   */
  public function getElements(WebformInterface $webform, $langcode = NULL, $reset = FALSE);

  /**
   * Get base webform elements for the site's default language.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return array
   *   Base webform elements as a flattened associative array.
   */
  public function getBaseElements(WebformInterface $webform);

  /**
   * Get flattened associative array of translated element properties.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return array
   *   A associative array of translated element properties.
   */
  public function getSourceElements(WebformInterface $webform);

  /**
   * Get flattened associative array of translated element properties.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   * @param string $langcode
   *   The language code for the translated element properties.
   *
   * @return array
   *   A associative array of translated element properties.
   */
  public function getTranslationElements(WebformInterface $webform, $langcode);

  /**
   * Get the original langcode for a webform.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   *
   * @return string
   *   The original langcode for a webform.
   */
  public function getOriginalLangcode(WebformInterface $webform);

}

Members

Name	Modifiers	Type	Description	Overrides
WebformTranslationManagerInterface::getBaseElements	public	function	Get base webform elements for the site's default language.	1
WebformTranslationManagerInterface::getElements	public	function	Get webform elements for specific language.	1
WebformTranslationManagerInterface::getOriginalLangcode	public	function	Get the original langcode for a webform.	1
WebformTranslationManagerInterface::getSourceElements	public	function	Get flattened associative array of translated element properties.	1
WebformTranslationManagerInterface::getTranslationElements	public	function	Get flattened associative array of translated element properties.	1
WebformTranslationManagerInterface::isAdminRoute	public	function	Determine if the translated webform should be displayed.	1