abstract class FormatterTypeBase in Custom Formatters 8.3
Class FormatterTypeBase.
@package Drupal\custom_formatters
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\custom_formatters\FormatterTypeBase implements FormatterTypeInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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_formattersView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterTypeBase:: |
protected | property | The Formatter entity. | |
FormatterTypeBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides FormatterTypeInterface:: |
1 |
FormatterTypeBase:: |
public | function | Acts on loaded entities. | |
FormatterTypeBase:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | |
FormatterTypeBase:: |
public | function | 4 | |
FormatterTypeBase:: |
public | function |
Formatter type plugin settings form submit callback. Overrides FormatterTypeInterface:: |
1 |
FormatterTypeBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
FormatterTypeInterface:: |
public | function | Builds a renderable array for a field value. | 4 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |