1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Config
  7. \
  8. Entity
  9. \
  10. ThirdPartySettingsInterface

ThirdPartySettingsInterface

interface ThirdPartySettingsInterface (View source)

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.

Methods

$this
setThirdPartySetting(string $module, string $key, mixed $value)

Sets the value of a third-party setting.

mixed
getThirdPartySetting(string $module, string $key, mixed $default = NULL)

Gets the value of a third-party setting.

array
getThirdPartySettings(string $module)

Gets all third-party settings of a given module.

mixed
unsetThirdPartySetting(string $module, string $key)

Unsets a third-party setting.

array
getThirdPartyProviders()

Gets the list of third parties that store information.

Details

at line 27
$this setThirdPartySetting(string $module, string $key, mixed $value)

Sets the value of a third-party setting.

Parameters

string $module

The module providing the third-party setting.
string $key

The setting name.
mixed $value

The setting value.

Return Value

$this

at line 42
mixed getThirdPartySetting(string $module, string $key, mixed $default = NULL)

Gets the value of a third-party setting.

Parameters

string $module

The module providing the third-party setting.
string $key

The setting name.
mixed $default

The default value

Return Value

mixed

The value.

at line 53
array getThirdPartySettings(string $module)

Gets all third-party settings of a given module.

Parameters

string $module

The module providing the third-party settings.

Return Value

array

An array of key-value pairs.

at line 66
mixed unsetThirdPartySetting(string $module, string $key)

Unsets a third-party setting.

Parameters

string $module

The module providing the third-party setting.
string $key

The setting name.

Return Value

mixed

The value.

at line 74
array getThirdPartyProviders()

Gets the list of third parties that store information.

Return Value

array

The list of third parties.