DerivablePluginDefinitionInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php
  2. 8.9.x core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php
  3. 10 core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php

Namespace

Drupal\Component\Plugin\Definition

File

core/lib/Drupal/Component/Plugin/Definition/DerivablePluginDefinitionInterface.php

View source
<?php

namespace Drupal\Component\Plugin\Definition;


/**
 * Provides an interface for a derivable plugin definition.
 *
 * @see \Drupal\Component\Plugin\Derivative\DeriverInterface
 */
interface DerivablePluginDefinitionInterface extends PluginDefinitionInterface {
    
    /**
     * Gets the name of the deriver of this plugin definition, if it exists.
     *
     * @return class-string|null
     *   Either the deriver class name, or NULL if the plugin is not derived.
     */
    public function getDeriver();
    
    /**
     * Sets the deriver of this plugin definition.
     *
     * @param class-string|null $deriver
     *   Either the name of a class that implements
     *   \Drupal\Component\Plugin\Derivative\DeriverInterface, or NULL.
     *
     * @return $this
     */
    public function setDeriver($deriver);

}

Interfaces

Title Deprecated Summary
DerivablePluginDefinitionInterface Provides an interface for a derivable plugin definition.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.