class TestFieldEmptyFormatter

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

Plugin implementation of the 'field_empty_test' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_empty_test",
  label = @Translation("Field empty test"),
  field_types = {
    "test_field",
  },
  weight = -5
)

Hierarchy

Expanded class hierarchy of TestFieldEmptyFormatter

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldEmptyFormatter.php, line 20

Namespace

Drupal\field_test\Plugin\Field\FieldFormatter
View source
class TestFieldEmptyFormatter extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'test_empty_string' => '**EMPTY FIELD**',
    ] + parent::defaultSettings();
  }
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    if ($items->isEmpty()) {
      // For fields with no value, just add the configured "empty" value.
      $elements[0] = [
        '#markup' => $this->getSetting('test_empty_string'),
      ];
    }
    else {
      foreach ($items as $delta => $item) {
        // This formatter only needs to output raw for testing.
        $elements[$delta] = [
          '#markup' => $item->value,
        ];
      }
    }
    return $elements;
  }

}

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