class FieldTimerCountdownLedFormatter in Field Timer 8

Same name and namespace in other branches

2.x src/Plugin/Field/FieldFormatter/FieldTImerCountdownLedFormatter.php \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerCountdownLedFormatter

Plugin implementation of the 'field_timer_countdown' formatter.

Plugin annotation


@FieldFormatter(
  id = "field_timer_countdown_led",
  label = @Translation("jQuery Countdown LED"),
  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\FieldTimerCountdownFormatterBase
    class \Drupal\field_timer\Plugin\Field\FieldFormatter\FieldTimerCountdownLedFormatter

Expanded class hierarchy of FieldTimerCountdownLedFormatter

File

src/Plugin/Field/FieldFormatter/FieldTImerCountdownLedFormatter.php, line 19

Namespace

Drupal\field_timer\Plugin\Field\FieldFormatter

View source

class FieldTimerCountdownLedFormatter extends FieldTimerCountdownFormatterBase {

  /**
   * {@inheritdoc}
   */
  const JS_KEY = 'jquery.countdown.led';

  /**
   * LED color themes.
   */
  const LED_THEME_BLUE = 'blue', LED_THEME_GREEN = 'green';

  /**
   * Available count of days to display in formatter.
   */
  const LED_DAY_DIGITS_ONE = 1, LED_DAY_DIGITS_TWO = 2, LED_DAY_DIGITS_THREE = 3, LED_DAY_DIGITS_FOUR = 4;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = [
      'countdown_theme' => static::LED_THEME_GREEN,
      'max_count_of_days' => static::LED_DAY_DIGITS_TWO,
      'display_days' => 1,
      'display_hours' => 1,
      'display_minutes' => 1,
      'display_seconds' => 1,
    ] + parent::defaultSettings();
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $keys = $this
      ->getItemKeys($items);
    foreach ($items as $delta => $item) {
      $layout = $this
        ->getLayout();
      $elements[$delta] = [
        '#markup' => '<div class="field-timer-jquery-countdown-led ' . $this
          ->getSetting('countdown_theme') . '" data-field-timer-key="' . $keys[$delta] . '" data-timestamp="' . $this
          ->getTimestamp($item) . '">' . $layout . '</div>',
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['countdown_theme'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Theme'),
      '#options' => $this
        ->themeOptions(),
      '#default_value' => $this
        ->getSetting('countdown_theme'),
    ];
    $form['display_days'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display days'),
      '#default_value' => $this
        ->getSetting('display_days'),
      '#attributes' => [
        'class' => [
          'field-timer-display-days',
        ],
      ],
    ];
    $form['max_count_of_days'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Max count of days'),
      '#options' => $this
        ->dayOptions(),
      '#default_value' => $this
        ->getSetting('max_count_of_days'),
      '#states' => [
        'invisible' => [
          'input.field-timer-display-days' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['display_hours'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display hours'),
      '#default_value' => $this
        ->getSetting('display_hours'),
    ];
    $form['display_minutes'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display minutes'),
      '#default_value' => $this
        ->getSetting('display_minutes'),
    ];
    $form['display_seconds'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display seconds'),
      '#default_value' => $this
        ->getSetting('display_seconds'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $theme = $this
      ->getSetting('countdown_theme');
    $max_count_of_days = $this
      ->getSetting('max_count_of_days');
    $summary[] = t('Theme: %theme', [
      '%theme' => $this
        ->themeOptions()[$theme],
    ]);
    $summary[] = t('Display days: %display_days', [
      '%display_days' => $this
        ->getSetting('display_days') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($this
      ->getSetting('display_days')) {
      $summary[] = t('Maximum count of days: %max_count_of_days', [
        '%max_count_of_days' => $this
          ->dayOptions()[$max_count_of_days],
      ]);
    }
    $summary[] = t('Display hours: %display_hours', [
      '%display_hours' => $this
        ->getSetting('display_hours') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = t('Display minutes: %display_minutes', [
      '%display_minutes' => $this
        ->getSetting('display_minutes') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary[] = t('Display seconds: %display_seconds', [
      '%display_seconds' => $this
        ->getSetting('display_seconds') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * Renders timer/countdown layout.
   *
   * @return string
   *   Timer/countdown layout
   */
  protected function getLayout() {
    $layout = '<span class="jquery-countdown-led-display-wrapper">';
    if ($this
      ->getSetting('display_days')) {
      for ($i = $this
        ->getSetting('max_count_of_days'); $i > 0; $i--) {
        $layout .= '<span class="%t% image{d1' . substr('000', 0, $i - 1) . '}"></span>';
      }
      $layout .= '<span class="%t% imageDay"></span><span class="%t% imageSpace"></span>';
    }
    if ($this
      ->getSetting('display_hours')) {
      $layout .= '<span class="%t% image{h10}"></span><span class="%t% image{h1}"></span>';
    }
    if ($this
      ->getSetting('display_minutes')) {
      $layout .= '<span class="%t% imageSep"></span>' . '<span class="%t% image{m10}"></span><span class="%t% image{m1}"></span>';
    }
    if ($this
      ->getSetting('display_seconds')) {
      $layout .= '<span class="%t% imageSep"></span>' . '<span class="%t% image{s10}"></span><span class="%t% image{s1}"></span>';
    }
    return str_replace('%t%', $this
      ->getSetting('countdown_theme'), $layout) . '</span>';
  }

  /**
   * Gets theme options.
   *
   * @return array
   *   Array of theme options.
   */
  protected function themeOptions() {
    return [
      static::LED_THEME_GREEN => $this
        ->t('Green'),
      static::LED_THEME_BLUE => $this
        ->t('Blue'),
    ];
  }

  /**
   * Gets max number of days options.
   *
   * @return array
   *   Array of days options.
   */
  protected function dayOptions() {
    return [
      static::LED_DAY_DIGITS_ONE => 9,
      static::LED_DAY_DIGITS_TWO => 99,
      static::LED_DAY_DIGITS_THREE => 999,
      static::LED_DAY_DIGITS_FOUR => 9999,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FieldTimerCountdownFormatterBase::$time	protected	property
FieldTimerCountdownFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
FieldTimerCountdownFormatterBase::getDocumentationLink	protected	function
FieldTimerCountdownFormatterBase::LIBRARY_NAME		constant	Plugin name used to render timer/countdown widget. Overrides FieldTimerJsFormatterBase::LIBRARY_NAME
FieldTimerCountdownFormatterBase::preparePluginSettings	protected	function	Prepares array of settings used to initialize jQuery plugin. Overrides FieldTimerJsFormatterBase::preparePluginSettings	1
FieldTimerCountdownFormatterBase::typeOptions	protected	function
FieldTimerCountdownFormatterBase::TYPE_AUTO		constant	Formatter types.
FieldTimerCountdownFormatterBase::__construct	public	function	FieldTimerCountdownFormatterBase constructor. Overrides FormatterBase::__construct	1
FieldTimerCountdownLedFormatter::dayOptions	protected	function	Gets max number of days options.
FieldTimerCountdownLedFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides FieldTimerCountdownFormatterBase::defaultSettings
FieldTimerCountdownLedFormatter::getLayout	protected	function	Renders timer/countdown layout.
FieldTimerCountdownLedFormatter::JS_KEY		constant	Key used by js code to determine how to initialize the timer/countdown. Overrides FieldTimerJsFormatterBase::JS_KEY
FieldTimerCountdownLedFormatter::LED_DAY_DIGITS_ONE		constant	Available count of days to display in formatter.
FieldTimerCountdownLedFormatter::LED_THEME_BLUE		constant	LED color themes.
FieldTimerCountdownLedFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FieldTimerCountdownFormatterBase::settingsForm
FieldTimerCountdownLedFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FieldTimerCountdownFormatterBase::settingsSummary
FieldTimerCountdownLedFormatter::themeOptions	protected	function	Gets theme options.
FieldTimerCountdownLedFormatter::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::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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.	1
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 FieldTimerCountdownLedFormatter in Field Timer 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation