class SimpleTextFormatter

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

Plugin implementation of our "sticky-note" formatter.

Plugin annotation


@FieldFormatter(
  id = "field_permission_example_simple_formatter",
  module = "field_permission_example",
  label = @Translation("Simple text-based formatter"),
  field_types = {
    "field_permission_example_fieldnote"
  }
)

Hierarchy

  • class \Drupal\field_permission_example\Plugin\Field\FieldFormatter\SimpleTextFormatter extends \Drupal\Core\Field\FormatterBase

Expanded class hierarchy of SimpleTextFormatter

File

field_permission_example/src/Plugin/Field/FieldFormatter/SimpleTextFormatter.php, line 20

Namespace

Drupal\field_permission_example\Plugin\Field\FieldFormatter
View source
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;
    }

}

Members

Title Sort descending Modifiers Object type Summary
SimpleTextFormatter::viewElements public function