AbstractMessage.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Messaging;
 
use ‪TYPO3\CMS\Core\Utility\MathUtility;
 
abstract class ‪AbstractMessage implements \JsonSerializable
{
    const ‪NOTICE = -2;
    const ‪INFO = -1;
    const ‪OK = 0;
    const ‪WARNING = 1;
    const ‪ERROR = 2;
 
    protected ‪$title = '';
 
    protected ‪$message = '';
 
    protected ‪$severity = ‪self::OK;
 
    public function ‪getTitle(): string
    {
        return ‪$this->title;
    }
 
    public function ‪setTitle(string ‪$title)
    {
        $this->title = ‪$title;
    }
 
    public function ‪getMessage(): string
    {
        return ‪$this->message;
    }
 
    public function ‪setMessage(string ‪$message)
    {
        $this->message = ‪$message;
    }
 
    public function ‪getSeverity(): int
    {
        return ‪$this->severity;
    }
 
    public function ‪setSeverity(int ‪$severity = self::OK)
    {
        $this->severity = ‪MathUtility::forceIntegerInRange(‪$severity, self::NOTICE, self::ERROR, self::OK);
    }
 
    public function ‪__toString()
    {
        $severities = [
            self::NOTICE => 'NOTICE',
            self::INFO => 'INFO',
            self::OK => 'OK',
            self::WARNING => 'WARNING',
            self::ERROR => 'ERROR'
        ];
        ‪$title = '';
        if ($this->title !== '') {
            ‪$title = ' - ' . ‪$this->title;
        }
        return $severities[‪$this->severity] . ‪$title . ': ' . ‪$this->message;
    }
 
    public function ‪jsonSerialize(): array
    {
        return [
            'severity' => $this->‪getSeverity(),
            'title' => $this->‪getTitle(),
            'message' => $this->‪getMessage(),
        ];
    }
}