class Date in Drupal 10

Filter to handle dates stored as a timestamp.

Plugin annotation

@ViewsFilter("date");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\views\Plugin\views\filter\NumericFilter
    • class \Drupal\views\Plugin\views\filter\Date

Related topics

Views filter handler plugins

Plugins that handle views filtering.

2 files declare their use of Date

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

StatisticsLastUpdated.php in core/modules/comment/src/Plugin/views/filter/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/filter/Date.php, line 14

Namespace

Drupal\views\Plugin\views\filter

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}");
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Date::acceptExposedInput	public	function	Do some minor translation of the exposed input. Overrides NumericFilter::acceptExposedInput
Date::defineOptions	protected	function	Overrides NumericFilter::defineOptions
Date::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value. Overrides FilterPluginBase::hasValidGroupedValue
Date::opBetween	protected	function	Filters by operator between. Overrides NumericFilter::opBetween	1
Date::opSimple	protected	function	Overrides NumericFilter::opSimple	1
Date::validateExposed	public	function
Date::validateOptionsForm	public	function	Simple validate handler. Overrides FilterPluginBase::validateOptionsForm
Date::validateValidTime	public	function	Validate that the time values convert to something usable.
Date::valueForm	protected	function	Add a type selector to the value form. Overrides NumericFilter::valueForm
FilterPluginBase::$always_required	public	property	Disable the possibility to allow an exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting.
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms.	2
FilterPluginBase::buildValueWrapper	protected	function	Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group.
FilterPluginBase::canExpose	public	function	Determine if a filter can be exposed.	5
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then.
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	6
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator | values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init().	2
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorForm	protected	function	Options form subform for setting the operator.	5
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validate	public	function		2
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage.	1
FilterPluginBase::valueValidate	protected	function	Validate the options form.	2
NumericFilter::$alwaysMultiple	protected	property	Disable the possibility to force a single value. Overrides FilterPluginBase::$alwaysMultiple
NumericFilter::adminSummary	public	function	Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary
NumericFilter::buildExposeForm	public	function	Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm
NumericFilter::defaultExposeOptions	public	function	Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
NumericFilter::opEmpty	protected	function		1
NumericFilter::operatorOptions	public	function	Provide a list of all the numeric operators. Overrides FilterPluginBase::operatorOptions
NumericFilter::operators	public	function
NumericFilter::operatorValues	protected	function
NumericFilter::opRegex	protected	function	Filters by a regular expression.
NumericFilter::query	public	function	Add this filter to the query. Overrides FilterPluginBase::query	2