Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Plugin;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides an interface for a plugin that has dependencies.
Chris@0:  *
Chris@0:  * @ingroup plugin_api
Chris@0:  */
Chris@0: interface DependentPluginInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Calculates dependencies for the configured plugin.
Chris@0:    *
Chris@0:    * Dependencies are saved in the plugin's configuration entity and are used to
Chris@0:    * determine configuration synchronization order. For example, if the plugin
Chris@0:    * integrates with specific user roles, this method should return an array of
Chris@0:    * dependencies listing the specified roles.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An array of dependencies grouped by type (config, content, module,
Chris@0:    *   theme). For example:
Chris@0:    *   @code
Chris@0:    *   array(
Chris@0:    *     'config' => array('user.role.anonymous', 'user.role.authenticated'),
Chris@0:    *     'content' => array('node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d'),
Chris@0:    *     'module' => array('node', 'user'),
Chris@0:    *     'theme' => array('seven'),
Chris@0:    *   );
Chris@0:    *   @endcode
Chris@0:    *
Chris@0:    * @see \Drupal\Core\Config\Entity\ConfigDependencyManager
Chris@0:    * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName()
Chris@0:    */
Chris@0:   public function calculateDependencies();
Chris@0: 
Chris@0: }