class TestFieldDefaultFormatter

Same name and namespace in other branches
  1. 11.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldDefaultFormatter
  2. 10 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldDefaultFormatter
  3. 8.9.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldDefaultFormatter

Plugin implementation of the 'field_test_default' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_test_default",
  label = @Translation("Default"),
  description = @Translation("Default formatter"),
  field_types = {
    "test_field",
    "test_field_with_preconfigured_options"
  },
  weight = 1
)

Hierarchy

Expanded class hierarchy of TestFieldDefaultFormatter

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php, line 23

Namespace

Drupal\field_test\Plugin\Field\FieldFormatter
View source
class TestFieldDefaultFormatter extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'test_formatter_setting' => 'dummy test string',
    ] + parent::defaultSettings();
  }
  
  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['test_formatter_setting'] = [
      '#title' => $this->t('Setting'),
      '#type' => 'textfield',
      '#size' => 20,
      '#default_value' => $this->getSetting('test_formatter_setting'),
      '#required' => TRUE,
    ];
    return $element;
  }
  
  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this->t('@setting: @value', [
      '@setting' => 'test_formatter_setting',
      '@value' => $this->getSetting('test_formatter_setting'),
    ]);
    return $summary;
  }
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => $this->getSetting('test_formatter_setting') . '|' . $item->value,
      ];
    }
    return $elements;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.