‪TYPO3CMS  ‪main
AbstractMessage.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
5 /*
6  * This file is part of the TYPO3 CMS project.
7  *
8  * It is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License, either version 2
10  * of the License, or any later version.
11  *
12  * For the full copyright and license information, please read the
13  * LICENSE.txt file that was distributed with this source code.
14  *
15  * The TYPO3 project - inspiring people to share!
16  */
17 
19 
21 
25 abstract class ‪AbstractMessage implements \JsonSerializable
26 {
27  protected string ‪$title = '';
28  protected string ‪$message = '';
29  protected ‪ContextualFeedbackSeverity ‪$severity = ContextualFeedbackSeverity::OK;
30 
31  public function ‪getTitle(): string
32  {
33  return ‪$this->title;
34  }
35 
36  public function ‪setTitle(string ‪$title): void
37  {
38  $this->title = ‪$title;
39  }
40 
41  public function ‪getMessage(): string
42  {
43  return ‪$this->message;
44  }
45 
46  public function ‪setMessage(string ‪$message): void
47  {
48  $this->message = ‪$message;
49  }
50 
55  {
56  return ‪$this->severity;
57  }
58 
64  public function ‪setSeverity(‪ContextualFeedbackSeverity ‪$severity = ContextualFeedbackSeverity::OK): void
65  {
66  $this->severity = ‪$severity;
67  }
68 
75  public function ‪__toString()
76  {
77  ‪$title = '';
78  if ($this->title !== '') {
79  ‪$title = ' - ' . ‪$this->title;
80  }
81  return $this->severity->name . ‪$title . ': ' . ‪$this->message;
82  }
83 
87  public function ‪jsonSerialize(): array
88  {
89  return [
90  'severity' => $this->‪getSeverity()->value,
91  'title' => $this->‪getTitle(),
92  'message' => $this->‪getMessage(),
93  ];
94  }
95 }
‪TYPO3\CMS\Core\Messaging\AbstractMessage
Definition: AbstractMessage.php:26
‪TYPO3\CMS\Core\Messaging\AbstractMessage\getMessage
‪getMessage()
Definition: AbstractMessage.php:41
‪TYPO3\CMS\Core\Messaging\AbstractMessage\getTitle
‪getTitle()
Definition: AbstractMessage.php:31
‪TYPO3\CMS\Core\Messaging\AbstractMessage\$message
‪string $message
Definition: AbstractMessage.php:28
‪TYPO3\CMS\Core\Messaging\AbstractMessage\setTitle
‪setTitle(string $title)
Definition: AbstractMessage.php:36
‪TYPO3\CMS\Core\Messaging\AbstractMessage\jsonSerialize
‪array jsonSerialize()
Definition: AbstractMessage.php:87
‪TYPO3\CMS\Core\Messaging\AbstractMessage\$title
‪string $title
Definition: AbstractMessage.php:27
‪TYPO3\CMS\Core\Messaging\AbstractMessage\$severity
‪ContextualFeedbackSeverity $severity
Definition: AbstractMessage.php:29
‪TYPO3\CMS\Core\Messaging\AbstractMessage\getSeverity
‪getSeverity()
Definition: AbstractMessage.php:54
‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity
‪ContextualFeedbackSeverity
Definition: ContextualFeedbackSeverity.php:25
‪TYPO3\CMS\Core\Messaging\AbstractMessage\setMessage
‪setMessage(string $message)
Definition: AbstractMessage.php:46
‪TYPO3\CMS\Core\Messaging\AbstractMessage\setSeverity
‪setSeverity(ContextualFeedbackSeverity $severity=ContextualFeedbackSeverity::OK)
Definition: AbstractMessage.php:64
‪TYPO3\CMS\Core\Messaging
Definition: AbstractMessage.php:18
‪TYPO3\CMS\Core\Messaging\AbstractMessage\__toString
‪string __toString()
Definition: AbstractMessage.php:75