You are here

public static function FieldItemInterface::calculateStorageDependencies in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::calculateStorageDependencies()
  2. 10 core/lib/Drupal/Core/Field/FieldItemInterface.php \Drupal\Core\Field\FieldItemInterface::calculateStorageDependencies()

Calculates dependencies for field items on the storage level.

Dependencies are saved in the field storage configuration entity and are used to determine configuration synchronization order. For example, if the field type storage depends on a particular entity type, this method should return an array of dependencies listing the module that provides the entity type.

Dependencies returned from this method are stored in field storage configuration and are always considered hard dependencies. If the dependency is removed the field storage configuration must be deleted.

Parameters

\Drupal\Core\Field\FieldStorageDefinitionInterface $field_storage_definition: The field storage definition.

Return value

array An array of dependencies grouped by type (config, content, module, theme). For example:

[
  'config' => [
    'user.role.anonymous',
    'user.role.authenticated',
  ],
  'content' => [
    'node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d',
  ],
  'module' => [
    'node',
    'user',
  ],
  'theme' => [
    'seven',
  ],
];

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

\Drupal\Core\Config\Entity\ConfigEntityInterface::getConfigDependencyName()

1 method overrides FieldItemInterface::calculateStorageDependencies()
FieldItemBase::calculateStorageDependencies in core/lib/Drupal/Core/Field/FieldItemBase.php
Calculates dependencies for field items on the storage level.

File

core/lib/Drupal/Core/Field/FieldItemInterface.php, line 447

Class

FieldItemInterface
Interface for entity field items.

Namespace

Drupal\Core\Field

Code

public static function calculateStorageDependencies(FieldStorageDefinitionInterface $field_storage_definition);