AbstractStandaloneMessage.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Messaging;

abstract class AbstractStandaloneMessage extends \TYPO3\CMS\Core\Messaging\AbstractMessage {

    protected $htmlTemplate;

    protected $defaultMarkers = array();

    protected $markers = array();

    public function __construct($message = '', $title = '', $severity = \TYPO3\CMS\Core\Messaging\AbstractMessage::ERROR) {
        if (!empty($message)) {
            $this->setMessage($message);
        }
        $this->setTitle(!empty($title) ? $title : 'Error!');
        $this->setSeverity($severity);
    }

    public function setMarkers(array $markers) {
        $this->markers = array_merge($this->markers, $markers);
    }

    protected function getDefaultMarkers() {
        $classes = array(
            self::NOTICE => 'notice',
            self::INFO => 'information',
            self::OK => 'ok',
            self::WARNING => 'warning',
            self::ERROR => 'error'
        );
        $defaultMarkers = array(
            '###CSS_CLASS###' => $classes[$this->severity],
            '###TITLE###' => $this->title,
            '###MESSAGE###' => $this->message,
            // Avoid calling TYPO3_SITE_URL here to get the base URL as it might be that we output an exception message with
            // invalid trusted host, which would lead to a nested exception! See: #30377
            // Instead we calculate the relative path to the document root without involving HTTP request parameters.
            '###BASEURL###' => substr(PATH_site, strlen(\TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_DOCUMENT_ROOT'))),
            '###TYPO3_mainDir###' => TYPO3_mainDir,
            '###TYPO3_copyright_year###' => TYPO3_copyright_year
        );
        return $defaultMarkers;
    }

    public function getHtmlTemplate() {
        if (!$this->htmlTemplate) {
            throw new \RuntimeException('No HTML template file has been defined, yet', 1314390127);
        }
        return $this->htmlTemplate;
    }

    public function setHtmlTemplate($htmlTemplate) {
        $this->htmlTemplate = PATH_site . $htmlTemplate;
        if (!file_exists($this->htmlTemplate)) {
            throw new \RuntimeException('Template file "' . $this->htmlTemplate . '" not found', 1312830504);
        }
    }

    public function render() {
        $markers = array_merge($this->getDefaultMarkers(), $this->markers);
        $content = \TYPO3\CMS\Core\Utility\GeneralUtility::getUrl($this->htmlTemplate);
        $content = \TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($content, $markers, '', FALSE, TRUE);
        return $content;
    }

    public function output() {
        $content = $this->render();
        echo $content;
    }

}