DebugMessageFormatterPluginInterface.php in Apigee Edge 8
File
modules/apigee_edge_debug/src/Plugin/DebugMessageFormatter/DebugMessageFormatterPluginInterface.phpView source
<?php
/**
* Copyright 2018 Google Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
namespace Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter;
use GuzzleHttp\TransferStats;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
/**
* Defines an interface for debug message formatter plugins.
*/
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;
}
Interfaces
Name | Description |
---|---|
DebugMessageFormatterPluginInterface | Defines an interface for debug message formatter plugins. |