1. interface
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. ConfigurablePluginInterface

ConfigurablePluginInterface deprecated

interface ConfigurablePluginInterface implements DependentPluginInterface (View source)

deprecated Drupal\Component\Plugin\ConfigurablePluginInterface is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. You should implement ConfigurableInterface and/or DependentPluginInterface directly as needed. If you implement ConfigurableInterface you may choose to implement ConfigurablePluginInterface in Drupal 8 as well for maximum compatibility, however this must be removed prior to Drupal 9.

Provides an interface for a configurable plugin.

Methods

array
calculateDependencies()

Calculates dependencies for the configured plugin.

from  DependentPluginInterface
array
getConfiguration()

Gets this plugin's configuration.

setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

array
defaultConfiguration()

Gets default configuration for this plugin.

Details

in DependentPluginInterface at line 35
array calculateDependencies()

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Return Value

array

An array of dependencies grouped by type (config, content, module, theme). For example: @code array( 'config' => array('user.role.anonymous', 'user.role.authenticated'), 'content' => array('node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d'), 'module' => array('node', 'user'), 'theme' => array('seven'), ); @endcode

See also

ConfigDependencyManager
EntityInterface::getConfigDependencyName

at line 27
array getConfiguration()

Gets this plugin's configuration.

Return Value

array

An array of this plugin's configuration.

at line 35
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

Parameters

array $configuration

An associative array containing the plugin's configuration.

at line 43
array defaultConfiguration()

Gets default configuration for this plugin.

Return Value

array

An associative array with the default configuration.