Current.php

Same filename in other branches
  1. 9 core/modules/user/src/Plugin/views/filter/Current.php
  2. 10 core/modules/user/src/Plugin/views/filter/Current.php
  3. 11.x core/modules/user/src/Plugin/views/filter/Current.php

Namespace

Drupal\user\Plugin\views\filter

File

core/modules/user/src/Plugin/views/filter/Current.php

View source
<?php

namespace Drupal\user\Plugin\views\filter;

use Drupal\Core\Database\Query\Condition;
use Drupal\views\Plugin\views\display\DisplayPluginBase;
use Drupal\views\ViewExecutable;
use Drupal\views\Plugin\views\filter\BooleanOperator;

/**
 * Filter handler for the current user.
 *
 * @ingroup views_filter_handlers
 *
 * @ViewsFilter("user_current")
 */
class Current extends BooleanOperator {
    
    /**
     * {@inheritdoc}
     */
    public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) {
        parent::init($view, $display, $options);
        $this->value_value = $this->t('Is the logged in user');
    }
    public function query() {
        $this->ensureMyTable();
        $field = $this->tableAlias . '.' . $this->realField . ' ';
        $or = new Condition('OR');
        if (empty($this->value)) {
            $or->condition($field, '***CURRENT_USER***', '<>');
            if ($this->accept_null) {
                $or->isNull($field);
            }
        }
        else {
            $or->condition($field, '***CURRENT_USER***', '=');
        }
        $this->query
            ->addWhere($this->options['group'], $or);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        $contexts = parent::getCacheContexts();
        // This filter depends on the current user.
        $contexts[] = 'user';
        return $contexts;
    }

}

Classes

Title Deprecated Summary
Current Filter handler for the current user.

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