class HistoryUserTimestamp

Same name in this branch
  1. 10 core/modules/history/src/Plugin/views/field/HistoryUserTimestamp.php \Drupal\history\Plugin\views\field\HistoryUserTimestamp
Same name and namespace in other branches
  1. 9 core/modules/history/src/Plugin/views/field/HistoryUserTimestamp.php \Drupal\history\Plugin\views\field\HistoryUserTimestamp
  2. 9 core/modules/history/src/Plugin/views/filter/HistoryUserTimestamp.php \Drupal\history\Plugin\views\filter\HistoryUserTimestamp
  3. 8.9.x core/modules/history/src/Plugin/views/field/HistoryUserTimestamp.php \Drupal\history\Plugin\views\field\HistoryUserTimestamp
  4. 8.9.x core/modules/history/src/Plugin/views/filter/HistoryUserTimestamp.php \Drupal\history\Plugin\views\filter\HistoryUserTimestamp
  5. 11.x core/modules/history/src/Plugin/views/field/HistoryUserTimestamp.php \Drupal\history\Plugin\views\field\HistoryUserTimestamp
  6. 11.x core/modules/history/src/Plugin/views/filter/HistoryUserTimestamp.php \Drupal\history\Plugin\views\filter\HistoryUserTimestamp

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

Expanded class hierarchy of HistoryUserTimestamp

Related topics

File

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

Namespace

Drupal\history\Plugin\views\filter
View source
class HistoryUserTimestamp extends FilterPluginBase {
    use UncacheableDependencyTrait;
    
    /**
     * {@inheritdoc}
     */
    public $no_operator = TRUE;
    
    /**
     * Constructs a HistoryUserTimestamp object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Component\Datetime\TimeInterface|null $time
     *   The time service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, ?TimeInterface $time = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        if (!$time) {
            @trigger_error('Calling ' . __METHOD__ . ' without the $time argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3395991', E_USER_DEPRECATED);
            $this->time = \Drupal::service('datetime.time');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('datetime.time'));
    }
    
    /**
     * {@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 = $this->time
            ->getRequestTime() - 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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FilterPluginBase::$alwaysMultiple protected property Disable the possibility to force a single value. 6
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::$tableAliases public property Keyed array by alias of table relations.
FilterPluginBase::$value public property The value.
FilterPluginBase::acceptExposedInput public function Determines if the input from a filter should change the generated query. Overrides HandlerBase::acceptExposedInput 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) &quot;0&quot;.
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. Overrides HandlerBase::buildExposedForm
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. Overrides HandlerBase::buildOptionsForm 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. Overrides HandlerBase::canExpose 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. Overrides HandlerBase::defaultExposeOptions 4
FilterPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides HandlerBase::defineOptions 6
FilterPluginBase::exposedInfo public function Tell the renderer about our exposed form. Overrides HandlerBase::exposedInfo
FilterPluginBase::exposedTranslate protected function Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::groupForm public function Builds a group form.
FilterPluginBase::groupMultipleExposedInput public function Group multiple exposed input.
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(). Overrides HandlerBase::init 4
FilterPluginBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase::isAGroup
FilterPluginBase::multipleExposedInput public function Multiple exposed input. Overrides HandlerBase::multipleExposedInput
FilterPluginBase::operatorForm protected function Options form subform for setting the operator. 6
FilterPluginBase::operatorOptions public function Provide a list of options for the default operator form. 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&#039;s options.
FilterPluginBase::RESTRICTED_IDENTIFIERS constant A list of restricted identifiers.
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. Overrides HandlerBase::showExposeButton
FilterPluginBase::showOperatorForm public function Shortcut to display the operator form.
FilterPluginBase::showValueForm protected function Shortcut to display the value form.
FilterPluginBase::storeExposedInput public function If set to remember exposed input in the session, store it there. Overrides HandlerBase::storeExposedInput
FilterPluginBase::storeGroupInput public function If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm public function Simple submit handler. Overrides PluginBase::submitOptionsForm
FilterPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
FilterPluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides HandlerBase::validate 2
FilterPluginBase::validateExposeForm public function Validate the options form. Overrides HandlerBase::validateExposeForm
FilterPluginBase::validateIdentifier protected function Validates a filter identifier.
FilterPluginBase::validateOptionsForm public function Simple validate handler. Overrides PluginBase::validateOptionsForm 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. 3
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$is_handler public property Tracks whether the plugin is a handler.
HandlerBase::$moduleHandler protected property The module handler. 2
HandlerBase::$query public property Where the $query object will reside. 7
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 5
HandlerBase::adminLabel public function Return a string representing this handler&#039;s name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered &#039;broken&#039;. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 10
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensures that the main table for this handler is in the query. Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::getDateField public function Creates cross-database SQL dates. 2
HandlerBase::getDateFormat public function Creates cross-database SQL date formatting. 2
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler&#039;s raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options. 1
HandlerBase::isExposed public function Determine if this item is &#039;exposed&#039;.
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Sets up any needed relationship. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::validateExposed public function Validate the exposed handler form. 4
HandlerBase::validateExtraOptionsForm public function Validate the options form.
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::create public static function Creates an instance of the plugin. Overrides PluginBase::create
HistoryUserTimestamp::query public function Add this filter to the query. Overrides FilterPluginBase::query
HistoryUserTimestamp::usesGroupBy public function Provides the handler some groupby. Overrides HandlerBase::usesGroupBy
HistoryUserTimestamp::valueForm protected function Options form subform for setting options. Overrides FilterPluginBase::valueForm
HistoryUserTimestamp::__construct public function Constructs a HistoryUserTimestamp object. Overrides HandlerBase::__construct
PluginBase::$definition public property Plugins&#039; definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$position public property The handler position.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.
UncacheableDependencyTrait::getCacheContexts public function
UncacheableDependencyTrait::getCacheMaxAge public function
UncacheableDependencyTrait::getCacheTags public function

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