interface ThirdPartySettingsInterface in Drupal 8

Interface for configuration entities to store third party information.

A third party is a module that needs to store tightly coupled information to the configuration entity. For example, a module that alters the node type form can use this to store its configuration so that it will be deployed with the node type.

Hierarchy

• interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface

5 files declare their use of ThirdPartySettingsInterface

content_translation.admin.inc in core/modules/content_translation/content_translation.admin.inc

The content translation administration forms.

DefaultsSectionStorageInterface.php in core/modules/layout_builder/src/DefaultsSectionStorageInterface.php

FieldTranslationSynchronizer.php in core/modules/content_translation/src/FieldTranslationSynchronizer.php

PluginSettingsInterface.php in core/lib/Drupal/Core/Field/PluginSettingsInterface.php

Section.php in core/modules/layout_builder/src/Section.php

File

core/lib/Drupal/Core/Config/Entity/ThirdPartySettingsInterface.php, line 13

Namespace

Drupal\Core\Config\Entity

interface ThirdPartySettingsInterface {

  /**
   * Sets the value of a third-party setting.
   *
   * @param string $module
   *   The module providing the third-party setting.
   * @param string $key
   *   The setting name.
   * @param mixed $value
   *   The setting value.
   *
   * @return $this
   */
  public function setThirdPartySetting($module, $key, $value);

  /**
   * Gets the value of a third-party setting.
   *
   * @param string $module
   *   The module providing the third-party setting.
   * @param string $key
   *   The setting name.
   * @param mixed $default
   *   The default value
   *
   * @return mixed
   *   The value.
   */
  public function getThirdPartySetting($module, $key, $default = NULL);

  /**
   * Gets all third-party settings of a given module.
   *
   * @param string $module
   *   The module providing the third-party settings.
   *
   * @return array
   *   An array of key-value pairs.
   */
  public function getThirdPartySettings($module);

  /**
   * Unsets a third-party setting.
   *
   * @param string $module
   *   The module providing the third-party setting.
   * @param string $key
   *   The setting name.
   *
   * @return mixed
   *   The value.
   */
  public function unsetThirdPartySetting($module, $key);

  /**
   * Gets the list of third parties that store information.
   *
   * @return array
   *   The list of third parties.
   */
  public function getThirdPartyProviders();

}

Members

Name	Modifiers	Type	Description	Overrides
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5