interface DisplayRouterInterface in Drupal 8

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

2 files declare their use of DisplayRouterInterface

RouteSubscriber.php in core/modules/views/src/EventSubscriber/RouteSubscriber.php

ViewExecutable.php in core/modules/views/src/ViewExecutable.php

File

core/modules/views/src/Plugin/views/display/DisplayRouterInterface.php, line 13

Namespace

Drupal\views\Plugin\views\display

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
   *
   * @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::acceptAttachments	public	function	Determines whether this display can use attachments.	1
DisplayPluginInterface::access	public	function	Determines if the user has access to this display of the view.	1
DisplayPluginInterface::ajaxEnabled	public	function	Whether the display is actually using AJAX or not.	1
DisplayPluginInterface::attachTo	public	function	Allows displays to attach to other views.	1
DisplayPluginInterface::buildBasicRenderable	public static	function	Builds a basic render array which can be properly render cached.	1
DisplayPluginInterface::buildOptionsForm	public	function	Provides the default form for setting options.
DisplayPluginInterface::buildRenderable	public	function	Builds a renderable array of the view.	1
DisplayPluginInterface::calculateCacheMetadata	public	function	Calculates the display's cache metadata by inspecting each handler/plugin.	1
DisplayPluginInterface::defaultableSections	public	function	Lists the 'defaultable' sections and what items each section contains.	1
DisplayPluginInterface::destroy	public	function	Destroys the display's components and the display itself.
DisplayPluginInterface::displaysExposed	public	function	Determines if this display should display the exposed filters widgets.	1
DisplayPluginInterface::elementPreRender	public	function	#pre_render callback for view display rendering.	1
DisplayPluginInterface::execute	public	function	Executes the view and returns data in the format required.	1
DisplayPluginInterface::getArgumentsTokens	public	function	Returns to tokens for arguments.	1
DisplayPluginInterface::getArgumentText	public	function	Provides help text for the arguments.	1
DisplayPluginInterface::getAttachedDisplays	public	function	Find out all displays which are attached to this display.	1
DisplayPluginInterface::getCacheMetadata	public	function	Gets the cache metadata.	1
DisplayPluginInterface::getExtenders	public	function	Gets the display extenders.	1
DisplayPluginInterface::getFieldLabels	public	function	Retrieves a list of fields for the current display.	1
DisplayPluginInterface::getHandler	public	function	Get the handler object for a single handler.	1
DisplayPluginInterface::getHandlers	public	function	Get a full array of handlers for $type. This caches them.	1
DisplayPluginInterface::getLinkDisplay	public	function	Returns the ID of the display to use when making links.	1
DisplayPluginInterface::getOption	public	function	Gets an option, from this display or the default display.	1
DisplayPluginInterface::getPagerText	public	function	Provides help text for pagers.	1
DisplayPluginInterface::getPath	public	function	Returns the base path to use for this display.	1
DisplayPluginInterface::getPlugin	public	function	Get the instance of a plugin, for example style or row.	1
DisplayPluginInterface::getRoutedDisplay	public	function	Points to the display which can be linked by this display.	1
DisplayPluginInterface::getSpecialBlocks	public	function	Provides the block system with any exposed widget blocks for this display.	1
DisplayPluginInterface::getType	public	function	Returns the display type that this display requires.	1
DisplayPluginInterface::getUrl	public	function	Returns a URL to $this display or its configured linked display.	1
DisplayPluginInterface::hasPath	public	function	Checks to see if the display has a 'path' field.	1
DisplayPluginInterface::initDisplay	public	function	Initializes the display plugin.	1
DisplayPluginInterface::isDefaultDisplay	public	function	Determines if this display is the 'default' display.	1
DisplayPluginInterface::isDefaulted	public	function	Determines if an option is set to use the default or current display.	1
DisplayPluginInterface::isEnabled	public	function	Whether the display is enabled.	1
DisplayPluginInterface::isIdentifierUnique	public	function	Checks if the provided identifier is unique.	1
DisplayPluginInterface::isMoreEnabled	public	function	Whether the display is using the 'more' link or not.	1
DisplayPluginInterface::isPagerEnabled	public	function	Whether the display is using a pager or not.	1
DisplayPluginInterface::mergeDefaults	public	function	Merges default values for all plugin types.	1
DisplayPluginInterface::newDisplay	public	function	Reacts on adding a display.	1
DisplayPluginInterface::optionLink	public	function	Returns a link to a section of a form.	1
DisplayPluginInterface::optionsOverride	public	function	If override/revert was clicked, perform the proper toggle.	1
DisplayPluginInterface::optionsSummary	public	function	Provides the default summary for options in the views UI.	1
DisplayPluginInterface::outputIsEmpty	public	function	Is the output of the view empty.	1
DisplayPluginInterface::overrideOption	public	function	Set an option and force it to be an override.	1
DisplayPluginInterface::preExecute	public	function	Sets up any variables on the view prior to execution.	1
DisplayPluginInterface::preview	public	function	Renders the display for the purposes of a live preview.	1
DisplayPluginInterface::query	public	function	Injects anything into the query that the display handler needs.
DisplayPluginInterface::remove	public	function	Reacts on deleting a display.	1
DisplayPluginInterface::render	public	function	Renders this display.	1
DisplayPluginInterface::renderArea	public	function	Renders one of the available areas.	1
DisplayPluginInterface::renderFilters	public	function	Does nothing (obsolete function).	1
DisplayPluginInterface::renderMoreLink	public	function	Renders the 'more' link.	1
DisplayPluginInterface::renderPager	public	function	Checks to see if the display plugins support pager rendering.	1
DisplayPluginInterface::setOption	public	function	Sets an option, on this display or the default display.	1
DisplayPluginInterface::setOverride	public	function	Flip the override setting for the given section.	1
DisplayPluginInterface::submitOptionsForm	public	function	Performs any necessary changes to the form values prior to storage.
DisplayPluginInterface::useGroupBy	public	function	Does the display have groupby enabled?	1
DisplayPluginInterface::useMoreAlways	public	function	Should the enabled display more link be shown when no more items?	1
DisplayPluginInterface::useMoreText	public	function	Does the display have custom link text?	1
DisplayPluginInterface::usesAJAX	public	function	Whether the display allows the use of AJAX or not.	1
DisplayPluginInterface::usesAreas	public	function	Returns whether the display can use areas.	1
DisplayPluginInterface::usesAttachments	public	function	Returns whether the display can use attachments.	1
DisplayPluginInterface::usesExposed	public	function	Determines if this display uses exposed filters.	1
DisplayPluginInterface::usesExposedFormInBlock	public	function	Checks to see if the display can put the exposed form in a block.	1
DisplayPluginInterface::usesFields	public	function	Determines if the display's style uses fields.	1
DisplayPluginInterface::usesLinkDisplay	public	function	Checks to see if the display has some need to link to another display.	1
DisplayPluginInterface::usesMore	public	function	Whether the display allows the use of a 'more' link or not.	1
DisplayPluginInterface::usesPager	public	function	Whether the display allows the use of a pager or not.	1
DisplayPluginInterface::validate	public	function	Make sure the display and all associated handlers are valid.
DisplayPluginInterface::validateOptionsForm	public	function	Validates the options form.
DisplayPluginInterface::viewExposedFormBlocks	public	function	Renders the exposed form as block.	1
DisplayRouterInterface::alterRoutes	public	function	Alters a collection of routes and replaces definitions to the view.	1
DisplayRouterInterface::collectRoutes	public	function	Adds the route entry of a view to the collection.	1
DisplayRouterInterface::getAlteredRouteNames	public	function	Returns the list of routes overridden by Views.	1
DisplayRouterInterface::getRouteName	public	function	Returns the route name for the display.	1
DisplayRouterInterface::getUrlInfo	public	function	Generates a URL to this display.	1