public function ImageWidget::calculateDependencies in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/image/src/Plugin/Field/FieldWidget/ImageWidget.php \Drupal\image\Plugin\Field\FieldWidget\ImageWidget::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/image/src/Plugin/Field/FieldWidget/ImageWidget.php, line 303

Class

ImageWidget

Plugin implementation of the 'image_image' widget.

Namespace

Drupal\image\Plugin\Field\FieldWidget

Code

public function calculateDependencies() {
  $dependencies = parent::calculateDependencies();
  $style_id = $this
    ->getSetting('preview_image_style');

  /** @var \Drupal\image\ImageStyleInterface $style */
  if ($style_id && ($style = ImageStyle::load($style_id))) {

    // If this widget uses a valid image style to display the preview of the
    // uploaded image, add that image style configuration entity as dependency
    // of this widget.
    $dependencies[$style
      ->getConfigDependencyKey()][] = $style
      ->getConfigDependencyName();
  }
  return $dependencies;
}