abstract class PluginDefinition in Plugin 8.2

Provides a plugin definition.

Hierarchy

• class \Drupal\plugin\PluginDefinition\PluginDefinition implements PluginDefinitionInterface uses MergeablePluginDefinitionTrait

1 file declares its use of PluginDefinition

PluginDefinitionTest.php in tests/src/Unit/PluginDefinition/PluginDefinitionTest.php

File

src/PluginDefinition/PluginDefinition.php, line 10

Namespace

Drupal\plugin\PluginDefinition

abstract class PluginDefinition implements PluginDefinitionInterface {
  use MergeablePluginDefinitionTrait;

  /**
   * The plugin ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The class.
   *
   * @var string
   *   A fully qualified class name.
   */
  protected $class;

  /**
   * The plugin provider.
   *
   * @var string|null
   */
  protected $provider;

  /**
   * {@inheritdoc}
   */
  public function setId($id) {
    $this->id = $id;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getId() {
    return $this->id;
  }

  /**
   * {@inheritdoc}
   */
  public function setClass($class) {
    PluginDefinitionValidator::validateClass($class);
    $this->class = $class;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getClass() {
    return $this->class;
  }

  /**
   * {@inheritdoc}
   */
  public function setProvider($provider) {
    $this->provider = $provider;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider() {
    return $this->provider;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MergeablePluginDefinitionTrait::doMergeDefaultDefinition	protected	function	Merges another definition into this one, using the other for defaults.	1
MergeablePluginDefinitionTrait::doMergeOverrideDefinition	protected	function	Merges another definition into this one, using the other for overrides.	1
MergeablePluginDefinitionTrait::isDefinitionCompatible	abstract protected	function	Returns whether another definition is compatible with this one.	1
MergeablePluginDefinitionTrait::mergeDefaultDefinition	public	function	Implements \Drupal\plugin\PluginDefinition\PluginDefinitionInterface::mergeDefaultDefinition().
MergeablePluginDefinitionTrait::mergeOverrideDefinition	public	function	Implements \Drupal\plugin\PluginDefinition\PluginDefinitionInterface::mergeOverrideDefinition().
MergeablePluginDefinitionTrait::validateMergeDefinition	protected	function	Validates whether another definition is compatible with this one.
PluginDefinition::$class	protected	property	The class.
PluginDefinition::$id	protected	property	The plugin ID.
PluginDefinition::$provider	protected	property	The plugin provider.
PluginDefinition::getClass	public	function	Gets the class. Overrides PluginDefinitionInterface::getClass
PluginDefinition::getId	public	function	Gets the plugin ID. Overrides PluginDefinitionInterface::getId
PluginDefinition::getProvider	public	function	Gets the plugin provider. Overrides PluginDefinitionInterface::getProvider
PluginDefinition::setClass	public	function	Sets the class. Overrides PluginDefinitionInterface::setClass
PluginDefinition::setId	public	function	Sets the plugin ID. Overrides PluginDefinitionInterface::setId
PluginDefinition::setProvider	public	function	Sets the plugin provider. Overrides PluginDefinitionInterface::setProvider
PluginDefinitionInterface::id	public	function	Gets the unique identifier of the plugin.	1