Date.php

Same filename in this branch
  1. 11.x core/modules/views/src/Plugin/views/field/Date.php
  2. 11.x core/modules/views/src/Plugin/views/filter/Date.php
  3. 11.x core/modules/views/src/Plugin/views/argument/Date.php
  4. 11.x core/modules/datetime/src/Plugin/views/sort/Date.php
  5. 11.x core/modules/datetime/src/Plugin/views/filter/Date.php
  6. 11.x core/modules/datetime/src/Plugin/views/argument/Date.php
  7. 11.x core/lib/Drupal/Core/Render/Element/Date.php
Same filename in other branches
  1. 9 core/modules/views/src/Plugin/views/sort/Date.php
  2. 9 core/modules/views/src/Plugin/views/field/Date.php
  3. 9 core/modules/views/src/Plugin/views/filter/Date.php
  4. 9 core/modules/views/src/Plugin/views/argument/Date.php
  5. 9 core/modules/datetime/src/Plugin/views/sort/Date.php
  6. 9 core/modules/datetime/src/Plugin/views/filter/Date.php
  7. 9 core/modules/datetime/src/Plugin/views/argument/Date.php
  8. 9 core/lib/Drupal/Core/Render/Element/Date.php
  9. 8.9.x core/modules/views/src/Plugin/views/sort/Date.php
  10. 8.9.x core/modules/views/src/Plugin/views/field/Date.php
  11. 8.9.x core/modules/views/src/Plugin/views/filter/Date.php
  12. 8.9.x core/modules/views/src/Plugin/views/argument/Date.php
  13. 8.9.x core/modules/datetime/src/Plugin/views/sort/Date.php
  14. 8.9.x core/modules/datetime/src/Plugin/views/filter/Date.php
  15. 8.9.x core/modules/datetime/src/Plugin/views/argument/Date.php
  16. 8.9.x core/lib/Drupal/Core/Render/Element/Date.php
  17. 10 core/modules/views/src/Plugin/views/sort/Date.php
  18. 10 core/modules/views/src/Plugin/views/field/Date.php
  19. 10 core/modules/views/src/Plugin/views/filter/Date.php
  20. 10 core/modules/views/src/Plugin/views/argument/Date.php
  21. 10 core/modules/datetime/src/Plugin/views/sort/Date.php
  22. 10 core/modules/datetime/src/Plugin/views/filter/Date.php
  23. 10 core/modules/datetime/src/Plugin/views/argument/Date.php
  24. 10 core/lib/Drupal/Core/Render/Element/Date.php

Namespace

Drupal\views\Plugin\views\sort

File

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

View source
<?php

namespace Drupal\views\Plugin\views\sort;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Attribute\ViewsSort;

/**
 * Basic sort handler for dates.
 *
 * This handler enables granularity, which is the ability to make dates
 * equivalent based upon nearness.
 */
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']);
    }

}

Classes

Title Deprecated Summary
Date Basic sort handler for dates.

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