interface ResponseDisplayPluginInterface

Same name and namespace in other branches
  1. 11.x core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php \Drupal\views\Plugin\views\display\ResponseDisplayPluginInterface

Defines a display which returns a Response object.

This interface is meant to be used for display plugins, which do return some other format requiring to return a response directly.

Hierarchy

Expanded class hierarchy of ResponseDisplayPluginInterface

All classes that implement ResponseDisplayPluginInterface

1 file declares its use of ResponseDisplayPluginInterface
RestExport.php in core/modules/rest/src/Plugin/views/display/RestExport.php

File

core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php, line 11

Namespace

Drupal\views\Plugin\views\display
View on git.drupalcode.org
View source 
interface ResponseDisplayPluginInterface extends DisplayPluginInterface {
  
  /**
   * Builds up a response with the rendered view as content.
   *
   * @param string $view_id
   *   The view ID.
   * @param string $display_id
   *   The display ID.
   * @param array $args
   *   (optional) The arguments of the view.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The built response.
   */
  public static function buildResponse($view_id, $display_id, array $args = []);

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.