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

Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase:defineOptions().

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.

Add anything to the query that we might need to.

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.

Adds a dependency.

Adds multiple dependencies.

Calculates and returns dependencies of a specific plugin instance.

Dependencies are added for the module that provides the plugin, as well as any dependencies declared by the instance's calculateDependencies() method, if it implements \Drupal\Component\Plugin\DependentPluginInterface.

Calculates and adds dependencies of a specific plugin instance.

Dependencies are added for the module that provides the plugin, as well as any dependencies declared by the instance's calculateDependencies() method, if it implements \Drupal\Component\Plugin\DependentPluginInterface.

Wraps the module handler.

Wraps the theme handler.

Initializes the display plugin.

Determines if this display is the 'default' display.

'Default' display contains fallback settings.

Determines if this display uses exposed filters.

Determines if this display should display the exposed filters widgets.

Regardless of what this function returns, exposed filters will not be used nor displayed unless usesExposed() returns TRUE.

Whether the display allows the use of AJAX or not.

Whether the display is actually using AJAX or not.

Whether the display is enabled.

Whether the display allows the use of a pager or not.

Whether the display is using a pager or not.

Whether the display allows the use of a 'more' link or not.

Whether the display is using the 'more' link or not.

Does the display have groupby enabled?

Should the enabled display more link be shown when no more items?

Does the display have custom link text?

Determines whether this display can use attachments.

Returns whether the display can use attachments.

Returns whether the display can use areas.

Allows displays to attach to other views.

Lists the 'defaultable' sections and what items each section contains.

Checks to see if the display has a 'path' field.

This is a pure function and not just a setting on the definition because some displays (such as a panel pane) may have a path based upon configuration.

By default, displays do not have a path.

Checks to see if the display has some need to link to another display.

For the most part, displays without a path will use a link display. However, sometimes displays that have a path might also need to link to another display. This is true for feeds.

Checks to see if the display can put the exposed form in a block.

By default, displays that do not have a path cannot disconnect the exposed form and put it in a block, because the form has no place to go and Views really wants the forms to go to a specific page.

Find out all displays which are attached to this display.

The method is just using the pure storage object to avoid loading of the sub displays which would kill lazy loading.

Returns the ID of the display to use when making links.

Returns the base path to use for this display.

This can be overridden for displays that do strange things with the path.

Points to the display which can be linked by this display.

If the display has route information, the display itself is returned. Otherwise, the configured linked display is returned. For example, if a block display links to a page display, the page display will be returned in both cases.

Returns a URL to $this display or its configured linked display.

Determines if an option is set to use the default or current display.

Gets an option, from this display or the default display.

Determines if the display's style uses fields.

Get the instance of a plugin, for example style or row.

Get the handler object for a single handler.

Get a full array of handlers for $type. This caches them.

Gets all the handlers used by the display.

Gets all the plugins used by the display.

Retrieves a list of fields for the current display.

This also takes into account any associated relationships, if they exist.

Sets an option, on this display or the default display.

Set an option and force it to be an override.

Returns a link to a section of a form.

Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.

Returns to tokens for arguments.

This function is similar to views_handler_field::getRenderTokens() but without fields tokens.

Provides the default summary for options in the views UI.

This output is returned as an array.

If override/revert was clicked, perform the proper toggle.

Flip the override setting for the given section.

Does nothing (obsolete function).

Checks to see if the display plugins support pager rendering.

Renders the 'more' link.

Get the more URL for this view.

Uses the custom URL if there is one, otherwise the display path.

Renders this display.

Applies the cacheability of the current display to the given render array.

pre_render callback for view display rendering.

Renders one of the available areas.

Determines if the user has access to this display of the view.

Sets up any variables on the view prior to execution.

These are separated from execute because they are extremely common and unlikely to be overridden on an individual display.

Calculates the display's cache metadata by inspecting each handler/plugin.

Gets the cache metadata.

Executes the view and returns data in the format required.

The base class cannot be executed.

Builds a renderable array of the view.

Note: This does not yet contain the executed view, but just the loaded view executable.

Builds a basic render array which can be properly render cached.

In order to be rendered cached, it includes cache keys as well as the data required to load the view on cache misses.

Renders the display for the purposes of a live preview.

Also might be used for some other AJAXy reason.

Returns the display type that this display requires.

This can be used for filtering views plugins. E.g. if a plugin category of 'foo' is specified, only plugins with no 'types' declared or 'types' containing 'foo'. If you have a type of bar, this plugin will not be used. This is applicable for style, row, access, cache, and exposed_form plugins.

Reacts on adding a display.

Checks if the provided identifier is unique.

Is the output of the view empty.

If a view has no result and neither the empty, nor the footer nor the header does show anything return FALSE.

Provides the block system with any exposed widget blocks for this display.

Renders the exposed form as block.

Provides help text for the arguments.

Provides help text for pagers.

Merges default values for all plugin types.

Reacts on deleting a display.

Merges plugins default values.

Merges handlers default values.

Gets the display extenders.

Returns the available rendering strategies for language-aware entities.

Returns whether the base table is of a translatable entity type.

Determines if this display's path is a default tab.

Generates a route entry for a given view and display.

Adds the route entry of a view to the collection.

Determines whether the view overrides the given route.

Determines whether an override for the path and method should happen.

Alters a collection of routes and replaces definitions to the view.

Most of the collections won't have the needed route, so by the return value the method can specify to break the search.

Gets menu links, if this display provides some.

Validates the path of the display.

Generates a URL to this display.

Returns the route name for the display.

The default route name for a display is views.$view_id.$display_id. Some displays may override existing routes; in these cases, the route that is overridden is returned instead.

Returns the list of routes overridden by Views.