1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Field
  7. \
  8. PluginSettingsInterface

PluginSettingsInterface

interface PluginSettingsInterface implements PluginInspectionInterface, ThirdPartySettingsInterface (View source)

Interface definition for plugin with settings.

Merge into \Drupal\Component\Plugin\ConfigurableInterface. See https://www.drupal.org/project/drupal/issues/1764380

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

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

Sets the value of a third-party setting.

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

Gets the value of a third-party setting.

from  ThirdPartySettingsInterface
array
getThirdPartySettings(string $module)

Gets all third-party settings of a given module.

from  ThirdPartySettingsInterface
mixed
unsetThirdPartySetting(string $module, string $key)

Unsets a third-party setting.

from  ThirdPartySettingsInterface
array
getThirdPartyProviders()

Gets the list of third parties that store information.

from  ThirdPartySettingsInterface
static array
defaultSettings()

Defines the default settings for this plugin.

array
getSettings()

Returns the array of settings, including defaults for missing settings.

mixed
getSetting(string $key)

Returns the value of a setting, or its default value if absent.

$this
setSettings(array $settings)

Sets the settings for the plugin.

$this
setSetting(string $key, mixed $value)

Sets the value of a setting for the plugin.

bool
onDependencyRemoval(array $dependencies)

Informs the plugin that some configuration it depends on will be deleted.

Details

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in ThirdPartySettingsInterface 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

in ThirdPartySettingsInterface 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.

in ThirdPartySettingsInterface 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.

in ThirdPartySettingsInterface 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.

in ThirdPartySettingsInterface at line 74
array getThirdPartyProviders()

Gets the list of third parties that store information.

Return Value

array

The list of third parties.

at line 22
static array defaultSettings()

Defines the default settings for this plugin.

Return Value

array

A list of default settings, keyed by the setting name.

at line 30
array getSettings()

Returns the array of settings, including defaults for missing settings.

Return Value

array

The array of settings.

at line 41
mixed getSetting(string $key)

Returns the value of a setting, or its default value if absent.

Parameters

string $key

The setting name.

Return Value

mixed

The setting value.

at line 52
$this setSettings(array $settings)

Sets the settings for the plugin.

Parameters

array $settings

The array of settings, keyed by setting names. Missing settings will be assigned their default values.

Return Value

$this

at line 64
$this setSetting(string $key, mixed $value)

Sets the value of a setting for the plugin.

Parameters

string $key

The setting name.
mixed $value

The setting value.

Return Value

$this

at line 88
bool onDependencyRemoval(array $dependencies)

Informs the plugin that some configuration it depends on will be deleted.

This method allows plugins to keep their configuration up-to-date when a dependency calculated with ::calculateDependencies() is removed. For example, an entity view display contains a formatter having a setting pointing to an arbitrary config entity. When that config entity is deleted, this method is called by the view display to react to the dependency removal by updating its configuration.

This method must return TRUE if the removal event updated the plugin configuration or FALSE otherwise.

Parameters

array $dependencies

An array of dependencies that will be deleted keyed by dependency type. Dependency types are 'config', 'content', 'module' and 'theme'.

Return Value

bool

TRUE if the plugin configuration has changed, FALSE if not.

See also

EntityDisplayBase