interface PluginSettingsInterface in Drupal 10

Interface definition for plugin with settings.

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

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface
  • interface \Drupal\Core\Field\PluginSettingsInterface

2 files declare their use of PluginSettingsInterface

EntityDisplayFormBase.php in core/modules/field_ui/src/Form/EntityDisplayFormBase.php

EntityFormDisplayEditForm.php in core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php

File

core/lib/Drupal/Core/Field/PluginSettingsInterface.php, line 14

Namespace

Drupal\Core\Field

interface PluginSettingsInterface extends PluginInspectionInterface, ThirdPartySettingsInterface {

  /**
   * Defines the default settings for this plugin.
   *
   * @return array
   *   A list of default settings, keyed by the setting name.
   */
  public static function defaultSettings();

  /**
   * Returns the array of settings, including defaults for missing settings.
   *
   * @return array
   *   The array of settings.
   */
  public function getSettings();

  /**
   * Returns the value of a setting, or its default value if absent.
   *
   * @param string $key
   *   The setting name.
   *
   * @return mixed
   *   The setting value.
   */
  public function getSetting($key);

  /**
   * Sets the settings for the plugin.
   *
   * @param array $settings
   *   The array of settings, keyed by setting names. Missing settings will be
   *   assigned their default values.
   *
   * @return $this
   */
  public function setSettings(array $settings);

  /**
   * Sets the value of a setting for the plugin.
   *
   * @param string $key
   *   The setting name.
   * @param mixed $value
   *   The setting value.
   *
   * @return $this
   */
  public function setSetting($key, $value);

  /**
   * 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.
   *
   * @param array $dependencies
   *   An array of dependencies that will be deleted keyed by dependency type.
   *   Dependency types are 'config', 'content', 'module' and 'theme'.
   *
   * @return bool
   *   TRUE if the plugin configuration has changed, FALSE if not.
   *
   * @see \Drupal\Core\Entity\EntityDisplayBase
   */
  public function onDependencyRemoval(array $dependencies);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	1
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	1
PluginSettingsInterface::defaultSettings	public static	function	Defines the default settings for this plugin.	1
PluginSettingsInterface::getSetting	public	function	Returns the value of a setting, or its default value if absent.	1
PluginSettingsInterface::getSettings	public	function	Returns the array of settings, including defaults for missing settings.	1
PluginSettingsInterface::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted.	1
PluginSettingsInterface::setSetting	public	function	Sets the value of a setting for the plugin.	1
PluginSettingsInterface::setSettings	public	function	Sets the settings for the plugin.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	4
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	4
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	4
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	4
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	4