Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Component/Plugin/DependentPluginInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\Plugin\DependentPluginInterface.
6	*/
7
8	namespace Drupal\Component\Plugin;
9
10	/**
11	* Provides an interface for a plugin that has dependencies.
12	*
13	* @ingroup plugin_api
14	*/
15	interface DependentPluginInterface {
16
17	/**
18	* Calculates dependencies for the configured plugin.
19	*
20	* Dependencies are saved in the plugin's configuration entity and are used to
21	* determine configuration synchronization order. For example, if the plugin
22	* integrates with specific user roles, this method should return an array of
23	* dependencies listing the specified roles.
24	*
25	* @return array
26	* An array of dependencies grouped by type (config, content, module,
27	* theme). For example:
28	* @code
29	* array(
30	* 'config' => array('user.role.anonymous', 'user.role.authenticated'),
31	* 'content' => array('node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d'),
32	* 'module' => array('node', 'user'),
33	* 'theme' => array('seven'),
34	* );
35	* @endcode
36	*
37	* @see \Drupal\Core\Config\Entity\ConfigDependencyManager
38	* @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
39	*/
40	public function calculateDependencies();
41
42	}