interface PluginConfigDependenciesDefinitionInterface in Plugin 8.2

Defines a plugin definition that includes config dependencies.

Hierarchy

• interface \Drupal\Component\Plugin\Definition\PluginDefinitionInterface
  • interface \Drupal\plugin\PluginDefinition\PluginDefinitionInterface
    • interface \Drupal\plugin\PluginDefinition\PluginConfigDependenciesDefinitionInterface

File

src/PluginDefinition/PluginConfigDependenciesDefinitionInterface.php, line 10

Namespace

Drupal\plugin\PluginDefinition

interface PluginConfigDependenciesDefinitionInterface extends PluginDefinitionInterface {

  /**
   * Sets the dependencies.
   *
   * @param array[] $dependencies.
   *   An array of dependencies keyed by the type of dependency. One example:
   *   @code
   *   array(
   *     'module' => array(
   *       'node',
   *       'field',
   *       'image',
   *     ),
   *   );
   *   @endcode
   *
   * @return $this
   */
  public function setConfigDependencies(array $dependencies);

  /**
   * Gets the dependencies.
   *
   * @return array[]
   *   See self::setConfigDependencies().
   */
  public function getConfigDependencies();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginConfigDependenciesDefinitionInterface::getConfigDependencies	public	function	Gets the dependencies.	1
PluginConfigDependenciesDefinitionInterface::setConfigDependencies	public	function	Sets the dependencies.	1
PluginDefinitionInterface::getClass	public	function	Gets the class.	1
PluginDefinitionInterface::getId	public	function	Gets the plugin ID.	2
PluginDefinitionInterface::getProvider	public	function	Gets the plugin provider. Overrides PluginDefinitionInterface::getProvider	2
PluginDefinitionInterface::id	public	function	Gets the unique identifier of the plugin.	1
PluginDefinitionInterface::mergeDefaultDefinition	public	function	Merges another definition into this one, using the other for defaults.
PluginDefinitionInterface::mergeOverrideDefinition	public	function	Merges another definition into this one, using the other for overrides.
PluginDefinitionInterface::setClass	public	function	Sets the class.	1
PluginDefinitionInterface::setId	public	function	Sets the plugin ID.	2
PluginDefinitionInterface::setProvider	public	function	Sets the plugin provider.	2