abstract class FieldTimerJsFormatterBase in Field Timer 8

Same name and namespace in other branches

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

Implementation of formatters that uses JavaScript to render timer/countdown.

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

Expanded class hierarchy of FieldTimerJsFormatterBase

File

src/Plugin/Field/FieldFormatter/FieldTimerJsFormatterBase.php, line 13

Namespace

Drupal\field_timer\Plugin\Field\FieldFormatter

View source

abstract class FieldTimerJsFormatterBase extends FormatterBase {

  /**
   * Plugin name used to render timer/countdown widget.
   */
  const LIBRARY_NAME = '';

  /**
   * Key used by js code to determine how to initialize the timer/countdown.
   */
  const JS_KEY = '';

  /**
   * Stores set of unique html ids for current items.
   *
   * @var array
   */
  protected $itemKeys;

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $elements['#attached']['library'][] = 'field_timer/' . static::LIBRARY_NAME;
    $elements['#attached']['library'][] = 'field_timer/init';
    $elements['#attached']['drupalSettings']['field_timer'] = $this
      ->generateJsSettings($items, $langcode);
    return $elements;
  }

  /**
   * Generates unique ids for the field items.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field items.
   *
   * @return array
   *   Array of ids keyed by field item delta.
   */
  protected function getItemKeys(FieldItemListInterface $items) {
    $entity = $items
      ->getEntity();
    if (!isset($this->itemKeys[$entity
      ->getEntityTypeId()][$entity
      ->id()][$items
      ->getFieldDefinition()
      ->getName()])) {
      $entity = $items
        ->getEntity();
      $this->itemKeys = [];
      foreach ($items as $delta => $item) {
        $this->itemKeys[$entity
          ->getEntityTypeId()][$entity
          ->id()][$items
          ->getFieldDefinition()
          ->getName()][$delta] = implode('-', [
          $entity
            ->getEntityTypeId(),
          $entity
            ->id(),
          $items
            ->getFieldDefinition()
            ->getName(),
          $delta,
          Crypt::randomBytesBase64(8),
        ]);
      }
    }
    return $this->itemKeys[$entity
      ->getEntityTypeId()][$entity
      ->id()][$items
      ->getFieldDefinition()
      ->getName()] ?? [];
  }

  /**
   * Generates JS settings for the field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   Field items.
   * @param string $langcode
   *   Langcode value.
   *
   * @return array
   *   Array of JS settings to be used to initialize timer/countdown widget.
   */
  protected function generateJsSettings(FieldItemListInterface $items, $langcode) {
    $keys = $this
      ->getItemKeys($items);
    $js_settings = [];
    foreach ($items as $delta => $item) {
      $timestamp = $this
        ->getTimestamp($item);
      if ($timestamp !== NULL) {
        $js_settings[$keys[$delta]]['settings'] = $this
          ->preparePluginSettings($item, $langcode);
        $js_settings[$keys[$delta]]['plugin'] = static::JS_KEY;
      }
    }
    return $js_settings;
  }

  /**
   * Retrieves timestamp from field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   Field item.
   *
   * @return int|null
   *   Datetime field item timestamp.
   */
  protected function getTimestamp(FieldItemInterface $item) {
    if (!empty($item->date)) {
      return $item->date
        ->getTimestamp();
    }
    return NULL;
  }

  /**
   * Prepares array of settings used to initialize jQuery plugin.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   Field item.
   * @param string $langcode
   *   Langcode value.
   *
   * @return array
   *   Array of key-value pairs.
   */
  protected abstract function preparePluginSettings(FieldItemInterface $item, $langcode);

}

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
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.
FieldTimerJsFormatterBase::JS_KEY		constant	Key used by js code to determine how to initialize the timer/countdown.	3
FieldTimerJsFormatterBase::LIBRARY_NAME		constant	Plugin name used to render timer/countdown widget.	2
FieldTimerJsFormatterBase::preparePluginSettings	abstract protected	function	Prepares array of settings used to initialize jQuery plugin.	2
FieldTimerJsFormatterBase::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements	3
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	11
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::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm	24
FormatterBase::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary	22
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	11
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::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings	42
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

abstract class FieldTimerJsFormatterBase in Field Timer 8

Hierarchy

File

Namespace

Members

API Navigation