You are here

abstract class EmptyFieldPluginBase in Empty fields 8

Defines a base empty field item implementation.

Hierarchy

Expanded class hierarchy of EmptyFieldPluginBase

See also

\Drupal\empty_fields\Annotation\EmptyField

\Drupal\empty_fields\EmptyFieldPluginInterface

\Drupal\empty_fields\EmptyFieldsPluginManager

Plugin API

3 files declare their use of EmptyFieldPluginBase
Broken.php in src/Plugin/EmptyFields/Broken.php
EmptyFieldNbsp.php in src/Plugin/EmptyFields/EmptyFieldNbsp.php
EmptyFieldText.php in src/Plugin/EmptyFields/EmptyFieldText.php

File

src/EmptyFieldPluginBase.php, line 18

Namespace

Drupal\empty_fields
View source
abstract class EmptyFieldPluginBase extends PluginBase implements EmptyFieldPluginInterface, ConfigurableInterface {

  /**
   * {@inheritdoc}
   */
  public abstract function react(array $content);

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public abstract function settingsSummary();

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

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this
      ->defaultConfiguration(), $configuration);
  }

}

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
EmptyFieldPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 1
EmptyFieldPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EmptyFieldPluginBase::react abstract public function Builds render array for empty field. Overrides EmptyFieldPluginInterface::react 3
EmptyFieldPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EmptyFieldPluginBase::settingsForm public function Returns the configuration form elements specific to this plugin. Overrides EmptyFieldPluginInterface::settingsForm 1
EmptyFieldPluginBase::settingsSummary abstract public function Returns a short summary line for the current formatter settings. Overrides EmptyFieldPluginInterface::settingsSummary 3
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.