public function SvgImageWidget::calculateDependencies in Svg Image 1.x

Same name and namespace in other branches

1. 8 src/Plugin/Field/FieldWidget/SvgImageWidget.php \Drupal\svg_image\Plugin\Field\FieldWidget\SvgImageWidget::calculateDependencies()
2. 2.x src/Plugin/Field/FieldWidget/SvgImageWidget.php \Drupal\svg_image\Plugin\Field\FieldWidget\SvgImageWidget::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

src/Plugin/Field/FieldWidget/SvgImageWidget.php, line 325

Class

SvgImageWidget

Override plugin of the 'image_image' widget.

Namespace

Drupal\svg_image\Plugin\Field\FieldWidget

Code

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

    /** @var \Drupal\image\ImageStyleStorage $imageStyleStorage */
    $style = $this->imageStyleStorage
      ->load($styleId);
    if ($style) {

      // 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;
}