class FullHttpMessageFormatter in Apigee Edge 8

Full HTML debug message formatter plugin.

Plugin annotation

@DebugMessageFormatter(
  id = "full_html",
  label = @Translation("Full HTML"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter\DebugMessageFormatterPluginBase implements DebugMessageFormatterPluginInterface, ContainerFactoryPluginInterface
      • class \Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter\FullHttpMessageFormatter

File

modules/apigee_edge_debug/src/Plugin/DebugMessageFormatter/FullHttpMessageFormatter.php, line 37

Namespace

Drupal\apigee_edge_debug\Plugin\DebugMessageFormatter

class FullHttpMessageFormatter extends DebugMessageFormatterPluginBase {

  /**
   * The maximum length of the body.
   *
   * @var int
   */
  private $maxBodyLength = NULL;

  /**
   * The original full HTTP message formatter.
   *
   * @var \Http\Message\Formatter\FullHttpMessageFormatter
   */
  private static $formatter;

  /**
   * {@inheritdoc}
   */
  public function formatStats(TransferStats $stats) : string {
    $output = '';
    foreach ($this
      ->getTimeStatsInSeconds($stats) as $key => $value) {
      $output .= "{$key}: {$value}\r\n";
    }
    return $output;
  }

  /**
   * {@inheritdoc}
   */
  protected function getFormatter() : Formatter {
    if (NULL === self::$formatter) {

      // The default 1000 characters is not enough.
      self::$formatter = new OriginalFullHttpMessageFormatter($this->maxBodyLength);
    }
    return self::$formatter;
  }

  /**
   * {@inheritdoc}
   */
  public function formatResponse(ResponseInterface $response, RequestInterface $request) : string {
    return parent::formatResponse($response, $request);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DebugMessageFormatterPluginBase::$maskOrganization	protected	property	Whether to mask the organization in the request URI or not.
DebugMessageFormatterPluginBase::$removeCredentials	protected	property	Whether to remove the authorization header from the request or not.
DebugMessageFormatterPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DebugMessageFormatterPluginBase::formatRequest	public	function	Formats a request. Overrides DebugMessageFormatterPluginInterface::formatRequest
DebugMessageFormatterPluginBase::getId	public	function	Returns the ID of the debug message formatter plugin. Overrides DebugMessageFormatterPluginInterface::getId
DebugMessageFormatterPluginBase::getLabel	public	function	Returns the label of the debug message formatter plugin. Overrides DebugMessageFormatterPluginInterface::getLabel
DebugMessageFormatterPluginBase::getTimeStatsInSeconds	protected	function	Utility function that collects and formats times from transfer statistic.
DebugMessageFormatterPluginBase::__construct	public	function	DebugMessageFormatterPluginBase constructor. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FullHttpMessageFormatter::$formatter	private static	property	The original full HTTP message formatter.
FullHttpMessageFormatter::$maxBodyLength	private	property	The maximum length of the body.
FullHttpMessageFormatter::formatResponse	public	function	Formats a response. Overrides DebugMessageFormatterPluginBase::formatResponse
FullHttpMessageFormatter::formatStats	public	function	Formats stats object. Overrides DebugMessageFormatterPluginBase::formatStats
FullHttpMessageFormatter::getFormatter	protected	function	Returns the wrapped message formatter. Overrides DebugMessageFormatterPluginBase::getFormatter
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.