class Date in Drupal 10

Basic sort handler for dates.

This handler enables granularity, which is the ability to make dates equivalent based upon nearness.

Plugin annotation

@ViewsSort("date");

Hierarchy

• class \Drupal\views\Plugin\views\sort\SortPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\views\Plugin\views\sort\Date

2 files declare their use of Date

Date.php in core/modules/datetime/src/Plugin/views/sort/Date.php

StatisticsLastUpdated.php in core/modules/comment/src/Plugin/views/sort/StatisticsLastUpdated.php

23 string references to 'Date'

Date::getSortName in core/modules/views/src/Plugin/views/argument/Date.php

Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php

Expands a datetime element type into date and/or time elements.

DateTimeSchemaTest::testDateTimeSchema in core/modules/datetime/tests/src/Kernel/Views/DateTimeSchemaTest.php

Tests argument plugin schema.

DbLogController::eventDetails in core/modules/dblog/src/Controller/DbLogController.php

Displays details about a specific database log message.

DbLogController::overview in core/modules/dblog/src/Controller/DbLogController.php

Displays a listing of database log messages.

... See full list

File

core/modules/views/src/Plugin/views/sort/Date.php, line 15

Namespace

Drupal\views\Plugin\views\sort

class Date extends SortPluginBase {
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['granularity'] = [
      'default' => 'second',
    ];
    return $options;
  }
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['granularity'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Granularity'),
      '#options' => [
        'second' => $this
          ->t('Second'),
        'minute' => $this
          ->t('Minute'),
        'hour' => $this
          ->t('Hour'),
        'day' => $this
          ->t('Day'),
        'month' => $this
          ->t('Month'),
        'year' => $this
          ->t('Year'),
      ],
      '#description' => $this
        ->t('The granularity is the smallest unit to use when determining whether two dates are the same; for example, if the granularity is "Year" then all dates in 1999, regardless of when they fall in 1999, will be considered the same date.'),
      '#default_value' => $this->options['granularity'],
    ];
  }

  /**
   * Called to add the sort to a query.
   */
  public function query() {
    $this
      ->ensureMyTable();
    switch ($this->options['granularity']) {
      case 'second':
      default:
        $this->query
          ->addOrderBy($this->tableAlias, $this->realField, $this->options['order']);
        return;
      case 'minute':
        $formula = $this
          ->getDateFormat('YmdHi');
        break;
      case 'hour':
        $formula = $this
          ->getDateFormat('YmdH');
        break;
      case 'day':
        $formula = $this
          ->getDateFormat('Ymd');
        break;
      case 'month':
        $formula = $this
          ->getDateFormat('Ym');
        break;
      case 'year':
        $formula = $this
          ->getDateFormat('Y');
        break;
    }

    // Add the field.
    $this->query
      ->addOrderBy(NULL, $formula, $this->options['order'], $this->tableAlias . '_' . $this->field . '_' . $this->options['granularity']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Date::buildOptionsForm	public	function	Basic options for all sort criteria. Overrides SortPluginBase::buildOptionsForm
Date::defineOptions	protected	function	Overrides SortPluginBase::defineOptions
Date::query	public	function	Called to add the sort to a query. Overrides SortPluginBase::query	1
SortPluginBase::adminSummary	public	function	Display whether or not the sort order is ascending or descending.
SortPluginBase::buildExposeForm	public	function
SortPluginBase::canExpose	public	function	Determine if a sort can be exposed.
SortPluginBase::defaultExposeOptions	public	function	Provide default options for exposed sorts.
SortPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
SortPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
SortPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
SortPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
SortPluginBase::showSortForm	protected	function	Shortcut to display the value form.
SortPluginBase::sortOptions	protected	function	Provide a list of options for the default sort form.
SortPluginBase::sortSubmit	public	function
SortPluginBase::sortValidate	protected	function
SortPluginBase::submitOptionsForm	public	function	Simple submit handler.
SortPluginBase::trustedCallbacks	public static	function
SortPluginBase::validateExposeForm	public	function	Validate the options form.
SortPluginBase::validateOptionsForm	public	function	Simple validate handler.