Date.php

Same filename in this branch
  1. 11.x core/modules/views/src/Plugin/views/sort/Date.php
  2. 11.x core/modules/views/src/Plugin/views/field/Date.php
  3. 11.x core/modules/views/src/Plugin/views/filter/Date.php
  4. 11.x core/modules/views/src/Plugin/views/argument/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\datetime\Plugin\views\sort

File

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

View source
<?php

namespace Drupal\datetime\Plugin\views\sort;

use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
use Drupal\views\Attribute\ViewsSort;
use Drupal\views\FieldAPIHandlerTrait;
use Drupal\views\Plugin\views\sort\Date as NumericDate;

/**
 * Basic sort handler for datetime fields.
 *
 * This handler enables granularity, which is the ability to make dates
 * equivalent based upon nearness.
 */
class Date extends NumericDate {
    use FieldAPIHandlerTrait;
    
    /**
     * Determines if the timezone offset is calculated.
     *
     * @var bool
     */
    protected $calculateOffset = TRUE;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $definition = $this->getFieldStorageDefinition();
        if ($definition->getSetting('datetime_type') === DateTimeItem::DATETIME_TYPE_DATE) {
            // Timezone offset calculation is not applicable to dates that are stored
            // as date-only.
            $this->calculateOffset = FALSE;
        }
    }
    
    /**
     * {@inheritdoc}
     *
     * Override to account for dates stored as strings.
     */
    public function getDateField() {
        // Use string date storage/formatting since datetime fields are stored as
        // strings rather than UNIX timestamps.
        return $this->query
            ->getDateField("{$this->tableAlias}.{$this->realField}", TRUE, $this->calculateOffset);
    }
    
    /**
     * {@inheritdoc}
     *
     * Overridden in order to pass in the string date flag.
     */
    public function getDateFormat($format) {
        return $this->query
            ->getDateFormat($this->getDateField(), $format, TRUE);
    }

}

Classes

Title Deprecated Summary
Date Basic sort handler for datetime fields.

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