StringListField

Constructs a Handler 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.

Overrides Drupal\views\Plugin\views\HandlerBase:init().

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.

Build the query based upon the formula.

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.

Return a string representing this handler's name in the UI.

Shortcut to get a handler's raw field value.

This should be overridden for handlers with formulae or other non-standard fields. Because this takes an argument, fields overriding this can just call return parent::getField($formula)

Sanitize the value for output.

Transform a string by a certain method.

Gets the module handler.

Sets the module handler.

Provides the handler some groupby.

Provide a form for aggregation settings.

Perform any necessary changes to the form values prior to storage.

There is no need for this function to actually store the data.

If a handler has 'extra options' it will get a little settings widget and another form called extra_options.

Provide defaults for the handler.

Provide a form for setting options.

Validate the options form.

Perform any necessary changes to the form values prior to storage.

There is no need for this function to actually store the data.

Determine if a handler can be exposed.

Set new exposed option defaults when exposed setting is flipped on.

Get information about the exposed form for the form renderer.

Render our chunk of the exposed handler form when selecting.

Validate the exposed handler form.

Submit the exposed handler form.

Form for exposed handler options.

Validate the options form.

Perform any necessary changes to the form exposes prior to storage.

There is no need for this function to actually store the data.

Shortcut to display the expose/hide button.

Shortcut to display the exposed options form.

Check whether given user has access to this handler.

Run before the view is built.

This gives all the handlers some time to set up before any handler has been fully run.

Run after the view is executed, before the result is cached.

This gives all the handlers some time to modify values. This is primarily used so that handlers that pull up secondary data can put it in the $values so that the raw data can be used externally.

Provides a unique placeholders for handlers.

Called just prior to query(), this lets a handler set up any relationship it needs.

Ensure the main table for this handler is in the query. This is used a lot.

Provide text for the administrative summary.

Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.

Returns TRUE if the exposed filter works like a grouped filter.

Define if the exposed input has to be submitted multiple times.

This is TRUE when exposed filters grouped are using checkboxes as widgets.

Take input from exposed handlers and assign to this handler, if necessary.

If set to remember exposed input in the session, store it there.

Get the join object that should be used for this handler.

This method isn't used a great deal, but it's very handy for easily getting the join if it is necessary to make some changes to it, such as adding an 'extra'.

Determines if the handler is considered 'broken', meaning it's a placeholder used when a handler can't be found.

Creates cross-database SQL date formatting.

Creates cross-database SQL dates.

Gets views data service.

{@inheritdoc}

Fetches a handler to join one table to a primary table from the data cache.

Determines the entity type used by this handler.

If this handler uses a relationship, the base class of the relationship is taken into account.

Breaks x,y,z and x+y+z into an array.

Displays the Expose form.

A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests.

Calculates options stored on the handler.

No description

No description

Determine if the argument needs a style plugin.

Provide token help information for the argument.

Provide a list of default behaviors for this argument if the argument is not present.

Override this method to provide additional (or fewer) default behaviors.

Provide a form for selecting the default argument when the default action is set to provide default argument.

Provide a form for selecting further summary options when the default action is set to display one.

Handle the default action, which means our argument wasn't present.

Override this method only with extreme care.

How to act if validation fails.

Default action: ignore.

If an argument was expected and was not given, in this case, simply ignore the argument entirely.

Default action: not found.

If an argument was expected and was not given, in this case, report the view as 'not found' or hide it.

Default action: access denied.

If an argument was expected and was not given, in this case, report the view as 'access denied'.

Default action: empty.

If an argument was expected and was not given, in this case, display the view's empty text

This just returns true. The view argument builder will know where to find the argument from.

Determine if the argument is set to provide a default argument.

Get a default argument, if available.

Process the summary arguments for display.

For example, the validation plugin may want to alter an argument for use in the URL.

Default action: summary.

If an argument was expected and was not given, in this case, display a summary query.

Build the summary query based on a string.

Add the name field, which is the field displayed in summary queries.

This is often used when the argument is numeric.

Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery()

Sorts the summary based upon the user's selection. The base variant of this is usually adequate.

Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->getUrl().

Provides the name to use for the summary. By default this is just the name field.

Get the title this argument will assign the view, given the argument.

This usually needs to be overridden to provide a proper title.

Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().

Validate that this argument works. By default, all arguments are valid.

Called by the menu system to validate an argument.

This checks to see if this is a 'soft fail', which means that if the argument fails to validate, but there is an action to take anyway, then validation cannot actually fail.

Set the input for this argument.

Get the value of this argument.

Get the display or row plugin, if it exists.

Return a description of how the argument would normally be sorted.

Subclasses should override this to specify what the default sort order of their argument is (e.g. alphabetical, numeric, date).

Custom form radios process function.

Roll out a single radios element to a list of radios, using the options array as index. While doing that, create a container element underneath each option, which contains the settings related to that option.

Moves argument options into their place.

When configuring the default argument behavior, almost each of the radio buttons has its own fieldset shown below it when the radio button is clicked. That fieldset is created through a custom form process callback. Each element that has #argument_option defined and pointing to a default behavior gets moved to the appropriate fieldset. So if #argument_option is specified as 'default', the element is moved to the 'default_options' fieldset.

Sanitize validator options including derivatives with : for js.

Reason and alternative: https://www.drupal.org/node/2035345.

Revert sanitized validator options.

Splits an argument into value and operator properties on this instance.

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.

Returns a context definition for this argument.

Get the formula for this argument.

$this->ensureMyTable() MUST have been called prior to this.

Override for specific title lookups.

Gets the field definition.

A View works on an entity type across bundles, and thus only has access to field storage definitions. In order to be able to use widgets and formatters, we create a generic field definition out of that storage definition.

Gets the field storage configuration.

Returns the entity field manager.