class HistoryUserTimestamp in Drupal 10

Filter for new content.

The handler is named history_user, because of compatibility reasons, the table is history.

Plugin annotation

@ViewsFilter("history_user_timestamp");

Hierarchy

• class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
  • class \Drupal\history\Plugin\views\filter\HistoryUserTimestamp uses UncacheableDependencyTrait

Related topics

Views filter handler plugins

Plugins that handle views filtering.

File

core/modules/history/src/Plugin/views/filter/HistoryUserTimestamp.php, line 19

Namespace

Drupal\history\Plugin\views\filter

class HistoryUserTimestamp extends FilterPluginBase {
  use UncacheableDependencyTrait;

  /**
   * {@inheritdoc}
   */
  public $no_operator = TRUE;

  /**
   * {@inheritdoc}
   */
  public function usesGroupBy() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function buildExposeForm(&$form, FormStateInterface $form_state) {
    parent::buildExposeForm($form, $form_state);

    // @todo There are better ways of excluding required and multiple (object flags)
    unset($form['expose']['required']);
    unset($form['expose']['multiple']);
    unset($form['expose']['remember']);
  }

  /**
   * {@inheritdoc}
   */
  protected function valueForm(&$form, FormStateInterface $form_state) {

    // Only present a checkbox for the exposed filter itself. There's no way
    // to tell the difference between not checked and the default value, so
    // specifying the default value via the views UI is meaningless.
    if ($form_state
      ->get('exposed')) {
      if (isset($this->options['expose']['label'])) {
        $label = $this->options['expose']['label'];
      }
      else {
        $label = $this
          ->t('Has new content');
      }
      $form['value'] = [
        '#type' => 'checkbox',
        '#title' => $label,
        '#default_value' => $this->value,
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function query() {

    // This can only work if we're authenticated in.
    if (!\Drupal::currentUser()
      ->isAuthenticated()) {
      return;
    }

    // Don't filter if we're exposed and the checkbox isn't selected.
    if (!empty($this->options['exposed']) && empty($this->value)) {
      return;
    }

    // Hey, Drupal kills old history, so nodes that haven't been updated
    // since HISTORY_READ_LIMIT are outta here!
    $limit = REQUEST_TIME - HISTORY_READ_LIMIT;
    $this
      ->ensureMyTable();
    $field = "{$this->tableAlias}.{$this->realField}";
    $node = $this->query
      ->ensureTable('node_field_data', $this->relationship);
    $clause = '';
    $clause2 = '';
    if ($alias = $this->query
      ->ensureTable('comment_entity_statistics', $this->relationship)) {
      $clause = "OR {$alias}.last_comment_timestamp > (***CURRENT_TIME*** - {$limit})";
      $clause2 = "OR {$field} < {$alias}.last_comment_timestamp";
    }

    // NULL means a history record doesn't exist. That's clearly new content.
    // Unless it's very very old content. Everything in the query is already
    // type safe cause none of it is coming from outside here.
    $this->query
      ->addWhereExpression($this->options['group'], "({$field} IS NULL AND ({$node}.changed > (***CURRENT_TIME*** - {$limit}) {$clause})) OR {$field} < {$node}.changed {$clause2}");
  }

  /**
   * {@inheritdoc}
   */
  public function adminSummary() {
    if (!empty($this->options['exposed'])) {
      return $this
        ->t('exposed');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	4
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::$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::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query.	2
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::defaultExposeOptions	public	function	Provide default options for exposed filters.	3
FilterPluginBase::defineOptions	protected	function		4
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::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::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
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::operatorOptions	public	function	Provide a list of options for the default operator form.	4
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::validateOptionsForm	public	function	Simple validate handler.	1
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
HistoryUserTimestamp::$no_operator	public	property	Disable the possibility to use operators. Overrides FilterPluginBase::$no_operator
HistoryUserTimestamp::adminSummary	public	function	Display the filter on the administrative summary. Overrides FilterPluginBase::adminSummary
HistoryUserTimestamp::buildExposeForm	public	function	Options form subform for exposed filter options. Overrides FilterPluginBase::buildExposeForm
HistoryUserTimestamp::query	public	function	Add this filter to the query. Overrides FilterPluginBase::query
HistoryUserTimestamp::usesGroupBy	public	function
HistoryUserTimestamp::valueForm	protected	function	Options form subform for setting options. Overrides FilterPluginBase::valueForm
UncacheableDependencyTrait::getCacheContexts	public	function
UncacheableDependencyTrait::getCacheMaxAge	public	function
UncacheableDependencyTrait::getCacheTags	public	function