SimpleTextFormatter.php

Same filename in this branch
  1. 3.x modules/field_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php
Same filename in other branches
  1. 8.x-1.x field_permission_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php
  2. 8.x-1.x field_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php
  3. 4.0.x modules/field_permission_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php
  4. 4.0.x modules/field_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php

Namespace

Drupal\field_permission_example\Plugin\Field\FieldFormatter

File

modules/field_permission_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php

View source
<?php

namespace Drupal\field_permission_example\Plugin\Field\FieldFormatter;

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

/**
 * Plugin implementation of our "sticky-note" formatter.
 *
 * @FieldFormatter(
 *   id = "field_permission_example_simple_formatter",
 *   module = "field_permission_example",
 *   label = @Translation("Simple text-based formatter"),
 *   field_types = {
 *     "field_permission_example_fieldnote"
 *   }
 * )
 */
class SimpleTextFormatter extends FormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        foreach ($items as $delta => $item) {
            $elements[$delta] = [
                // We wrap the fieldnote content up in a div tag.
'#type' => 'html_tag',
                '#tag' => 'div',
                // This text is auto-XSS escaped.  See docs for the html_tag element.
'#value' => $item->value,
                // Let's give the note a nice sticky-note CSS appearance.
'#attributes' => [
                    'class' => 'stickynote',
                ],
                // ..And this is the CSS for the stickynote.
'#attached' => [
                    'library' => [
                        'field_permission_example/fieldnote_sticky',
                    ],
                ],
            ];
        }
        return $elements;
    }

}

Classes

Title Deprecated Summary
SimpleTextFormatter Plugin implementation of our "sticky-note" formatter.