ComputedRawFormatter.php in Computed Field 8

Namespace

Drupal\computed_field\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/ComputedRawFormatter.php

<?php

namespace Drupal\computed_field\Plugin\Field\FieldFormatter;

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

/**
 * Plugin implementation of the 'computed_raw' formatter.
 *
 * @FieldFormatter(
 *   id = "computed_raw",
 *   label = @Translation("Computed (raw value)"),
 *   field_types = {
 *     "computed"
 *   }
 * )
 */
class ComputedRawFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'sanitized' => TRUE,
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return array(
      'sanitized' => array(
        '#type' => 'checkbox',
        '#title' => t('Sanitized'),
        '#default_value' => $this
          ->getSetting('sanitized'),
      ),
    ) + parent::settingsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = $this
      ->getSetting('sanitized') ? t('Sanitized') : t('Unsanitized');

    // Implement settings summary.
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => $this
          ->viewValue($item),
      ];
    }
    return $elements;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {
    if ($this
      ->getSetting('sanitized')) {
      return nl2br(SafeMarkup::checkPlain($item->value));
    }
    else {
      return nl2br($item->value);
    }
  }

}

Classes

Name	Description
ComputedRawFormatter	Plugin implementation of the 'computed_raw' formatter.