FieldTimerCountyFormatter.php in Field Timer 2.x

Namespace

Drupal\field_timer\Plugin\Field\FieldFormatter

File

src/Plugin/Field/FieldFormatter/FieldTimerCountyFormatter.php

<?php

namespace Drupal\field_timer\Plugin\Field\FieldFormatter;

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

/**
 * Plugin implementation of the 'field_timer_county' formatter.
 *
 * @FieldFormatter(
 *   id = "field_timer_county",
 *   label = @Translation("County"),
 *   field_types = {
 *     "datetime"
 *   }
 * )
 */
class FieldTimerCountyFormatter extends FieldTimerJsFormatterBase {

  /**
   * {@inheritdoc}
   */
  const LIBRARY_NAME = 'county';

  /**
   * {@inheritdoc}
   */
  const JS_KEY = 'county';

  /**
   * Animation types.
   */
  const ANIMATION_FADE = 'fade', ANIMATION_SCROLL = 'scroll';

  /**
   * County color themes.
   */
  const COUNTY_THEME_BLUE = 'blue', COUNTY_THEME_BLACK = 'black', COUNTY_THEME_GRAY = 'gray', COUNTY_THEME_RED = 'red';

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [
      'animation' => static::ANIMATION_FADE,
      'speed' => 500,
      'theme' => static::COUNTY_THEME_BLUE,
      'background' => '',
      'reflection' => 1,
      'reflectionOpacity' => 0.2,
    ] + parent::defaultSettings();
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $keys = $this
      ->getItemKeys($items);
    $attributes = [
      'class' => [
        'field-timer-county',
      ],
    ];
    $background = $this
      ->getSetting('background');
    if (!empty($background)) {
      $attributes['style'] = 'background:' . $background . ';';
    }
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#theme' => 'container',
        '#attributes' => $attributes,
        '#children' => [
          '#markup' => '<div data-field-timer-key="' . $keys[$delta] . '"  data-timestamp="' . $this
            ->getTimestamp($item) . '"></div>',
        ],
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['animation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Animation'),
      '#options' => $this
        ->animationOptions(),
      '#default_value' => $this
        ->getSetting('animation'),
    ];
    $form['speed'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Speed'),
      '#default_value' => $this
        ->getSetting('speed'),
    ];
    $form['theme'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#options' => $this
        ->themeOptions(),
      '#default_value' => $this
        ->getSetting('theme'),
    ];
    $form['background'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Background'),
      '#default_value' => $this
        ->getSetting('background'),
      '#description' => $this
        ->t('Data from this field will be added to css property \'background\'.'),
    ];
    $form['reflection'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add reflection'),
      '#default_value' => $this
        ->getSetting('reflection'),
      '#attributes' => [
        'class' => [
          'field-timer-county-reflection',
        ],
      ],
    ];
    $form['reflectionOpacity'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Reflection opacity'),
      '#default_value' => $this
        ->getSetting('reflectionOpacity'),
      '#description' => $this
        ->t('Float value between 0 and 1.'),
      '#states' => [
        'invisible' => [
          'input.field-timer-county-reflection' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $animation = $this
      ->getSetting('animation');
    $theme = $this
      ->getSetting('theme');
    $reflection = $this
      ->getSetting('reflection');
    $summary[] = $this
      ->t('Animation: @animation', [
      '@animation' => $this
        ->animationOptions()[$animation],
    ]);
    $summary[] = $this
      ->t('Speed: @speed', [
      '@speed' => $this
        ->getSetting('speed') . 'ms',
    ]);
    $summary[] = $this
      ->t('Theme: @theme', [
      '@theme' => $this
        ->themeOptions()[$theme],
    ]);
    $summary[] = $this
      ->t('Background: @css', [
      '@css' => $this
        ->getSetting('background'),
    ]);
    $summary[] = $this
      ->t('Reflection: @state', [
      '@state' => $reflection ? $this
        ->t('Enabled') : $this
        ->t('Disabled'),
    ]);
    if ($reflection) {
      $summary[] = t('Reflection opacity: @opacity', [
        '@opacity' => $this
          ->getSetting('reflectionOpacity'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  protected function preparePluginSettings(FieldItemInterface $item, $langcode) {
    $settings = $this
      ->getSettings();
    unset($settings['background']);
    return $settings;
  }

  /**
   * Gets animation options.
   *
   * @return array
   *   Array of animation options.
   */
  protected function animationOptions() {
    return [
      static::ANIMATION_FADE => $this
        ->t('Fade'),
      static::ANIMATION_SCROLL => $this
        ->t('Scroll'),
    ];
  }

  /**
   * Gets county theme options.
   *
   * @return array
   *   Array of county theme options.
   */
  protected function themeOptions() {
    return [
      static::COUNTY_THEME_BLUE => $this
        ->t('Blue'),
      static::COUNTY_THEME_RED => $this
        ->t('Red'),
      static::COUNTY_THEME_GRAY => $this
        ->t('Gray'),
      static::COUNTY_THEME_BLACK => $this
        ->t('Black'),
    ];
  }

}

Classes

Name	Description
FieldTimerCountyFormatter	Plugin implementation of the 'field_timer_county' formatter.