PlainStringFormatter.php in String field formatter 8

Namespace

Drupal\string_field_formatter\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/PlainStringFormatter.php

<?php

namespace Drupal\string_field_formatter\Plugin\Field\FieldFormatter;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Field\FormatterBase;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Component\Utility\Html;

/**
 * Plugin implementation of the 'plain_string_formatter' formatter.
 *
 * @FieldFormatter(
 *   id = "plain_string_formatter",
 *   label = @Translation("Plain string formatter"),
 *   field_types = {
 *     "string",
 *   },
 *   edit = {
 *     "editor" = "form"
 *   },
 *   quickedit = {
 *     "editor" = "plain_text"
 *   }
 * )
 */
class PlainStringFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'wrap_tag' => '_none',
      'wrap_class' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultWrapTagOptions() {
    return array(
      '_none' => t('- None -'),
      'div' => t('DIV'),
      'h1' => t('H1'),
      'h2' => t('H2'),
      'h3' => t('H3'),
      'h4' => t('H4'),
      'h5' => t('H5'),
      'h6' => t('H6'),
      'span' => t('SPAN'),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = array();
    $element['wrap_tag'] = array(
      '#title' => t('Field wrapper tag'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('wrap_tag'),
      '#options' => $this
        ->defaultWrapTagOptions(),
    );
    $element['wrap_class'] = array(
      '#title' => t('Field class'),
      '#type' => 'textfield',
      '#maxlength' => 128,
      '#default_value' => $this
        ->getSetting('wrap_class'),
      '#description' => t('Separate multiple classes with space or comma.'),
    );
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = array();
    $wrap_tag = $this
      ->getSetting('wrap_tag');
    if ('_none' == $wrap_tag) {
      $summary[] = t('No wrap tag defined.');
    }
    else {
      $summary[] = t('Wrap text with tag: @tag', array(
        '@tag' => $wrap_tag,
      ));
    }
    $class = $this
      ->getSetting('wrap_class');
    $class = $this
      ->prepareClasses($class);
    if ($class) {
      $summary[] = $this
        ->formatPlural(count($class), t('Wrapper additional CSS class: @class.', array(
        '@class' => implode('', $class),
      )), t('Wrapper additional CSS classes: @class.', array(
        '@class' => implode(' ', $class),
      )));
    }
    else {
      $summary[] = t('No additional CSS class defined.');
    }
    return $summary;
  }

  /**
   * Build classes.
   */
  public function prepareClasses($class) {
    $class = preg_replace('! !', ',', $class);
    $all = explode(',', $class);
    $prepared = [];
    foreach ($all as $c) {
      $c = trim($c);
      if ($c) {
        $prepared[] = Html::getClass($c);
      }
    }
    return $prepared;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = array();
    $wrap_tag = $this
      ->getSetting('wrap_tag');
    if ('_none' == $wrap_tag) {
      $wrap_tag = '';
    }
    $class = $this
      ->getSetting('wrap_class');
    $class = $this
      ->prepareClasses($class);
    foreach ($items as $delta => $item) {
      $elements[$delta] = array(
        '#type' => 'html_tag',
        '#tag' => $wrap_tag,
        '#value' => $item->value,
        '#attributes' => [
          'class' => $class,
        ],
      );
    }
    return $elements;
  }

}

Classes

Name	Description
PlainStringFormatter	Plugin implementation of the 'plain_string_formatter' formatter.