QueryPluginBase

Constructs a PluginBase object.

Gets the plugin_id of the plugin instance.

Gets the base_plugin_id of the plugin instance.

Gets the derivative_id of the plugin instance.

Gets the definition of the plugin implementation.

Determines if the plugin is configurable.

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Formats a string containing a count of items.

Returns the number of plurals supported by a given language.

Gets the string translation service.

Sets the string translation service to use.

{@inheritdoc}

{@inheritdoc}

Sets the messenger.

Gets the messenger.

Creates an instance of the plugin.

Initialize the plugin.

Information about options for all kinds of purposes will be held here.

Fills up the options of the plugin with defaults.

Filter out stored options depending on the defined options.

Do the work to filter out stored options depending on the defined options.

Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.

Clears a plugin.

Provide a form to edit options for this plugin.

Lists the trusted callbacks provided by the implementing class.

Trusted callbacks are public methods on the implementing class and can be invoked via \Drupal\Core\Security\DoTrustedCallbackTrait::doTrustedCallback().

Validate the options form.

Handle any special handling on the validate form.

Generate a query and a countquery from all of the information supplied to the object.

Provide a full list of possible theme templates used by this style.

Validate that the plugin is correct and can be saved.

Returns the summary of the settings in the display.

Return the human readable name of the display.

This appears on the ui beside each plugin and beside the settings link.

Returns the usesOptions property.

Returns a string with any core tokens replaced.

Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin.

Returns an array of available token replacements.

Adds elements for available core tokens to a form.

Moves form elements into fieldsets for presentation purposes.

Many views forms use #tree = TRUE to keep their values in a hierarchy for easier storage. Moving the form elements into fieldsets during form building would break up that hierarchy. Therefore, we wait until the pre_render stage, where any changes we make affect presentation only and aren't reflected in $form_state->getValues().

Flattens the structure of form elements.

If a form element has #flatten = TRUE, then all of its children get moved to the same level as the element itself. So $form['to_be_flattened'][$key] becomes $form[$key], and $form['to_be_flattened'] gets unset.

Calculates dependencies for the configured plugin.

Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Returns the plugin provider.

Makes an array of languages, optionally including special languages.

Returns substitutions for Views queries for languages.

This is needed so that the language options returned by PluginBase::listLanguages() are able to be used in queries. It is called by the Views module implementation of hook_views_query_substitutions() to get the language-related substitutions.

Returns the render API renderer.

Let modules modify the query just prior to finalizing it.

Builds the necessary info to execute the query.

Executes the query and fills the associated view object with according values.

Values to set: $view->result, $view->total_rows, $view->execute_time, $view->pager['current_page'].

$view->result should contain an array of objects. The array must use a numeric index starting at 0.

Add a signature to the query, if such a thing is feasible.

This signature is something that can be used when perusing query logs to discern where particular queries might be coming from.

Get aggregation info for group by queries.

If NULL, aggregation is not allowed.

Set a LIMIT on the query, specifying a maximum number of results.

Set an OFFSET on the query, specifying a number of results to skip.

Returns the limit of the query.

Create a new grouping for the WHERE or HAVING clause.

Control how all WHERE and HAVING groups are put together.

Loads all entities contained in the passed-in $results.

If the entity belongs to the base table, then it gets stored in $result->_entity. Otherwise, it gets stored in $result->_relationship_entities[$relationship_id];

Query plugins that don't support entities can leave the method empty.

Returns a Unix timestamp to database native timestamp expression.

Set the database to the current user timezone.

Creates cross-database date formatting.

Returns an array of all tables from the query that map to an entity type.

Includes the base table and all relationships, if eligible.

Available keys for each table:

• base: The actual base table (i.e. "user" for an author relationship).
• relationship_id: The id of the relationship, or "none".
• alias: The alias used for the relationship.
• entity_type: The entity type matching the base table.
• revision: A boolean that specifies whether the table is a base table or a revision table of the entity type.

The maximum age for which this object may be cached.

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

Applies a timezone offset to the given field.

Get the timezone offset in seconds.