interface LingotekFilterManagerInterface in Lingotek Translation 3.4.x

Service for managing Lingotek Filters.

@package Drupal\lingotek

Hierarchy

• interface \Drupal\lingotek\LingotekFilterManagerInterface

4 files declare their use of LingotekFilterManagerInterface

LingotekProfileFormBase.php in src/Form/LingotekProfileFormBase.php

LingotekSettingsTabAccountForm.php in src/Form/LingotekSettingsTabAccountForm.php

LingotekSettingsTabAccountFormTest.php in tests/src/Unit/Form/LingotekSettingsTabAccountFormTest.php

LingotekUnitTest.php in tests/src/Unit/LingotekUnitTest.php

File

src/LingotekFilterManagerInterface.php, line 10

Namespace

Drupal\lingotek

interface LingotekFilterManagerInterface {

  /**
   * Get all the locally available filters.
   *
   * @return array
   *   Keyed array with filters (id => label)
   */
  public function getLocallyAvailableFilters();

  /**
   * Get the default filter ID.
   *
   * @return string
   *   ID of the default filter.
   */
  public function getDefaultFilter();

  /**
   * Get the default subfilter ID.
   *
   * @return string
   *   ID of the default subfilter.
   */
  public function getDefaultSubfilter();

  /**
   * Get the default filter label.
   *
   * @return string
   *   ID of the default filter.
   */
  public function getDefaultFilterLabel();

  /**
   * Get the default filter label.
   *
   * @return string
   *   ID of the default filter.
   */
  public function getDefaultSubfilterLabel();

  /**
   * Gets the filter that should be applied.
   *
   * Given filter provider can take precedence, or the settings default will be
   * applied.
   *
   * @param \Drupal\lingotek\LingotekFilterProviderInterface|null $profile
   *   A filter provider.
   *
   * @return string
   *   The filter ID.
   */
  public function getFilterId(LingotekFilterProviderInterface $profile = NULL);

  /**
   * Gets the subfilter that should be applied.
   *
   * Given filter provider can take precedence, or the settings default will be
   * applied.
   *
   * @param \Drupal\lingotek\LingotekFilterProviderInterface|null $profile
   *   A filter provider.
   *
   * @return string
   *   The filter ID.
   */
  public function getSubfilterId(LingotekFilterProviderInterface $profile = NULL);

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekFilterManagerInterface::getDefaultFilter	public	function	Get the default filter ID.	1
LingotekFilterManagerInterface::getDefaultFilterLabel	public	function	Get the default filter label.	1
LingotekFilterManagerInterface::getDefaultSubfilter	public	function	Get the default subfilter ID.	1
LingotekFilterManagerInterface::getDefaultSubfilterLabel	public	function	Get the default filter label.	1
LingotekFilterManagerInterface::getFilterId	public	function	Gets the filter that should be applied.	1
LingotekFilterManagerInterface::getLocallyAvailableFilters	public	function	Get all the locally available filters.	1
LingotekFilterManagerInterface::getSubfilterId	public	function	Gets the subfilter that should be applied.	1