class UIkitCountdown in UIkit Components 8.3

Provides a render element for the Countdown component.

Properties:

• #expire_date: The date when the countdown should expire using the ISO 8601 format, e.g. 2017-12-04T22:00:00+00:00 (UTC time).
• #separators: An associative array to insert a separator between each number, containing:
  • days_hours: The separator to insert between the days and hours.
  • hours_minutes: The separator to insert between hours and minutes.
  • minutes_seconds: The separator to insert between minutes and seconds.
• #labels: An associative array for labels to display below each number, containing:
  • days: The label to display for days.
  • hours: The label to display for hours.
  • minutes: The label to display for minutes.
  • seconds: The label to display for seconds.

Usage example:

$build['countdown'] = [
  '#type' => 'uikit_countdown',
  '#expire_date' => date('c', strtotime('+1 day', time())),
  '#separators' => [
    'days_hours' => ':',
    'hours_minutes' => ':',
    'minutes_seconds' => ':',
  ],
  '#labels' => [
    'days' => t('Days'),
    'hours' => t('Hours'),
    'minutes' => t('Minutes'),
    'seconds' => t('Seconds'),
  ],
];

Plugin annotation

@RenderElement("uikit_countdown");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\uikit_components\Element\UIkitCountdown

See also

template_preprocess_uikit_countdown()

https://getuikit.com/docs/countdown

Related topics

Render API Overview

Overview of the UIkit Components Theme system and Render API.

File

src/Element/UIkitCountdown.php, line 52

Namespace

Drupal\uikit_components\Element

class UIkitCountdown extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#expire_date' => NULL,
      '#separators' => NULL,
      '#labels' => NULL,
      '#attributes' => new Attribute(),
      '#pre_render' => [
        [
          $class,
          'preRenderUIkitCountdown',
        ],
      ],
      '#theme_wrappers' => [
        'uikit_countdown',
      ],
    ];
  }

  /**
   * Pre-render callback: Sets the countdown attributes.
   *
   * Doing so during pre_render gives modules a chance to alter the countdown.
   *
   * @param array $element
   *   A renderable array.
   *
   * @return array
   *   A renderable array.
   */
  public static function preRenderUIkitCountdown($element) {

    // Get the expire date.
    $date = $element['#expire_date'];

    // Set the attributes for the countdown outer element.
    $element['#attributes']
      ->addClass('uk-grid-small');
    $element['#attributes']
      ->addClass('uk-child-width-auto');
    $element['#attributes']
      ->setAttribute('data-uk-grid', '');
    $element['#attributes']
      ->setAttribute('data-uk-countdown', "date: {$date}");
    return $element;
  }

}

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
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
UIkitCountdown::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
UIkitCountdown::preRenderUIkitCountdown	public static	function	Pre-render callback: Sets the countdown attributes.