How are messages rendered on a page?

dmitry_fedyuk (Dmitrii Fediuk) August 2, 2016, 3:20pm 1

lib/internal/Magento/Framework/View/Element/Messages.php#L263-L291

/**
 * Render messages in HTML format grouped by type
 *
 * @return string
 */
protected function _renderMessagesByType()
{
	$html = '';
	foreach ($this->getMessageTypes() as $type) {
		if ($messages = $this->getMessagesByType($type)) {
			if (!$html) {
				$html .= '<' . $this->firstLevelTagName . ' class="messages">';
			}
			foreach ($messages as $message) {
				$html .= '<' . $this->secondLevelTagName . ' class="message ' . 'message-' . $type . ' ' . $type .
					'">';
				$html .= '<' . $this->contentWrapTagName . $this->getUiId('message', $type) . '>';
				$html .= $this->interpretationStrategy->interpret($message);
				$html .= '</' . $this->contentWrapTagName . '>';
				$html .= '</' . $this->secondLevelTagName . '>';
			}
		}
	}
	if ($html) {
		$html .= '</' . $this->firstLevelTagName . '>';
	}
	return $html;
}

github.com

magento/magento2/blob/2.1.0/app/code/Magento/Theme/etc/di.xml#L16-L16


<preference for="Magento\Framework\View\Element\Message\InterpretationStrategyInterface" type="Magento\Framework\View\Element\Message\InterpretationMediator" />

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/InterpretationMediator.php#L17-L24


/**
 * @param InterpretationStrategy $interpretationStrategy
 */
public function __construct(
    InterpretationStrategy $interpretationStrategy
) {
    $this->interpretationStrategy = $interpretationStrategy;
}

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/InterpretationMediator.php#L26-L43


/**
 * Interpret message
 *
 * @param MessageInterface $message
 * @return string
 */
public function interpret(MessageInterface $message)
{
    if ($message->getIdentifier()) {
        try {
            return $this->interpretationStrategy->interpret($message);
        } catch (\LogicException $e) {
            // pass
        }
    }


    return $message->getText();
}

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/InterpretationStrategy.php#L23-L33


/**
 * @param RenderersPool $renderersPool
 * @param MessageConfigurationsPool $messageConfigurationsPool
 */
public function __construct(
    RenderersPool $renderersPool,
    MessageConfigurationsPool $messageConfigurationsPool
) {
    $this->renderersPool = $renderersPool;
    $this->messageConfigurationsPool = $messageConfigurationsPool;
}

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/InterpretationStrategy.php#L42-L57


public function interpret(MessageInterface $message)
{
    $messageConfiguration = $this->messageConfigurationsPool->getMessageConfiguration(
        $message->getIdentifier()
    );
    if (null === $messageConfiguration) {
        throw new \LogicException();
    }


    $renderer = $this->renderersPool->get($messageConfiguration['renderer']);
    if (null === $renderer) {
        throw new \LogicException();
    }


    return $renderer->render($message, $messageConfiguration['data']);
}

github.com

magento/magento2/blob/2.1.0/app/code/Magento/Theme/etc/di.xml#L22-L38


<type name="Magento\Framework\View\Element\Message\Renderer\RenderersPool">
    <arguments>
        <argument name="renderers" xsi:type="array">
            <item name="escape_renderer" xsi:type="object">Magento\Framework\View\Element\Message\Renderer\EscapeRenderer</item>
            <item name="block_renderer" xsi:type="object">Magento\Framework\View\Element\Message\Renderer\BlockRenderer</item>
        </argument>
    </arguments>
</type>
<type name="Magento\Framework\View\Element\Message\MessageConfigurationsPool">
    <arguments>
        <argument name="configurationsMap" xsi:type="array">
            <item name="default_message_identifier" xsi:type="array">
                <item name="renderer" xsi:type="const">\Magento\Framework\View\Element\Message\Renderer\EscapeRenderer::CODE</item>
            </item>
        </argument>
    </arguments>
</type>

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/Renderer/EscapeRenderer.php#L32-L42


/**
 * Renders complex message
 *
 * @param MessageInterface $message
 * @param array $initializationData
 * @return string
 */
public function render(MessageInterface $message, array $initializationData)
{
    return $this->escaper->escapeHtml($message->getText());
}

github.com

magento/magento2/blob/2.1.0/lib/internal/Magento/Framework/View/Element/Message/Renderer/BlockRenderer.php#L37-L53


/**
 * Renders complex message
 *
 * @param MessageInterface $message
 * @param array $initializationData
 * @return string
 */
public function render(MessageInterface $message, array $initializationData)
{
    $this->setUpConfiguration($message->getData(), $initializationData);


    $result = $this->template->toHtml();


    $this->tearDownConfiguration();


    return $result;
}

github.com

magento/magento2/blob/2.1.0/app/code/Magento/Wishlist/etc/frontend/di.xml#L38-L49


<type name="Magento\Framework\View\Element\Message\MessageConfigurationsPool">
    <arguments>
        <argument name="configurationsMap" xsi:type="array">
            <item name="addProductSuccessMessage" xsi:type="array">
                <item name="renderer" xsi:type="const">\Magento\Framework\View\Element\Message\Renderer\BlockRenderer::CODE</item>
                <item name="data" xsi:type="array">
                    <item name="template" xsi:type="string">Magento_Wishlist::messages/addProductSuccessMessage.phtml</item>
                </item>
            </item>
        </argument>
    </arguments>
</type>

How to preserve the HTML tags in an on-page message?

dmitry_fedyuk (Dmitrii Fediuk) August 2, 2016, 4:07pm 2

See also:

How to preserve the HTML tags in an on-page message?