Documentation & API reference
class TestFieldPrepareViewFormatter
Plugin implementation of the 'field_test_with_prepare_view' formatter.
Plugin annotation
@FieldFormatter(
id = "field_test_with_prepare_view",
module = "field_test",
label = @Translation("With prepare step"),
description = @Translation("Tests prepareView() method"),
field_types = {
"test_field"
},
settings = {
"test_formatter_setting_additional" = "dummy test string"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
- class \Drupal\field\Plugin\Type\Formatter\FormatterBase implements FormatterInterface
- class \Drupal\field_test\Plugin\field\formatter\TestFieldPrepareViewFormatter
- class \Drupal\field\Plugin\Type\Formatter\FormatterBase implements FormatterInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
Expanded class hierarchy of TestFieldPrepareViewFormatter
File
- drupal/
core/ modules/ field/ tests/ modules/ field_test/ lib/ Drupal/ field_test/ Plugin/ field/ formatter/ TestFieldPrepareViewFormatter.php, line 31 - Contains \Drupal\field_test\Plugin\field\formatter\TestFieldPrepareViewFormatter.
Namespace
Drupal\field_test\Plugin\field\formatterView source
class TestFieldPrepareViewFormatter extends FormatterBase {
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, array &$form_state) {
$element['test_formatter_setting_additional'] = array(
'#title' => t('Setting'),
'#type' => 'textfield',
'#size' => 20,
'#default_value' => $this
->getSetting('test_formatter_setting_additional'),
'#required' => TRUE,
);
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = array();
$summary[] = t('@setting: @value', array(
'@setting' => 'test_formatter_setting_additional',
'@value' => $this
->getSetting('test_formatter_setting_additional'),
));
return $summary;
}
/**
* {@inheritdoc}
*/
public function prepareView(array $entities, $langcode, array &$items) {
foreach ($items as $id => $item) {
foreach ($item as $delta => $value) {
// Don't add anything on empty values.
if ($value) {
$items[$id][$delta]['additional_formatter_value'] = $value['value'] + 1;
}
}
}
}
/**
* {@inheritdoc}
*/
public function viewElements(EntityInterface $entity, $langcode, array $items) {
$elements = array();
foreach ($items as $delta => $item) {
$elements[$delta] = array(
'#markup' => $this
->getSetting('test_formatter_setting_additional') . '|' . $item['value'] . '|' . $item['additional_formatter_value'],
);
}
return $elements;
}
}