OptionsKeyFormatter.php

Same filename and directory in other branches
  1. 9 core/modules/options/src/Plugin/Field/FieldFormatter/OptionsKeyFormatter.php
  2. 10 core/modules/options/src/Plugin/Field/FieldFormatter/OptionsKeyFormatter.php
  3. 11.x core/modules/options/src/Plugin/Field/FieldFormatter/OptionsKeyFormatter.php

Namespace

Drupal\options\Plugin\Field\FieldFormatter

File

core/modules/options/src/Plugin/Field/FieldFormatter/OptionsKeyFormatter.php

View source
<?php

namespace Drupal\options\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\AllowedTagsXssTrait;
use Drupal\Core\Field\FieldFilteredMarkup;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Field\FieldItemListInterface;

/**
 * Plugin implementation of the 'list_key' formatter.
 *
 * @FieldFormatter(
 *   id = "list_key",
 *   label = @Translation("Key"),
 *   field_types = {
 *     "list_integer",
 *     "list_float",
 *     "list_string",
 *   }
 * )
 */
class OptionsKeyFormatter extends FormatterBase {
  use AllowedTagsXssTrait;
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => $item->value,
        '#allowed_tags' => FieldFilteredMarkup::allowedTags(),
      ];
    }
    return $elements;
  }

}

Classes

Title Deprecated Summary
OptionsKeyFormatter Plugin implementation of the 'list_key' formatter.

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