class TestFieldEmptySettingFormatter

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

Plugin implementation of the 'field_empty_setting' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_empty_setting",
  label = @Translation("Field empty setting"),
  field_types = {
    "test_field",
  },
  weight = -1
)

Hierarchy

Expanded class hierarchy of TestFieldEmptySettingFormatter

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldEmptySettingFormatter.php, line 21

Namespace

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

}

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