public function TestFieldWidget::calculateDependencies in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidget.php \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidget::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 PluginSettingsBase::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidget.php, line 86

Contains \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidget.

Class

TestFieldWidget

Plugin implementation of the 'test_field_widget' widget.

Namespace

Drupal\field_test\Plugin\Field\FieldWidget

Code

public function calculateDependencies() {
  $dependencies = parent::calculateDependencies();
  foreach ([
    'role',
    'role2',
  ] as $setting) {
    if (!empty($role_id = $this
      ->getSetting($setting))) {

      // Create a dependency on the role config entity referenced in settings.
      $dependencies['config'][] = "user.role.{$role_id}";
    }
  }
  return $dependencies;
}