LogMessageParserInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Logger/LogMessageParserInterface.php
  2. 10 core/lib/Drupal/Core/Logger/LogMessageParserInterface.php
  3. 11.x core/lib/Drupal/Core/Logger/LogMessageParserInterface.php

Namespace

Drupal\Core\Logger

File

core/lib/Drupal/Core/Logger/LogMessageParserInterface.php

View source
<?php

namespace Drupal\Core\Logger;


/**
 * Defines an interface for parsing log messages and their placeholders.
 */
interface LogMessageParserInterface {
    
    /**
     * Parses and transforms message and its placeholders to a common format.
     *
     * For a value to be considered as a placeholder should be in the following
     * formats:
     *   - @link https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#12-message The PSR3 format @endlink
     *   - The Drupal specific string placeholder format, described in
     *     \Drupal\Component\Render\FormattableMarkup
     *
     * Values in PSR3 format will be transformed to
     * \Drupal\Component\Render\FormattableMarkup format.
     *
     * @param string $message
     *   The message that contains the placeholders.
     *   If the message is in PSR3 style, it will be transformed to
     *   \Drupal\Component\Render\FormattableMarkup style.
     * @param array $context
     *   An array that may or may not contain placeholder variables.
     *
     * @return array
     *   An array of the extracted message placeholders.
     *
     * @see \Drupal\Component\Render\FormattableMarkup
     */
    public function parseMessagePlaceholders(&$message, array &$context);

}

Interfaces

Title Deprecated Summary
LogMessageParserInterface Defines an interface for parsing log messages and their placeholders.

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