Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Logger/LogMessageParserInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children | 129ea1e6d783 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Logger/LogMessageParserInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,34 @@ +<?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: + * - PSR3 format: + * @see https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md#12-message + * - Drupal specific string placeholder format: + * @see \Drupal\Component\Utility\SafeMarkup::format() + * + * Values in PSR3 format will be transformed to SafeMarkup::format() format. + * + * @param string $message + * The message that contains the placeholders. + * If the message is in PSR3 style, it will be transformed to + * \Drupal\Component\Utility\SafeMarkup::format() style. + * @param array $context + * An array that may or may not contain placeholder variables. + * + * @return array + * An array of the extracted message placeholders. + */ + public function parseMessagePlaceholders(&$message, array &$context); + +}