class FieldTimerCountyFormatter in Field Timer 2.x

Same name and namespace in other branches

8 src/Plugin/Field/FieldFormatter/FieldTimerCountyFormatter.php \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerCountyFormatter

Plugin implementation of the 'field_timer_county' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_timer_county",
  label = @Translation("County"),
  field_types = {
    "datetime"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerJsFormatterBase
    class \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerCountyFormatter

Expanded class hierarchy of FieldTimerCountyFormatter

File

src/Plugin/Field/FieldFormatter/FieldTimerCountyFormatter.php, line 20

Namespace

Drupal\field_timer\Plugin\Field\FieldFormatter

View source

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'),
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FieldTimerCountyFormatter::animationOptions	protected	function	Gets animation options.
FieldTimerCountyFormatter::ANIMATION_FADE		constant	Animation types.
FieldTimerCountyFormatter::COUNTY_THEME_BLUE		constant	County color themes.
FieldTimerCountyFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldTimerCountyFormatter::JS_KEY		constant	Key used by js code to determine how to initialize the timer/countdown. Overrides FieldTimerJsFormatterBase::JS_KEY
FieldTimerCountyFormatter::LIBRARY_NAME		constant	Plugin name used to render timer/countdown widget. Overrides FieldTimerJsFormatterBase::LIBRARY_NAME
FieldTimerCountyFormatter::preparePluginSettings	protected	function	Prepares array of settings used to initialize jQuery plugin. Overrides FieldTimerJsFormatterBase::preparePluginSettings
FieldTimerCountyFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FieldTimerCountyFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FieldTimerCountyFormatter::themeOptions	protected	function	Gets county theme options.
FieldTimerCountyFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FieldTimerJsFormatterBase::viewElements
FieldTimerJsFormatterBase::$itemKeys	protected	property	Stores set of unique html ids for current items.
FieldTimerJsFormatterBase::generateJsSettings	protected	function	Generates JS settings for the field.
FieldTimerJsFormatterBase::getItemKeys	protected	function	Generates unique ids for the field items.
FieldTimerJsFormatterBase::getTimestamp	protected	function	Retrieves timestamp from field item.
FormatterBase::$fieldDefinition	protected	property	The field definition.
FormatterBase::$label	protected	property	The label display setting.
FormatterBase::$settings	protected	property	The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	12
FormatterBase::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
FormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable	14
FormatterBase::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
FormatterBase::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	12
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class FieldTimerCountyFormatter in Field Timer 2.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation