You are here

abstract class FormatterTypeBase in Custom Formatters 8.3

Class FormatterTypeBase.

@package Drupal\custom_formatters

Hierarchy

Expanded class hierarchy of FormatterTypeBase

4 files declare their use of FormatterTypeBase
FormatterPreset.php in src/Plugin/CustomFormatters/FormatterType/FormatterPreset.php
HTMLToken.php in src/Plugin/CustomFormatters/FormatterType/HTMLToken.php
PHP.php in src/Plugin/CustomFormatters/FormatterType/PHP.php
Twig.php in src/Plugin/CustomFormatters/FormatterType/Twig.php

File

src/FormatterTypeBase.php, line 13

Namespace

Drupal\custom_formatters
View source
abstract class FormatterTypeBase extends PluginBase implements FormatterTypeInterface {

  /**
   * The Formatter entity.
   *
   * @var \Drupal\custom_formatters\FormatterInterface
   */
  protected $entity = NULL;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    $this->entity = $configuration['entity'];
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array &$form, FormStateInterface $form_state) {
    $form['data'] = [
      '#title' => $this
        ->t('Formatter'),
      '#type' => 'textarea',
      '#default_value' => $this->entity
        ->get('data'),
      '#required' => TRUE,
      '#rows' => 10,
    ];
    return $form;
  }

  /**
   * Acts on loaded entities.
   */
  public function postLoad() {
  }

  /**
   * Acts on a saved entity before the insert or update hook is invoked.
   *
   * Used after the entity is saved, but before invoking the insert or update
   * hook. Note that in case of translatable content entities this callback is
   * only fired on their current translation. It is up to the developer to
   * iterate over all translations if needed.
   */
  public function preSave() {
  }

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

}

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
FormatterTypeBase::$entity protected property The Formatter entity.
FormatterTypeBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides FormatterTypeInterface::calculateDependencies 1
FormatterTypeBase::postLoad public function Acts on loaded entities.
FormatterTypeBase::preSave public function Acts on a saved entity before the insert or update hook is invoked.
FormatterTypeBase::settingsForm public function 4
FormatterTypeBase::submitForm public function Formatter type plugin settings form submit callback. Overrides FormatterTypeInterface::submitForm 1
FormatterTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
FormatterTypeInterface::viewElements public function Builds a renderable array for a field value. 4
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.
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.