You are here

ScriptEntityFormatter.php in Script Manager 8

File

src/Plugin/Field/FieldFormatter/ScriptEntityFormatter.php
View source
<?php

namespace Drupal\script_manager\Plugin\Field\FieldFormatter;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase;

/**
 * Formatter for script references.
 *
 * @FieldFormatter(
 *   id = "script_entity",
 *   label = "Script Formatter",
 *   description = @Translation("A field formatter to render script entities when referenced."),
 *   field_types = {
 *     "entity_reference"
 *   }
 * )
 */
class ScriptEntityFormatter extends EntityReferenceFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $entity) {
      $element[] = [
        '#markup' => new FormattableMarkup($entity
          ->getSnippet(), []),
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type') === 'script';
  }

}

Classes

Namesort descending Description
ScriptEntityFormatter Formatter for script references.