You are here

public function DsFieldBase::calculateDependencies in Display Suite 8.2

Same name and namespace in other branches
  1. 8.4 src/Plugin/DsField/DsFieldBase.php \Drupal\ds\Plugin\DsField\DsFieldBase::calculateDependencies()
  2. 8.3 src/Plugin/DsField/DsFieldBase.php \Drupal\ds\Plugin\DsField\DsFieldBase::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 DependentPluginInterface::calculateDependencies

See also

\Drupal\Core\Config\Entity\ConfigDependencyManager

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

File

src/Plugin/DsField/DsFieldBase.php, line 169

Class

DsFieldBase
Base class for all the ds plugins.

Namespace

Drupal\ds\Plugin\DsField

Code

public function calculateDependencies() {

  // By default there are no dependencies.
  return array();
}