Date.php

Namespace

Drupal\views\Plugin\views\argument_default

File

core/modules/views/src/Plugin/views/argument_default/Date.php

View source
<?php

namespace Drupal\views\Plugin\views\argument_default;

use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\views\Attribute\ViewsArgumentDefault;
use Drupal\views\Plugin\views\argument\Date as DateArgument;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Datetime\DateFormatterInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * The current date argument default handler.
 */
class Date extends ArgumentDefaultPluginBase implements CacheableDependencyInterface {
  
  /**
   * Constructs a new Date instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $dateFormatter
   *   The date formatter service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, protected DateFormatterInterface $dateFormatter, protected TimeInterface $time) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container->get('date.formatter'), $container->get('datetime.time'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getArgument() : string {
    // The Date argument handlers provide their own format strings, otherwise
    // use a default.
    $format = $this->argument instanceof DateArgument ? $this->argument
      ->getArgFormat() : 'Y-m-d';
    $request_time = $this->time
      ->getRequestTime();
    return $this->dateFormatter
      ->format($request_time, 'custom', $format);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return [];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return 0;
  }

}

Classes

Title Deprecated Summary
Date The current date argument default handler.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.