You are here

public function PluginSettingsBase::calculateDependencies in Drupal 9

Same name and namespace in other branches

8 core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase::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:

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',
  ),
);

Overrides DependentPluginInterface::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

\Drupal\Core\Entity\EntityInterface::getConfigDependencyName()

6 calls to PluginSettingsBase::calculateDependencies()

CommentDefaultFormatter::calculateDependencies in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php: Calculates dependencies for the configured plugin.
ImageFormatter::calculateDependencies in core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php: Calculates dependencies for the configured plugin.
ImageWidget::calculateDependencies in core/modules/image/src/Plugin/Field/FieldWidget/ImageWidget.php: Calculates dependencies for the configured plugin.
ModerationStateWidget::calculateDependencies in core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php: Calculates dependencies for the configured plugin.
ResponsiveImageFormatter::calculateDependencies in core/modules/responsive_image/src/Plugin/Field/FieldFormatter/ResponsiveImageFormatter.php: Calculates dependencies for the configured plugin.

... See full list

6 methods override PluginSettingsBase::calculateDependencies()

CommentDefaultFormatter::calculateDependencies in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php: Calculates dependencies for the configured plugin.
ImageFormatter::calculateDependencies in core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php: Calculates dependencies for the configured plugin.
ImageWidget::calculateDependencies in core/modules/image/src/Plugin/Field/FieldWidget/ImageWidget.php: Calculates dependencies for the configured plugin.
ModerationStateWidget::calculateDependencies in core/modules/content_moderation/src/Plugin/Field/FieldWidget/ModerationStateWidget.php: Calculates dependencies for the configured plugin.
ResponsiveImageFormatter::calculateDependencies in core/modules/responsive_image/src/Plugin/Field/FieldFormatter/ResponsiveImageFormatter.php: Calculates dependencies for the configured plugin.

... See full list

File

core/lib/Drupal/Core/Field/PluginSettingsBase.php, line 140

Class

PluginSettingsBase: Base class for the Field API plugins.

Namespace

Drupal\Core\Field

Code

public function calculateDependencies() {
  if (!empty($this->thirdPartySettings)) {

    // Create dependencies on any modules providing third party settings.
    return [
      'module' => array_keys($this->thirdPartySettings),
    ];
  }
  return [];
}