ResponseDisplayPluginInterface.php

Same filename in other branches
  1. 9 core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php
  2. 8.9.x core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php
  3. 10 core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php

Namespace

Drupal\views\Plugin\views\display

File

core/modules/views/src/Plugin/views/display/ResponseDisplayPluginInterface.php

View source
<?php

namespace Drupal\views\Plugin\views\display;


/**
 * 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.
 */
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 = []);

}

Interfaces

Title Deprecated Summary
ResponseDisplayPluginInterface Defines a display which returns a Response object.

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