interface DebugMessageFormatterPluginInterface in Apigee Edge 8

Defines an interface for debug message formatter plugins.

Hierarchy

• interface \Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter\DebugMessageFormatterPluginInterface

1 file declares its use of DebugMessageFormatterPluginInterface

DebugMessageFormatterPluginManager.php in modules/apigee_edge_debug/src/DebugMessageFormatterPluginManager.php

File

modules/apigee_edge_debug/src/Plugin/DebugMessageFormatter/DebugMessageFormatterPluginInterface.php, line 30

Namespace

Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter

interface DebugMessageFormatterPluginInterface {

  /**
   * Returns the ID of the debug message formatter plugin.
   *
   * @return string
   *   The ID of the debug message formatter plugin.
   */
  public function getId() : string;

  /**
   * Returns the label of the debug message formatter plugin.
   *
   * @return string
   *   The label of the debug message formatter plugin.
   */
  public function getLabel() : string;

  /**
   * Formats a request.
   *
   * @param \Psr\Http\Message\RequestInterface $request
   *   Request object.
   *
   * @return string
   *   Formatted request.
   */
  public function formatRequest(RequestInterface $request) : string;

  /**
   * Formats a response.
   *
   * @param \Psr\Http\Message\ResponseInterface $response
   *   Response object.
   * @param \Psr\Http\Message\RequestInterface $request
   *   Request object that triggered the response.
   *
   * @return string
   *   Formatted response.
   */
  public function formatResponse(ResponseInterface $response, RequestInterface $request) : string;

  /**
   * Formats stats object.
   *
   * @param \GuzzleHttp\TransferStats $stats
   *   Transfer statistics.
   *
   * @return string
   *   Formatted output.
   */
  public function formatStats(TransferStats $stats) : string;

}

Members

Name	Modifiers	Type	Description	Overrides
DebugMessageFormatterPluginInterface::formatRequest	public	function	Formats a request.	1
DebugMessageFormatterPluginInterface::formatResponse	public	function	Formats a response.	1
DebugMessageFormatterPluginInterface::formatStats	public	function	Formats stats object.	1
DebugMessageFormatterPluginInterface::getId	public	function	Returns the ID of the debug message formatter plugin.	1
DebugMessageFormatterPluginInterface::getLabel	public	function	Returns the label of the debug message formatter plugin.	1