function LogMessageParser::parseMessagePlaceholders

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Logger/LogMessageParser.php \Drupal\Core\Logger\LogMessageParser::parseMessagePlaceholders()
  2. 8.9.x core/lib/Drupal/Core/Logger/LogMessageParser.php \Drupal\Core\Logger\LogMessageParser::parseMessagePlaceholders()
  3. 11.x core/lib/Drupal/Core/Logger/LogMessageParser.php \Drupal\Core\Logger\LogMessageParser::parseMessagePlaceholders()

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:

Values in PSR3 format will be transformed to \Drupal\Component\Render\FormattableMarkup format.

Parameters

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.

array $context: An array that may or may not contain placeholder variables.

Return value

array An array of the extracted message placeholders.

Overrides LogMessageParserInterface::parseMessagePlaceholders

File

core/lib/Drupal/Core/Logger/LogMessageParser.php, line 13

Class

LogMessageParser
Parses log messages and their placeholders.

Namespace

Drupal\Core\Logger

Code

public function parseMessagePlaceholders(&$message, array &$context) {
  $variables = [];
  $has_psr3 = FALSE;
  if (($start = strpos($message, '{')) !== FALSE && strpos($message, '}') > $start) {
    $has_psr3 = TRUE;
    // Transform PSR3 style messages containing placeholders to
    // \Drupal\Component\Render\FormattableMarkup style.
    $message = preg_replace('/\\{([^\\{}]*)\\}/U', '@$1', $message);
  }
  foreach ($context as $key => $variable) {
    // PSR3 style placeholders.
    if ($has_psr3) {
      // Keys are not prefixed with anything according to PSR3 specs.
      // If the message is "User {username} created" the variable key will be
      // just "username".
      if (str_contains($message, '@' . $key)) {
        $key = '@' . $key;
      }
    }
    // To be considered a valid placeholder, the key should be in
    // \Drupal\Component\Render\FormattableMarkup style and the variable
    // should be a string, number, or \Stringable object. For historical
    // reasons, Boolean and NULL placeholders are also allowed; NULL
    // placeholders are deprecated and may throw an error in the future.
    // @see https://www.drupal.org/node/3318826
    if (!empty($key) && ($key[0] === '@' || $key[0] === '%' || $key[0] === ':')) {
      if (is_scalar($variable) || is_null($variable) || $variable instanceof \Stringable) {
        $variables[$key] = $variable;
      }
    }
  }
  return $variables;
}

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