ColorapiTextDisplayFormatter.php in Color API 8

Namespace

Drupal\colorapi\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/ColorapiTextDisplayFormatter.php

<?php

namespace Drupal\colorapi\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;

/**
 * Hexadecimal string text display formatter for Color Api Color fields.
 *
 * @FieldFormatter(
 *   id = "colorapi_text_display",
 *   label = @Translation("Text Color"),
 *   description = @Translation("Displays the color as a hexadecimal string"),
 *   field_types = {
 *      "colorapi_color_field"
 *   }
 * )
 */
class ColorapiTextDisplayFormatter extends ColorapiDisplayFormatterBase {

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

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['show_hash'] = [
      '#type' => 'checkbox',
      '#title' => t('Prefix color with hash (#) symbol'),
      '#default_value' => $this
        ->getSetting('show_hash'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary['overview'] = $this
      ->t('Displays the color as a hexadecimal string');
    if ($this
      ->getSetting('show_hash')) {
      $show_hash = $this
        ->t('Yes');
    }
    else {
      $show_hash = $this
        ->t('No');
    }
    $summary['show_hash'] = $this
      ->t('Prefix with hash (#) symbol: @value', [
      '@value' => $show_hash,
    ]);
    return $summary + parent::settingsSummary();
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($items as $delta => $item) {
      $this
        ->addHumanReadableNameToElement($element, $delta, $item);
      $color = $item
        ->getHexadecimal();
      $element[$delta]['color'] = [
        '#theme' => 'colorapi_text_display',
        '#entity_delta' => $delta,
        '#item' => $item,
        '#hexadecimal_color' => $this
          ->getSetting('show_hash') ? $color : substr($color, 1),
      ];
    }
    return $element;
  }

}

Classes

Name	Description
ColorapiTextDisplayFormatter	Hexadecimal string text display formatter for Color Api Color fields.