Mercurial > hg > isophonics-drupal-site
view core/lib/Drupal/Component/Plugin/DependentPluginInterface.php @ 17:129ea1e6d783
Update, including to Drupal core 8.6.10
author | Chris Cannam |
---|---|
date | Thu, 28 Feb 2019 13:21:36 +0000 |
parents | 4c8ae668cc8c |
children |
line wrap: on
line source
<?php namespace Drupal\Component\Plugin; /** * Provides an interface for a plugin that has dependencies. * * @ingroup plugin_api */ interface DependentPluginInterface { /** * 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 array * An array of dependencies grouped by type (config, content, module, * theme). For example: * @code * 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'), * ); * @endcode * * @see \Drupal\Core\Config\Entity\ConfigDependencyManager * @see \Drupal\Core\Entity\EntityInterface::getConfigDependencyName() */ public function calculateDependencies(); }