API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
Notification.php
186 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | /** |
| 12 | * Describes a UI notification. |
| 13 | * |
| 14 | * UI notifications are messages displayed to the user near the top of the screen. |
| 15 | * Notifications consist of a message, a context (the message type), a priority |
| 16 | * and a display type. |
| 17 | * |
| 18 | * **The context** affects the way the message looks, but not how it is displayed. |
| 19 | * |
| 20 | * **The display type** determines how the message is displayed. |
| 21 | * |
| 22 | * **The priority** determines where it is shown in the list of all displayed notifications. |
| 23 | * |
| 24 | * ### Examples |
| 25 | * |
| 26 | * **Display an error message** |
| 27 | * |
| 28 | * $notification = new Notification('My Error Message'); |
| 29 | * $notification->context = Notification::CONTEXT_ERROR; |
| 30 | * Notification\Manager::notify('myUniqueNotificationId', $notification); |
| 31 | * |
| 32 | * **Display a temporary success message** |
| 33 | * |
| 34 | * $notification = new Notification('Success'); |
| 35 | * $notification->context = Notification::CONTEXT_SUCCESS; |
| 36 | * $notification->type = Notification::TYPE_TOAST; |
| 37 | * Notification\Manager::notify('myUniqueNotificationId', $notification); |
| 38 | * |
| 39 | * **Display a message near the top of the screen** |
| 40 | * |
| 41 | * $notification = new Notification('Urgent: Your password has expired!'); |
| 42 | * $notification->context = Notification::CONTEXT_INFO; |
| 43 | * $notification->type = Notification::TYPE_PERSISTENT; |
| 44 | * $notification->priority = Notification::PRIORITY_MAX; |
| 45 | * |
| 46 | * @api |
| 47 | */ |
| 48 | class Notification |
| 49 | { |
| 50 | public const CONTEXT_SUCCESS = 'success'; |
| 51 | public const CONTEXT_ERROR = 'error'; |
| 52 | public const CONTEXT_INFO = 'info'; |
| 53 | public const CONTEXT_WARNING = 'warning'; |
| 54 | /** |
| 55 | * Lowest priority value. |
| 56 | */ |
| 57 | public const PRIORITY_MIN = 1; |
| 58 | /** |
| 59 | * Lower priority value. |
| 60 | */ |
| 61 | public const PRIORITY_LOW = 25; |
| 62 | /** |
| 63 | * Higher priority value. |
| 64 | */ |
| 65 | public const PRIORITY_HIGH = 50; |
| 66 | /** |
| 67 | * Highest priority value. |
| 68 | */ |
| 69 | public const PRIORITY_MAX = 100; |
| 70 | /** |
| 71 | * If this flag is applied, no close icon will be displayed. _Note: persistent notifications always have a close |
| 72 | * icon._ |
| 73 | * |
| 74 | * See {@link $flags}. |
| 75 | */ |
| 76 | public const FLAG_NO_CLEAR = 1; |
| 77 | /** |
| 78 | * If this flag is applied, a close icon will be displayed. |
| 79 | * |
| 80 | * See {@link $flags}. |
| 81 | */ |
| 82 | public const FLAG_CLEAR = 0; |
| 83 | /** |
| 84 | * Notifications of this type will be displayed for a few seconds and then faded out. |
| 85 | */ |
| 86 | public const TYPE_TOAST = 'toast'; |
| 87 | /** |
| 88 | * Notifications of this type will be displayed until the new user explicitly closes the notification. |
| 89 | * The notifications will display even if the user reloads the page. |
| 90 | */ |
| 91 | public const TYPE_PERSISTENT = 'persistent'; |
| 92 | /** |
| 93 | * Notifications of this type will be displayed only once. They will disappear after a page reload or |
| 94 | * change. |
| 95 | */ |
| 96 | public const TYPE_TRANSIENT = 'transient'; |
| 97 | /** |
| 98 | * The notification title. The title is optional and is displayed directly before the message content. |
| 99 | * |
| 100 | * @var string |
| 101 | */ |
| 102 | public $title; |
| 103 | /** |
| 104 | * The notification message. Must be set. |
| 105 | * |
| 106 | * @var string |
| 107 | */ |
| 108 | public $message; |
| 109 | /** |
| 110 | * Contains extra display options. |
| 111 | * |
| 112 | * Usage: `$notification->flags = Notification::FLAG_BAR | Notification::FLAG_FOO`. |
| 113 | * |
| 114 | * @var int |
| 115 | */ |
| 116 | public $flags = self::FLAG_NO_CLEAR; |
| 117 | /** |
| 118 | * The notification's display type. See `TYPE_*` constants in {@link Notification}. |
| 119 | * |
| 120 | * @var string |
| 121 | */ |
| 122 | public $type = self::TYPE_TRANSIENT; |
| 123 | /** |
| 124 | * The notification's context (message type). See `CONTEXT_*` constants in {@link Notification}. |
| 125 | * |
| 126 | * A notification's context determines how it will be styled. |
| 127 | * |
| 128 | * @var string |
| 129 | */ |
| 130 | public $context = self::CONTEXT_INFO; |
| 131 | /** |
| 132 | * The notification's priority. The higher the priority, the higher the order. See `PRIORITY_*` |
| 133 | * constants in {@link Notification} to see possible priority values. |
| 134 | * |
| 135 | * @var ?int |
| 136 | */ |
| 137 | public $priority; |
| 138 | /** |
| 139 | * If true, the message will not be escaped before being outputted as HTML. If you set this to |
| 140 | * `true`, make sure you escape text yourself in order to avoid XSS vulnerabilities. |
| 141 | * |
| 142 | * @var bool |
| 143 | */ |
| 144 | public $raw = \false; |
| 145 | /** |
| 146 | * @param string $message The notification message. |
| 147 | * @throws \Exception If the message is empty. |
| 148 | */ |
| 149 | public function __construct($message) |
| 150 | { |
| 151 | if (empty($message)) { |
| 152 | throw new \Exception('No notification message given'); |
| 153 | } |
| 154 | $this->message = $message; |
| 155 | } |
| 156 | /** |
| 157 | * Returns `1` if the notification will be displayed without a close button, `0` if otherwise. |
| 158 | * |
| 159 | * @return int `1` or `0`. |
| 160 | */ |
| 161 | public function hasNoClear() |
| 162 | { |
| 163 | if ($this->flags & self::FLAG_NO_CLEAR) { |
| 164 | return 1; |
| 165 | } |
| 166 | return 0; |
| 167 | } |
| 168 | /** |
| 169 | * Returns the notification's priority. If no priority has been set, a priority will be set based |
| 170 | * on the notification's context. |
| 171 | * |
| 172 | * @return int |
| 173 | */ |
| 174 | public function getPriority() |
| 175 | { |
| 176 | if (!isset($this->priority)) { |
| 177 | $typeToPriority = array(static::CONTEXT_ERROR => static::PRIORITY_MAX, static::CONTEXT_WARNING => static::PRIORITY_HIGH, static::CONTEXT_SUCCESS => static::PRIORITY_MIN, static::CONTEXT_INFO => static::PRIORITY_LOW); |
| 178 | if (array_key_exists($this->context, $typeToPriority)) { |
| 179 | return $typeToPriority[$this->context]; |
| 180 | } |
| 181 | return static::PRIORITY_LOW; |
| 182 | } |
| 183 | return $this->priority; |
| 184 | } |
| 185 | } |
| 186 |