public function ImageFormatter::calculateDependencies in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::calculateDependencies()
2. 10 core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatter.php \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::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/FieldFormatter/ImageFormatter.php, line 248

Class

ImageFormatter

Plugin implementation of the 'image' formatter.

Namespace

Drupal\image\Plugin\Field\FieldFormatter

Code

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

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

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