You are here

public function PhotoswipeResponsiveFieldFormatter::calculateDependencies in PhotoSwipe 3.x

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 PhotoswipeFieldFormatter::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/Field/FieldFormatter/PhotoswipeResponsiveFieldFormatter.php, line 78

Class

PhotoswipeResponsiveFieldFormatter
Provides formatter that supports responsive image.

Namespace

Drupal\photoswipe\Plugin\Field\FieldFormatter

Code

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

  /** @var \Drupal\responsive_image\ResponsiveImageStyleInterface $style */
  if ($resp_style_id && ($style = ResponsiveImageStyle::load($resp_style_id))) {

    // Add the responsive image style as dependency.
    $dependencies[$style
      ->getConfigDependencyKey()][] = $style
      ->getConfigDependencyName();
  }
  if (!empty($this
    ->getSetting('photoswipe_node_style_first'))) {
    $resp_style_id = $this
      ->getSetting('photoswipe_node_style_first');

    /** @var \Drupal\responsive_image\ResponsiveImageStyleInterface $style */
    if ($resp_style_id && ($style = ResponsiveImageStyle::load($resp_style_id))) {

      // Add the responsive image style as dependency.
      $dependencies[$style
        ->getConfigDependencyKey()][] = $style
        ->getConfigDependencyName();
    }
  }
  $style_id = $this
    ->getSetting('photoswipe_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;
}