interface DisplayRouterInterface in Drupal 10
Same name and namespace in other branches
- 8 core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php \Drupal\views\Plugin\views\display\DisplayRouterInterface
- 9 core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php \Drupal\views\Plugin\views\display\DisplayRouterInterface
Defines an interface for displays that can collect routes.
In addition to implementing the interface, specify 'uses_routes' in the plugin definition.
Hierarchy
- interface \Drupal\views\Plugin\views\display\DisplayPluginInterface
- interface \Drupal\views\Plugin\views\display\DisplayRouterInterface
Expanded class hierarchy of DisplayRouterInterface
All classes that implement DisplayRouterInterface
1 file declares its use of DisplayRouterInterface
- RouteSubscriber.php in core/
modules/ views/ src/ EventSubscriber/ RouteSubscriber.php
File
- core/
modules/ views/ src/ Plugin/ views/ display/ DisplayRouterInterface.php, line 13
Namespace
Drupal\views\Plugin\views\displayView source
interface DisplayRouterInterface extends DisplayPluginInterface {
/**
* Adds the route entry of a view to the collection.
*
* @param \Symfony\Component\Routing\RouteCollection $collection
* A collection of routes that should be registered for this resource.
*/
public function collectRoutes(RouteCollection $collection);
/**
* 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.
*
* @param \Symfony\Component\Routing\RouteCollection $collection
* The route collection.
*
* @return array
* Returns a list of "$view_id.$display_id" elements which got overridden.
*/
public function alterRoutes(RouteCollection $collection);
/**
* Generates a URL to this display.
*
* @return \Drupal\Core\Url
* A URL object for the display.
*/
public function getUrlInfo();
/**
* 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.
*
* @return string
* The name of the route
*
* @see \Drupal\views\Plugin\views\display\DisplayRouterInterface::alterRoutes()
* @see \Drupal\views\Plugin\views\display\DisplayRouterInterface::getAlteredRouteNames()
*/
public function getRouteName();
/**
* Returns the list of routes overridden by Views.
*
* @return string[]
* An array of overridden route names. The keys are in the form
* view_id.display_id and the values are the route names.
*
* @see \Drupal\views\Plugin\views\display\DisplayRouterInterface::alterRoutes()
*/
public function getAlteredRouteNames();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DisplayPluginInterface:: |
public | function | Determines whether this display can use attachments. | |
DisplayPluginInterface:: |
public | function | Determines if the user has access to this display of the view. | |
DisplayPluginInterface:: |
public | function | Whether the display is actually using AJAX or not. | |
DisplayPluginInterface:: |
public | function | Allows displays to attach to other views. | 1 |
DisplayPluginInterface:: |
public static | function | Builds a basic render array which can be properly render cached. | 1 |
DisplayPluginInterface:: |
public | function | Provides the default form for setting options. | 1 |
DisplayPluginInterface:: |
public | function | Builds a renderable array of the view. | |
DisplayPluginInterface:: |
public | function | Calculates the display's cache metadata by inspecting each handler/plugin. | |
DisplayPluginInterface:: |
public | function | Lists the 'defaultable' sections and what items each section contains. | 1 |
DisplayPluginInterface:: |
public | function | Destroys the display's components and the display itself. | |
DisplayPluginInterface:: |
public | function | Determines if this display should display the exposed filters widgets. | 1 |
DisplayPluginInterface:: |
public | function | #pre_render callback for view display rendering. | |
DisplayPluginInterface:: |
public | function | Executes the view and returns data in the format required. | 1 |
DisplayPluginInterface:: |
public | function | Returns to tokens for arguments. | |
DisplayPluginInterface:: |
public | function | Provides help text for the arguments. | 1 |
DisplayPluginInterface:: |
public | function | Find out all displays which are attached to this display. | |
DisplayPluginInterface:: |
public | function | Gets the cache metadata. | |
DisplayPluginInterface:: |
public | function | Gets the display extenders. | |
DisplayPluginInterface:: |
public | function | Retrieves a list of fields for the current display. | |
DisplayPluginInterface:: |
public | function | Get the handler object for a single handler. | |
DisplayPluginInterface:: |
public | function | Get a full array of handlers for $type. This caches them. | |
DisplayPluginInterface:: |
public | function | Returns the ID of the display to use when making links. | |
DisplayPluginInterface:: |
public | function | Gets an option, from this display or the default display. | |
DisplayPluginInterface:: |
public | function | Provides help text for pagers. | 1 |
DisplayPluginInterface:: |
public | function | Returns the base path to use for this display. | 1 |
DisplayPluginInterface:: |
public | function | Get the instance of a plugin, for example style or row. | |
DisplayPluginInterface:: |
public | function | Points to the display which can be linked by this display. | |
DisplayPluginInterface:: |
public | function | Provides the block system with any exposed widget blocks for this display. | |
DisplayPluginInterface:: |
public | function | Returns the display type that this display requires. | 2 |
DisplayPluginInterface:: |
public | function | Returns a URL to $this display or its configured linked display. | |
DisplayPluginInterface:: |
public | function | Checks to see if the display has a 'path' field. | 1 |
DisplayPluginInterface:: |
public | function | Initializes the display plugin. | 1 |
DisplayPluginInterface:: |
public | function | Determines if this display is the 'default' display. | |
DisplayPluginInterface:: |
public | function | Determines if an option is set to use the default or current display. | |
DisplayPluginInterface:: |
public | function | Whether the display is enabled. | |
DisplayPluginInterface:: |
public | function | Checks if the provided identifier is unique. | |
DisplayPluginInterface:: |
public | function | Whether the display is using the 'more' link or not. | |
DisplayPluginInterface:: |
public | function | Whether the display is using a pager or not. | |
DisplayPluginInterface:: |
public | function | Merges default values for all plugin types. | |
DisplayPluginInterface:: |
public | function | Reacts on adding a display. | 1 |
DisplayPluginInterface:: |
public | function | Returns a link to a section of a form. | |
DisplayPluginInterface:: |
public | function | If override/revert was clicked, perform the proper toggle. | |
DisplayPluginInterface:: |
public | function | Provides the default summary for options in the views UI. | 1 |
DisplayPluginInterface:: |
public | function | Is the output of the view empty. | |
DisplayPluginInterface:: |
public | function | Set an option and force it to be an override. | |
DisplayPluginInterface:: |
public | function | Sets up any variables on the view prior to execution. | |
DisplayPluginInterface:: |
public | function | Renders the display for the purposes of a live preview. | 2 |
DisplayPluginInterface:: |
public | function | Injects anything into the query that the display handler needs. | |
DisplayPluginInterface:: |
public | function | Reacts on deleting a display. | 1 |
DisplayPluginInterface:: |
public | function | Renders this display. | 2 |
DisplayPluginInterface:: |
public | function | Renders one of the available areas. | |
DisplayPluginInterface:: |
public | function | Does nothing (obsolete function). | |
DisplayPluginInterface:: |
public | function | Renders the 'more' link. | |
DisplayPluginInterface:: |
public | function | Checks to see if the display plugins support pager rendering. | |
DisplayPluginInterface:: |
public | function | Sets an option, on this display or the default display. | |
DisplayPluginInterface:: |
public | function | Flip the override setting for the given section. | |
DisplayPluginInterface:: |
public | function | Performs any necessary changes to the form values prior to storage. | 1 |
DisplayPluginInterface:: |
public | function | Does the display have groupby enabled? | |
DisplayPluginInterface:: |
public | function | Should the enabled display more link be shown when no more items? | |
DisplayPluginInterface:: |
public | function | Does the display have custom link text? | |
DisplayPluginInterface:: |
public | function | Whether the display allows the use of AJAX or not. | |
DisplayPluginInterface:: |
public | function | Returns whether the display can use areas. | |
DisplayPluginInterface:: |
public | function | Returns whether the display can use attachments. | |
DisplayPluginInterface:: |
public | function | Determines if this display uses exposed filters. | 1 |
DisplayPluginInterface:: |
public | function | Checks to see if the display can put the exposed form in a block. | |
DisplayPluginInterface:: |
public | function | Determines if the display's style uses fields. | |
DisplayPluginInterface:: |
public | function | Checks to see if the display has some need to link to another display. | 1 |
DisplayPluginInterface:: |
public | function | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginInterface:: |
public | function | Whether the display allows the use of a pager or not. | |
DisplayPluginInterface:: |
public | function | Make sure the display and all associated handlers are valid. | 1 |
DisplayPluginInterface:: |
public | function | Validates the options form. | 1 |
DisplayPluginInterface:: |
public | function | Renders the exposed form as block. | |
DisplayRouterInterface:: |
public | function | Alters a collection of routes and replaces definitions to the view. | 1 |
DisplayRouterInterface:: |
public | function | Adds the route entry of a view to the collection. | 1 |
DisplayRouterInterface:: |
public | function | Returns the list of routes overridden by Views. | 1 |
DisplayRouterInterface:: |
public | function | Returns the route name for the display. | 1 |
DisplayRouterInterface:: |
public | function | Generates a URL to this display. | 1 |