public function PluginSettingsBase::calculateDependencies in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 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()

1 call to PluginSettingsBase::calculateDependencies()

TestFieldWidget::calculateDependencies in core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidget.php

Calculates dependencies for the configured plugin.

1 method overrides PluginSettingsBase::calculateDependencies()

TestFieldWidget::calculateDependencies in core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidget.php

Calculates dependencies for the configured plugin.

File

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

Contains \Drupal\Core\Field\PluginSettingsBase.

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 array(
      'module' => array_keys($this->thirdPartySettings),
    );
  }
  return array();
}