interface OpenApiUiInterface in OpenAPI UI 8

Defines the structure for an openapi_ui plugin.

Hierarchy

• interface \Drupal\openapi_ui\Plugin\openapi_ui\OpenApiUiInterface

1 file declares its use of OpenApiUiInterface

OpenApiUi.php in src/Element/OpenApiUi.php

File

src/Plugin/openapi_ui/OpenApiUiInterface.php, line 8

Namespace

Drupal\openapi_ui\Plugin\openapi_ui

interface OpenApiUiInterface {

  /**
   * Render the tree for an openapi doc library.
   *
   * The callback is trigged to allow the plugin to define the plugin or library
   * specific rendering which needs to happen in order to construct the element.
   *
   * @param array $render_element
   *   The render array structure for the element which is triggering the build
   *   of this plugin's rendering.
   *
   * @return array
   *   The processed render array.
   */
  public function build(array $render_element);

}

Members

Name	Modifiers	Type	Description	Overrides
OpenApiUiInterface::build	public	function	Render the tree for an openapi doc library.	1