You are here

abstract class PluginBase in Drupal 8

Same name in this branch
  1. 8 core/lib/Drupal/Core/Plugin/PluginBase.php \Drupal\Core\Plugin\PluginBase
  2. 8 core/lib/Drupal/Component/Plugin/PluginBase.php \Drupal\Component\Plugin\PluginBase
  3. 8 core/modules/views/src/Plugin/views/PluginBase.php \Drupal\views\Plugin\views\PluginBase
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Plugin/PluginBase.php \Drupal\Core\Plugin\PluginBase

Base class for plugins supporting metadata inspection and translation.

Hierarchy

Expanded class hierarchy of PluginBase

Related topics

36 files declare their use of PluginBase
ActionBase.php in core/lib/Drupal/Core/Action/ActionBase.php
AggregatorPluginSettingsBase.php in core/modules/aggregator/src/Plugin/AggregatorPluginSettingsBase.php
Breakpoint.php in core/modules/breakpoint/src/Breakpoint.php
Broken.php in core/lib/Drupal/Core/Block/Plugin/Block/Broken.php
CKEditorPluginBase.php in core/modules/ckeditor/src/CKEditorPluginBase.php

... See full list

File

core/lib/Drupal/Core/Plugin/PluginBase.php, line 15

Namespace

Drupal\Core\Plugin
View source
abstract class PluginBase extends ComponentPluginBase {
  use StringTranslationTrait;
  use DependencySerializationTrait;
  use MessengerTrait;

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.