abstract class PluginBase

Same name in this branch

Base class for plugins wishing to support metadata inspection.

Hierarchy

Expanded class hierarchy of PluginBase

9 files declare their use of PluginBase
JoinPluginBase.php in drupal/core/modules/views/lib/Drupal/views/Plugin/views/join/JoinPluginBase.php
Definition of Drupal\views\Plugin\views\join\JoinPluginBase.
MockLayoutBlock.php in drupal/core/modules/system/tests/modules/plugin_test/lib/Drupal/plugin_test/Plugin/plugin_test/mock_block/MockLayoutBlock.php
Definition of Drupal\plugin_test\Plugin\plugin_test\mock_block\MockLayoutBlock.
MockMenuBlock.php in drupal/core/modules/system/tests/modules/plugin_test/lib/Drupal/plugin_test/Plugin/plugin_test/mock_block/MockMenuBlock.php
Definition of Drupal\plugin_test\Plugin\plugin_test\mock_block\MockMenuBlock.
MockTestBlock.php in drupal/core/modules/system/tests/modules/plugin_test/lib/Drupal/plugin_test/Plugin/plugin_test/mock_block/MockTestBlock.php
Contains Drupal\plugin_test\Plugin\plugin_test\mock_block\MockTestBlock.
MockUserLoginBlock.php in drupal/core/modules/system/tests/modules/plugin_test/lib/Drupal/plugin_test/Plugin/plugin_test/mock_block/MockUserLoginBlock.php
Definition of Drupal\plugin_test\Plugin\plugin_test\mock_block\MockUserLoginBlock.

... See full list

File

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

Namespace

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

  /**
   * The discovery object.
   *
   * @var Drupal\Component\Plugin\Discovery\DiscoveryInterface
   */
  protected $discovery;

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

  /**
   * 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 DiscoveryInterface $discovery
   *   The Discovery class that holds access to the plugin implementation
   *   definition.
   */
  public function __construct(array $configuration, $plugin_id, DiscoveryInterface $discovery) {
    $this->configuration = $configuration;
    $this->plugin_id = $plugin_id;
    $this->discovery = $discovery;
  }

  /**
   * Implements Drupal\Component\Plugin\PluginInterface::getPluginId().
   */
  public function getPluginId() {
    return $this->plugin_id;
  }

  /**
   * Implements Drupal\Component\Plugin\PluginInterface::getDefinition().
   */
  public function getDefinition() {
    return $this->discovery
      ->getDefinition($this->plugin_id);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$discovery protected property The discovery object.
PluginBase::$plugin_id protected property The plugin_id.
PluginBase::getDefinition public function Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId public function Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 8