abstract class AggregatorPluginSettingsBase in Drupal 9

Base class for aggregator plugins that implement settings forms.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\aggregator\Plugin\AggregatorPluginSettingsBase implements ConfigurableInterface, DependentPluginInterface, PluginFormInterface

See also

\Drupal\aggregator\Annotation\AggregatorParser

\Drupal\aggregator\Annotation\AggregatorFetcher

\Drupal\aggregator\Annotation\AggregatorProcessor

\Drupal\aggregator\Plugin\AggregatorPluginManager

\Drupal\aggregator\Plugin\FetcherInterface

\Drupal\aggregator\Plugin\ProcessorInterface

\Drupal\aggregator\Plugin\ParserInterface

Plugin API

2 files declare their use of AggregatorPluginSettingsBase

DefaultProcessor.php in core/modules/aggregator/src/Plugin/aggregator/processor/DefaultProcessor.php

TestProcessor.php in core/modules/aggregator/tests/modules/aggregator_test/src/Plugin/aggregator/processor/TestProcessor.php

File

core/modules/aggregator/src/Plugin/AggregatorPluginSettingsBase.php, line 23

Namespace

Drupal\aggregator\Plugin

abstract class AggregatorPluginSettingsBase extends PluginBase implements PluginFormInterface, ConfigurableInterface, DependentPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AggregatorPluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
AggregatorPluginSettingsBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
AggregatorPluginSettingsBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	15
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	15
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.	98
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	37
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.