Drupal 8  8.0.2
DependentPluginInterface Interface Reference
Inheritance diagram for DependentPluginInterface:

Public Member Functions

 calculateDependencies ()
 

Detailed Description

Provides an interface for a plugin that has dependencies.

Member Function Documentation

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.

Returns
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'),
);
See Also
::getConfigDependencyName()

Implemented in ArgumentPluginBase, DisplayPluginBase, Field, Page, PluginBase, TaxonomyIndexTid, Tid, Entity, EntityRow, Entity, RelationshipPluginBase, Entity, DrupalSqlBase, ImageEffectBase, NodeTermData, View, QueryTest, PluginSettingsBase, DisplayTest, Role, QueryPluginBase, FilterBase, Bundle, StyleTest, ConditionPluginBase, BlockBase, User, VariantBase, Config, RssPluginBase, ChangeUserRoleBase, RowTest, TestFieldWidget, Roles, EntityFieldStorageConfig, ViewMode, ConfigurableSearchPluginBase, EmptySource, ConfigurableActionBase, StaticTest, AggregatorPluginSettingsBase, ArgumentDefaultTest, TestConfigurablePlugin, and ArgumentValidatorTest.


The documentation for this interface was generated from the following file: