abstract class PluginBase

Same name in this branch

Base class for plugins wishing to support metadata inspection.

Hierarchy

Expanded class hierarchy of PluginBase

24 files declare their use of PluginBase
BlockBase.php in drupal/core/modules/block/lib/Drupal/block/BlockBase.php
Contains \Drupal\block\BlockBase.
CKEditorPluginBase.php in drupal/core/modules/ckeditor/lib/Drupal/ckeditor/CKEditorPluginBase.php
Contains \Drupal\ckeditor\Plugin\CKEditorPluginBase.
ContainerFactoryPluginBase.php in drupal/core/lib/Drupal/Core/Plugin/ContainerFactoryPluginBase.php
Contains \Drupal\Core\Plugin\ContainerFactoryPluginBase.
DefaultProcessor.php in drupal/core/modules/aggregator/lib/Drupal/aggregator/Plugin/aggregator/processor/DefaultProcessor.php
Contains \Drupal\aggregator\Plugin\aggregator\processor\DefaultProcessor.
Editor.php in drupal/core/modules/editor/lib/Drupal/editor/Plugin/InPlaceEditor/Editor.php
Contains \Drupal\editor\Plugin\InPlaceEditor\Editor.

... See full list

File

drupal/core/lib/Drupal/Component/Plugin/PluginBase.php, line 12
Definition of Drupal\Component\Plugin\PluginBase

Namespace

Drupal\Component\Plugin
View source
abstract class PluginBase implements PluginInspectionInterface {

  /**
   * The plugin_id.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * The plugin implementation definition.
   *
   * @var array
   */
  protected $pluginDefinition;

  /**
   * Configuration information passed into the plugin.
   *
   * @var array
   */
  protected $configuration;

  /**
   * Constructs a Drupal\Component\Plugin\PluginBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    $this->configuration = $configuration;
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
  }

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

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

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 17