Date.php
Same filename in this branch
- 10 core/modules/views/src/Plugin/views/sort/Date.php
- 10 core/modules/views/src/Plugin/views/field/Date.php
- 10 core/modules/views/src/Plugin/views/argument/Date.php
- 10 core/modules/datetime/src/Plugin/views/sort/Date.php
- 10 core/modules/datetime/src/Plugin/views/filter/Date.php
- 10 core/modules/datetime/src/Plugin/views/argument/Date.php
- 10 core/lib/Drupal/Core/Render/Element/Date.php
Same filename in other branches
- 9 core/modules/views/src/Plugin/views/sort/Date.php
- 9 core/modules/views/src/Plugin/views/field/Date.php
- 9 core/modules/views/src/Plugin/views/filter/Date.php
- 9 core/modules/views/src/Plugin/views/argument/Date.php
- 9 core/modules/datetime/src/Plugin/views/sort/Date.php
- 9 core/modules/datetime/src/Plugin/views/filter/Date.php
- 9 core/modules/datetime/src/Plugin/views/argument/Date.php
- 9 core/lib/Drupal/Core/Render/Element/Date.php
- 8.9.x core/modules/views/src/Plugin/views/sort/Date.php
- 8.9.x core/modules/views/src/Plugin/views/field/Date.php
- 8.9.x core/modules/views/src/Plugin/views/filter/Date.php
- 8.9.x core/modules/views/src/Plugin/views/argument/Date.php
- 8.9.x core/modules/datetime/src/Plugin/views/sort/Date.php
- 8.9.x core/modules/datetime/src/Plugin/views/filter/Date.php
- 8.9.x core/modules/datetime/src/Plugin/views/argument/Date.php
- 8.9.x core/lib/Drupal/Core/Render/Element/Date.php
- 11.x core/modules/views/src/Plugin/views/sort/Date.php
- 11.x core/modules/views/src/Plugin/views/field/Date.php
- 11.x core/modules/views/src/Plugin/views/filter/Date.php
- 11.x core/modules/views/src/Plugin/views/argument/Date.php
- 11.x core/modules/datetime/src/Plugin/views/sort/Date.php
- 11.x core/modules/datetime/src/Plugin/views/filter/Date.php
- 11.x core/modules/datetime/src/Plugin/views/argument/Date.php
- 11.x core/lib/Drupal/Core/Render/Element/Date.php
Namespace
Drupal\views\Plugin\views\filterFile
-
core/
modules/ views/ src/ Plugin/ views/ filter/ Date.php
View source
<?php
namespace Drupal\views\Plugin\views\filter;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Attribute\ViewsFilter;
/**
* Filter to handle dates stored as a timestamp.
*
* @ingroup views_filter_handlers
*/
class Date extends NumericFilter {
protected function defineOptions() {
$options = parent::defineOptions();
// Value is already set up properly, we're just adding our new field to it.
$options['value']['contains']['type']['default'] = 'date';
return $options;
}
/**
* Add a type selector to the value form.
*/
protected function valueForm(&$form, FormStateInterface $form_state) {
if (!$form_state->get('exposed')) {
$form['value']['type'] = [
'#type' => 'radios',
'#title' => $this->t('Value type'),
'#options' => [
'date' => $this->t('A date in any machine readable format. CCYY-MM-DD HH:MM:SS is preferred.'),
'offset' => $this->t('An offset from the current time such as "@example1" or "@example2"', [
'@example1' => '+1 day',
'@example2' => '-2 hours -30 minutes',
]),
],
'#default_value' => !empty($this->value['type']) ? $this->value['type'] : 'date',
];
}
parent::valueForm($form, $form_state);
}
public function validateOptionsForm(&$form, FormStateInterface $form_state) {
parent::validateOptionsForm($form, $form_state);
if (!empty($this->options['exposed']) && $form_state->isValueEmpty([
'options',
'expose',
'required',
])) {
// Who cares what the value is if it's exposed and non-required.
return;
}
$this->validateValidTime($form['value'], $form_state, $form_state->getValue([
'options',
'operator',
]), $form_state->getValue([
'options',
'value',
]));
}
public function validateExposed(&$form, FormStateInterface $form_state) {
if (empty($this->options['exposed'])) {
return;
}
if (empty($this->options['expose']['required'])) {
// Who cares what the value is if it's exposed and non-required.
return;
}
$value =& $form_state->getValue($this->options['expose']['identifier']);
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
$operator =& $form_state->getValue($this->options['expose']['operator_id']);
}
else {
$operator = $this->operator;
}
$this->validateValidTime($this->options['expose']['identifier'], $form_state, $operator, $value);
}
/**
* Validate that the time values convert to something usable.
*/
public function validateValidTime(&$form, FormStateInterface $form_state, $operator, $value) {
$operators = $this->operators();
if ($operators[$operator]['values'] == 1) {
$convert = strtotime($value['value']);
if (!empty($form['value']) && ($convert == -1 || $convert === FALSE)) {
$form_state->setError($form['value'], $this->t('Invalid date format.'));
}
}
elseif ($operators[$operator]['values'] == 2) {
$min = strtotime($value['min']);
if ($min == -1 || $min === FALSE) {
$form_state->setError($form['min'], $this->t('Invalid date format.'));
}
$max = strtotime($value['max']);
if ($max == -1 || $max === FALSE) {
$form_state->setError($form['max'], $this->t('Invalid date format.'));
}
}
}
/**
* {@inheritdoc}
*/
protected function hasValidGroupedValue(array $group) {
if (!is_array($group['value']) || empty($group['value'])) {
return FALSE;
}
// Special case when validating grouped date filters because the
// $group['value'] array contains the type of filter (date or offset) and
// therefore the number of items the comparison has to be done against is
// one greater.
$operators = $this->operators();
$expected = $operators[$group['operator']]['values'] + 1;
$actual = count(array_filter($group['value'], [
static::class,
'arrayFilterZero',
]));
return $actual == $expected;
}
public function acceptExposedInput($input) {
if (empty($this->options['exposed'])) {
return TRUE;
}
// Store this because it will get overwritten.
$type = NULL;
if ($this->isAGroup()) {
if (is_array($this->group_info)) {
$type = $this->group_info['type'];
}
}
else {
$type = $this->value['type'];
}
$rc = parent::acceptExposedInput($input);
// Restore what got overwritten by the parent.
if (!is_null($type)) {
$this->value['type'] = $type;
}
// Don't filter if value(s) are empty.
$operators = $this->operators();
if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id'])) {
$operator = $input[$this->options['expose']['operator_id']];
}
else {
$operator = $this->operator;
}
if ($operators[$operator]['values'] == 1) {
// When the operator is either <, <=, =, !=, >=, > or regular_expression
// the input contains only one value.
if ($this->value['value'] == '') {
return FALSE;
}
}
elseif ($operators[$operator]['values'] == 2) {
// When the operator is either between or not between the input contains
// two values.
if ($this->value['min'] == '' || $this->value['max'] == '') {
return FALSE;
}
}
return $rc;
}
protected function opBetween($field) {
$a = intval(strtotime($this->value['min'], 0));
$b = intval(strtotime($this->value['max'], 0));
if ($this->value['type'] == 'offset') {
// Keep sign.
$a = '***CURRENT_TIME***' . sprintf('%+d', $a);
// Keep sign.
$b = '***CURRENT_TIME***' . sprintf('%+d', $b);
}
// This is safe because we are manually scrubbing the values.
// It is necessary to do it this way because $a and $b are formulas when using an offset.
$operator = strtoupper($this->operator);
$this->query
->addWhereExpression($this->options['group'], "{$field} {$operator} {$a} AND {$b}");
}
protected function opSimple($field) {
$value = intval(strtotime($this->value['value'], 0));
if (!empty($this->value['type']) && $this->value['type'] == 'offset') {
// Keep sign.
$value = '***CURRENT_TIME***' . sprintf('%+d', $value);
}
// This is safe because we are manually scrubbing the value.
// It is necessary to do it this way because $value is a formula when using an offset.
$this->query
->addWhereExpression($this->options['group'], "{$field} {$this->operator} {$value}");
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
Date | Filter to handle dates stored as a timestamp. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.