abstract class ComputedPhpFormatterBase in Computed Field 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldFormatter/ComputedPhpFormatterBase.php \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedPhpFormatterBase
Base class for own php-formatter
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedFormatterBase uses ComputedCacheFormatterTrait
- class \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedStringFormatter
- class \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedPhpFormatterBase
- class \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedStringFormatter
- class \Drupal\computed_field\Plugin\Field\FieldFormatter\ComputedFormatterBase uses ComputedCacheFormatterTrait
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ComputedPhpFormatterBase
1 file declares its use of ComputedPhpFormatterBase
- ComputedPhpFormatterExample.php in computed_field_example_formatter/
src/ Plugin/ Field/ FieldFormatter/ ComputedPhpFormatterExample.php - Contains \Drupal\Core\Field\Plugin\Field\FieldFormatter\ComputedPhpFormatterExample.
File
- src/
Plugin/ Field/ FieldFormatter/ ComputedPhpFormatterBase.php, line 11
Namespace
Drupal\computed_field\Plugin\Field\FieldFormatterView source
abstract class ComputedPhpFormatterBase extends ComputedStringFormatter {
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode = NULL) {
$cache_duration = $this
->getSetting('cache_duration');
$cache_unit = $this
->getSetting('cache_unit');
$elements = [];
foreach ($items as $delta => $item) {
if ($cache_unit < 0) {
$elements[$delta] = [
'#markup' => $this
->prepareValue($this
->formatItem($item->value, $item, $delta, $langcode)),
];
}
else {
$value = $this
->prepareValue($item
->executeCode());
$elements[$delta] = [
'#markup' => $this
->prepareValue($this
->formatItem($item
->executeCode(), $item, $delta, $langcode)),
'#cache' => [
'keys' => [
$items
->getEntity()
->getEntityTypeId(),
$items
->getEntity()
->bundle(),
$this->viewMode,
],
'max-age' => $cache_duration * $cache_unit,
],
];
}
}
return $elements;
}
/**
* Do something with the value before displaying it.
*
* @param mixed $value
* The (computed) value of the item.
* @param \Drupal\Core\Field\FieldItemInterface $item
* The item to format for output
* @param int $delta
* The delta value (index) of the item in case of multiple items
* @param string $langcode
* The language code
* @return mixed
*/
public function formatItem($value, FieldItemInterface $item, $delta = 0, $langcode = NULL) {
return $value;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComputedCacheFormatterTrait:: |
private static | function | List of time options and their factor in seconds to calculate cache seconds | |
ComputedPhpFormatterBase:: |
public | function | Do something with the value before displaying it. | 1 |
ComputedPhpFormatterBase:: |
public | function |
Builds a renderable array for a field value. Overrides ComputedFormatterBase:: |
|
ComputedStringFormatter:: |
public static | function |
Overrides ComputedCacheFormatterTrait:: |
|
ComputedStringFormatter:: |
protected | function |
@inheritdoc Overrides ComputedFormatterBase:: |
|
ComputedStringFormatter:: |
public | function |
Overrides ComputedCacheFormatterTrait:: |
|
ComputedStringFormatter:: |
public | function |
Overrides ComputedCacheFormatterTrait:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
12 |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
12 |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. |