projects / GitHub / WoltLab / woltlab.github.io.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Deployed 2f7be76 to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / php / api / user_notifications / index.html
CommitLineData
45ca63d0
TD		 1
2<!doctype html>
3<html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
fb962f09
WG		 12 <link rel="icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
45ca63d0
TD		 14
15
16
17 <title>User Notifications - WoltLab Suite Documentation</title>
18
19
20
fb962f09 21 <link rel="stylesheet" href="../../../assets/stylesheets/main.33e2939f.min.css">
45ca63d0
TD		 22
23
fb962f09 24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css">
45ca63d0
TD		 25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
fd8430cb
WG		 34
35
45ca63d0
TD		 36
37
38 <link rel="stylesheet" href="../../../stylesheets/extra.css">
39
40
41
42
43
44 </head>
45
46
47
48
49
50
51
52 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
45ca63d0
TD		 53
54
fb962f09
WG		 55 <script>function __prefix(e){return new URL("../../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
45ca63d0
TD		 57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
59 <label class="md-overlay" for="__drawer"></label>
60 <div data-md-component="skip">
61
62
63 <a href="#user-notifications" class="md-skip">
64 Skip to content
65 </a>
66
67 </div>
68 <div data-md-component="announce">
69
70 <aside class="md-announce">
71 <div class="md-announce__inner md-grid md-typeset">
72
73 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
74
75 </div>
76 </aside>
77
78 </div>
79
fb962f09 80 <header class="md-header" data-md-component="header">
45ca63d0 81 <nav class="md-header__inner md-grid" aria-label="Header">
fb962f09 82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD		 83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 User Notifications
101
102 </span>
103 </div>
104 </div>
45ca63d0
TD		 105 </div>
106
fb962f09
WG		 107
108
a3639e76
WG		 109 <label class="md-header__button md-icon" for="__search">
110 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
111 </label>
112
113<div class="md-search" data-md-component="search" role="dialog">
114 <label class="md-search__overlay" for="__search"></label>
115 <div class="md-search__inner" role="search">
116 <form class="md-search__form" name="search">
117 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
118 <label class="md-search__icon md-icon" for="__search">
119 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
120 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
121 </label>
122 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
fb962f09 123 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
a3639e76
WG		 124 </button>
125 </form>
126 <div class="md-search__output">
127 <div class="md-search__scrollwrap" data-md-scrollfix>
128 <div class="md-search-result" data-md-component="search-result">
129 <div class="md-search-result__meta">
130 Initializing search
131 </div>
132 <ol class="md-search-result__list"></ol>
133 </div>
134 </div>
135 </div>
136 </div>
137</div>
138
45ca63d0 139
7124f4cb
WG		 140 <div class="md-header__source">
141
142<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
143 <div class="md-source__icon md-icon">
144
fb962f09 145 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
7124f4cb
WG		 146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150</a>
151 </div>
152
45ca63d0
TD		 153 </nav>
154</header>
155
156 <div class="md-container" data-md-component="container">
157
158
159
160
161 <main class="md-main" data-md-component="main">
162 <div class="md-main__inner md-grid">
163
164
165
166 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
167 <div class="md-sidebar__scrollwrap">
168 <div class="md-sidebar__inner">
169
170
171
45ca63d0
TD		 172<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
173 <label class="md-nav__title" for="__drawer">
fb962f09 174 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD		 175
176 <img src="../../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
7124f4cb
WG		 182 <div class="md-nav__source">
183
184<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
185 <div class="md-source__icon md-icon">
186
fb962f09 187 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
7124f4cb
WG		 188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192</a>
193 </div>
194
45ca63d0
TD		 195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203
204 <li class="md-nav__item">
205 <a href="../../../getting-started/" class="md-nav__link">
206 Getting Started
207 </a>
208 </li>
209
210
211
212
213
214
215
216
217
218
219
220
221
222 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
223
224
225 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
226
227 <label class="md-nav__link" for="__nav_2">
228 PHP API
229 <span class="md-nav__icon md-icon"></span>
230 </label>
231 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
232 <label class="md-nav__title" for="__nav_2">
233 <span class="md-nav__icon md-icon"></span>
234 PHP API
235 </label>
236 <ul class="md-nav__list" data-md-scrollfix>
237
238
239
240
241
242 <li class="md-nav__item">
243 <a href="../../pages/" class="md-nav__link">
244 Pages
245 </a>
246 </li>
247
248
249
250
251
252
253
254 <li class="md-nav__item">
255 <a href="../../database-objects/" class="md-nav__link">
256 Database Objects
257 </a>
258 </li>
259
260
261
262
263
264
265
266 <li class="md-nav__item">
267 <a href="../../database-access/" class="md-nav__link">
268 Database Access
269 </a>
270 </li>
271
272
273
274
275
276
277
278 <li class="md-nav__item">
279 <a href="../../exceptions/" class="md-nav__link">
280 Exceptions
281 </a>
282 </li>
283
284
285
286
287
288
289
290
291
292
293 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
294
295
296 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked>
297
298 <label class="md-nav__link" for="__nav_2_5">
299 API
300 <span class="md-nav__icon md-icon"></span>
301 </label>
302 <nav class="md-nav" aria-label="API" data-md-level="2">
303 <label class="md-nav__title" for="__nav_2_5">
304 <span class="md-nav__icon md-icon"></span>
305 API
306 </label>
307 <ul class="md-nav__list" data-md-scrollfix>
308
309
310
311
312
6923e968
WG		 313
314 <li class="md-nav__item md-nav__item--nested">
315
316
317 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
318
319 <label class="md-nav__link" for="__nav_2_5_1">
320 Caches
321 <span class="md-nav__icon md-icon"></span>
322 </label>
323 <nav class="md-nav" aria-label="Caches" data-md-level="3">
324 <label class="md-nav__title" for="__nav_2_5_1">
325 <span class="md-nav__icon md-icon"></span>
326 Caches
327 </label>
328 <ul class="md-nav__list" data-md-scrollfix>
329
330
331
332
333
45ca63d0
TD		 334 <li class="md-nav__item">
335 <a href="../caches/" class="md-nav__link">
6923e968
WG		 336 Overview
337 </a>
338 </li>
339
340
341
342
343
344
345
346 <li class="md-nav__item">
347 <a href="../caches_persistent-caches/" class="md-nav__link">
348 Persistent Caches
349 </a>
350 </li>
351
352
353
354
355
356
357
358 <li class="md-nav__item">
359 <a href="../caches_runtime-caches/" class="md-nav__link">
360 Runtime Caches
45ca63d0
TD		 361 </a>
362 </li>
363
364
365
6923e968
WG		 366 </ul>
367 </nav>
368 </li>
369
370
371
45ca63d0
TD		 372
373
374
375
376 <li class="md-nav__item">
377 <a href="../comments/" class="md-nav__link">
378 Comments
379 </a>
380 </li>
381
382
383
384
385
386
387
388 <li class="md-nav__item">
389 <a href="../cronjobs/" class="md-nav__link">
390 Cronjobs
391 </a>
392 </li>
393
394
395
396
397
398
399
400 <li class="md-nav__item">
401 <a href="../events/" class="md-nav__link">
402 Events
403 </a>
404 </li>
405
406
407
408
409
410
411
412
413 <li class="md-nav__item md-nav__item--nested">
414
415
416 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
417
418 <label class="md-nav__link" for="__nav_2_5_5">
419 Form Builder
420 <span class="md-nav__icon md-icon"></span>
421 </label>
422 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
423 <label class="md-nav__title" for="__nav_2_5_5">
424 <span class="md-nav__icon md-icon"></span>
425 Form Builder
426 </label>
427 <ul class="md-nav__list" data-md-scrollfix>
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../form_builder/overview/" class="md-nav__link">
435 Overview
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../form_builder/structure/" class="md-nav__link">
447 Structure
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../form_builder/form_fields/" class="md-nav__link">
459 Fields
460 </a>
461 </li>
462
463
464
465
466
467
468
469 <li class="md-nav__item">
470 <a href="../form_builder/validation_data/" class="md-nav__link">
471 Validation and Data
472 </a>
473 </li>
474
475
476
477
478
479
480
481 <li class="md-nav__item">
482 <a href="../form_builder/dependencies/" class="md-nav__link">
483 Dependencies
484 </a>
485 </li>
486
487
488
489 </ul>
490 </nav>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../package_installation_plugins/" class="md-nav__link">
501 Package Installation Plugins
502 </a>
503 </li>
504
505
506
507
508
509
510
511 <li class="md-nav__item">
512 <a href="../user_activity_points/" class="md-nav__link">
513 User Activity Points
514 </a>
515 </li>
516
517
518
519
520
521
522
523
524
525 <li class="md-nav__item md-nav__item--active">
526
527 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
528
529
530
531
532 <label class="md-nav__link md-nav__link--active" for="__toc">
533 User Notifications
534 <span class="md-nav__icon md-icon"></span>
535 </label>
536
537 <a href="./" class="md-nav__link md-nav__link--active">
538 User Notifications
539 </a>
540
541
542<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
543
544
545
546
547
548 <label class="md-nav__title" for="__toc">
549 <span class="md-nav__icon md-icon"></span>
550 Table of contents
551 </label>
552 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
553
554 <li class="md-nav__item">
555 <a href="#objecttypexml" class="md-nav__link">
556 objectType.xml
557 </a>
558
559</li>
560
561 <li class="md-nav__item">
562 <a href="#usernotificationeventxml" class="md-nav__link">
563 userNotificationEvent.xml
564 </a>
565
566</li>
567
568 <li class="md-nav__item">
569 <a href="#firing-events" class="md-nav__link">
570 Firing Events
571 </a>
572
573</li>
574
575 <li class="md-nav__item">
576 <a href="#marking-notifications-as-confirmed" class="md-nav__link">
577 Marking Notifications as Confirmed
578 </a>
579
580</li>
581
582 </ul>
583
584</nav>
585
586 </li>
587
588
589
590
591
592
593
594 <li class="md-nav__item">
595 <a href="../sitemaps/" class="md-nav__link">
596 Sitemaps
597 </a>
598 </li>
599
600
601
602 </ul>
603 </nav>
604 </li>
605
606
607
608
609
610
611
612 <li class="md-nav__item">
613 <a href="../../code-style/" class="md-nav__link">
614 Code Style
615 </a>
616 </li>
617
618
619
620
621
622
623
624 <li class="md-nav__item">
625 <a href="../../apps/" class="md-nav__link">
626 Apps
627 </a>
628 </li>
629
630
631
632
633
634
635
636 <li class="md-nav__item">
637 <a href="../../gdpr/" class="md-nav__link">
638 GDPR
639 </a>
640 </li>
641
642
643
644 </ul>
645 </nav>
646 </li>
647
648
649
650
651
652
653
654
655
656
657
658 <li class="md-nav__item md-nav__item--nested">
659
660
661 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
662
663 <label class="md-nav__link" for="__nav_3">
664 Languages, Templates & CSS
665 <span class="md-nav__icon md-icon"></span>
666 </label>
667 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
668 <label class="md-nav__title" for="__nav_3">
669 <span class="md-nav__icon md-icon"></span>
670 Languages, Templates & CSS
671 </label>
672 <ul class="md-nav__list" data-md-scrollfix>
673
674
675
676
677
678 <li class="md-nav__item">
679 <a href="../../../view/languages/" class="md-nav__link">
680 Languages
681 </a>
682 </li>
683
684
685
686
687
688
689
690 <li class="md-nav__item">
691 <a href="../../../view/templates/" class="md-nav__link">
692 Templates
693 </a>
694 </li>
695
696
697
698
699
700
701
6923e968
WG		 702 <li class="md-nav__item">
703 <a href="../../../view/template-plugins/" class="md-nav__link">
704 Template Plugins
705 </a>
706 </li>
707
708
709
710
711
712
713
45ca63d0
TD		 714 <li class="md-nav__item">
715 <a href="../../../view/css/" class="md-nav__link">
716 CSS
717 </a>
718 </li>
719
720
721
722 </ul>
723 </nav>
724 </li>
725
726
727
728
729
730
731
732
733
734
735
736 <li class="md-nav__item md-nav__item--nested">
737
738
739 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
740
741 <label class="md-nav__link" for="__nav_4">
77efcd46 742 TypeScript and JavaScript API
45ca63d0
TD		 743 <span class="md-nav__icon md-icon"></span>
744 </label>
77efcd46 745 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
45ca63d0
TD		 746 <label class="md-nav__title" for="__nav_4">
747 <span class="md-nav__icon md-icon"></span>
77efcd46 748 TypeScript and JavaScript API
45ca63d0
TD		 749 </label>
750 <ul class="md-nav__list" data-md-scrollfix>
751
752
753
754
755
756 <li class="md-nav__item">
757 <a href="../../../javascript/general-usage/" class="md-nav__link">
758 General Usage
759 </a>
760 </li>
761
762
763
764
765
766
767
77efcd46
WG		 768 <li class="md-nav__item">
769 <a href="../../../javascript/typescript/" class="md-nav__link">
770 TypeScript
771 </a>
772 </li>
773
774
775
776
777
778
779
45ca63d0
TD		 780
781 <li class="md-nav__item md-nav__item--nested">
782
783
77efcd46 784 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
45ca63d0 785
77efcd46 786 <label class="md-nav__link" for="__nav_4_3">
45ca63d0
TD		 787 New API
788 <span class="md-nav__icon md-icon"></span>
789 </label>
790 <nav class="md-nav" aria-label="New API" data-md-level="2">
77efcd46 791 <label class="md-nav__title" for="__nav_4_3">
45ca63d0
TD		 792 <span class="md-nav__icon md-icon"></span>
793 New API
794 </label>
795 <ul class="md-nav__list" data-md-scrollfix>
796
797
798
799
800
801 <li class="md-nav__item">
802 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
803 Writing a module
804 </a>
805 </li>
806
807
808
809
810
811
812
813 <li class="md-nav__item">
814 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
815 Data Structures
816 </a>
817 </li>
818
819
820
821
822
823
824
825 <li class="md-nav__item">
826 <a href="../../../javascript/new-api_core/" class="md-nav__link">
827 Core Functions
828 </a>
829 </li>
830
831
832
833
834
835
836
837 <li class="md-nav__item">
838 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
839 DOM
840 </a>
841 </li>
842
843
844
845
846
847
848
849 <li class="md-nav__item">
850 <a href="../../../javascript/new-api_events/" class="md-nav__link">
851 Event Handling
852 </a>
853 </li>
854
855
856
857
858
859
860
861 <li class="md-nav__item">
862 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
863 Ajax
864 </a>
865 </li>
866
867
868
869
870
871
872
873 <li class="md-nav__item">
874 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
875 Dialogs
876 </a>
877 </li>
878
879
880
881
882
883
884
885 <li class="md-nav__item">
886 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
887 Browser and Screen Sizes
888 </a>
889 </li>
890
891
892
893
894
895
896
897 <li class="md-nav__item">
898 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
899 User Interface
900 </a>
901 </li>
902
903
904
905 </ul>
906 </nav>
907 </li>
908
909
910
911
912
913
914
915 <li class="md-nav__item">
916 <a href="../../../javascript/legacy-api/" class="md-nav__link">
917 Legacy API
918 </a>
919 </li>
920
921
922
923
924
925
926
927 <li class="md-nav__item">
928 <a href="../../../javascript/helper-functions/" class="md-nav__link">
929 Helper Functions
930 </a>
931 </li>
932
933
934
935
936
937
938
939 <li class="md-nav__item">
940 <a href="../../../javascript/code-snippets/" class="md-nav__link">
941 Code Snippets
942 </a>
943 </li>
944
945
946
947 </ul>
948 </nav>
949 </li>
950
951
952
953
954
955
956
957
958
959
960
961 <li class="md-nav__item md-nav__item--nested">
962
963
964 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
965
966 <label class="md-nav__link" for="__nav_5">
967 Package Components
968 <span class="md-nav__icon md-icon"></span>
969 </label>
970 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
971 <label class="md-nav__title" for="__nav_5">
972 <span class="md-nav__icon md-icon"></span>
973 Package Components
974 </label>
975 <ul class="md-nav__list" data-md-scrollfix>
976
977
978
979
980
981 <li class="md-nav__item">
982 <a href="../../../package/package-xml/" class="md-nav__link">
983 package.xml
984 </a>
985 </li>
986
987
988
989
990
991
992
993
994 <li class="md-nav__item md-nav__item--nested">
995
996
997 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
998
999 <label class="md-nav__link" for="__nav_5_2">
1000 PIPs
1001 <span class="md-nav__icon md-icon"></span>
1002 </label>
1003 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1004 <label class="md-nav__title" for="__nav_5_2">
1005 <span class="md-nav__icon md-icon"></span>
1006 PIPs
1007 </label>
1008 <ul class="md-nav__list" data-md-scrollfix>
1009
1010
1011
1012
1013
1014 <li class="md-nav__item">
1015 <a href="../../../package/pip/" class="md-nav__link">
1016 Overview
1017 </a>
1018 </li>
1019
1020
1021
1022
1023
1024
1025
1026 <li class="md-nav__item">
1027 <a href="../../../package/pip/acl-option/" class="md-nav__link">
1028 aclOption
1029 </a>
1030 </li>
1031
1032
1033
1034
1035
1036
1037
1038 <li class="md-nav__item">
1039 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1040 acpMenu
1041 </a>
1042 </li>
1043
1044
1045
1046
1047
1048
1049
1050 <li class="md-nav__item">
1051 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1052 acpSearchProvider
1053 </a>
1054 </li>
1055
1056
1057
1058
1059
1060
1061
1062 <li class="md-nav__item">
1063 <a href="../../../package/pip/acp-template/" class="md-nav__link">
1064 acpTemplate
1065 </a>
1066 </li>
1067
1068
1069
1070
1071
1072
1073
1074 <li class="md-nav__item">
1075 <a href="../../../package/pip/bbcode/" class="md-nav__link">
1076 bbcode
1077 </a>
1078 </li>
1079
1080
1081
1082
1083
1084
1085
1086 <li class="md-nav__item">
1087 <a href="../../../package/pip/box/" class="md-nav__link">
1088 box
1089 </a>
1090 </li>
1091
1092
1093
1094
1095
1096
1097
1098 <li class="md-nav__item">
1099 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1100 clipboardAction
1101 </a>
1102 </li>
1103
1104
1105
1106
1107
1108
1109
1110 <li class="md-nav__item">
1111 <a href="../../../package/pip/core-object/" class="md-nav__link">
1112 coreObject
1113 </a>
1114 </li>
1115
1116
1117
1118
1119
1120
1121
1122 <li class="md-nav__item">
1123 <a href="../../../package/pip/cronjob/" class="md-nav__link">
1124 cronjob
1125 </a>
1126 </li>
1127
1128
1129
1130
1131
1132
1133
6923e968
WG		 1134 <li class="md-nav__item">
1135 <a href="../../../package/pip/database/" class="md-nav__link">
1136 database
1137 </a>
1138 </li>
1139
1140
1141
1142
1143
1144
1145
45ca63d0
TD		 1146 <li class="md-nav__item">
1147 <a href="../../../package/pip/event-listener/" class="md-nav__link">
1148 eventListener
1149 </a>
1150 </li>
1151
1152
1153
1154
1155
1156
1157
1158 <li class="md-nav__item">
1159 <a href="../../../package/pip/file/" class="md-nav__link">
1160 file
1161 </a>
1162 </li>
1163
1164
1165
1166
1167
1168
1169
1170 <li class="md-nav__item">
1171 <a href="../../../package/pip/language/" class="md-nav__link">
1172 language
1173 </a>
1174 </li>
1175
1176
1177
1178
1179
1180
1181
1182 <li class="md-nav__item">
1183 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1184 mediaProvider
1185 </a>
1186 </li>
1187
1188
1189
1190
1191
1192
1193
1194 <li class="md-nav__item">
1195 <a href="../../../package/pip/menu/" class="md-nav__link">
1196 menu
1197 </a>
1198 </li>
1199
1200
1201
1202
1203
1204
1205
1206 <li class="md-nav__item">
1207 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1208 menuItem
1209 </a>
1210 </li>
1211
1212
1213
1214
1215
1216
1217
1218 <li class="md-nav__item">
1219 <a href="../../../package/pip/object-type/" class="md-nav__link">
1220 objectType
1221 </a>
1222 </li>
1223
1224
1225
1226
1227
1228
1229
1230 <li class="md-nav__item">
1231 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1232 objectTypeDefinition
1233 </a>
1234 </li>
1235
1236
1237
1238
1239
1240
1241
1242 <li class="md-nav__item">
1243 <a href="../../../package/pip/option/" class="md-nav__link">
1244 option
1245 </a>
1246 </li>
1247
1248
1249
1250
1251
1252
1253
1254 <li class="md-nav__item">
1255 <a href="../../../package/pip/page/" class="md-nav__link">
1256 page
1257 </a>
1258 </li>
1259
1260
1261
1262
1263
1264
1265
1266 <li class="md-nav__item">
1267 <a href="../../../package/pip/pip/" class="md-nav__link">
1268 pip
1269 </a>
1270 </li>
1271
1272
1273
1274
1275
1276
1277
1278 <li class="md-nav__item">
1279 <a href="../../../package/pip/script/" class="md-nav__link">
1280 script
1281 </a>
1282 </li>
1283
1284
1285
1286
1287
1288
1289
1290 <li class="md-nav__item">
1291 <a href="../../../package/pip/smiley/" class="md-nav__link">
1292 smiley
1293 </a>
1294 </li>
1295
1296
1297
1298
1299
1300
1301
1302 <li class="md-nav__item">
1303 <a href="../../../package/pip/sql/" class="md-nav__link">
1304 sql
1305 </a>
1306 </li>
1307
1308
1309
1310
1311
1312
1313
1314 <li class="md-nav__item">
1315 <a href="../../../package/pip/style/" class="md-nav__link">
1316 style
1317 </a>
1318 </li>
1319
1320
1321
1322
1323
1324
1325
1326 <li class="md-nav__item">
1327 <a href="../../../package/pip/template/" class="md-nav__link">
1328 template
1329 </a>
1330 </li>
1331
1332
1333
1334
1335
1336
1337
1338 <li class="md-nav__item">
1339 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1340 templateListener
1341 </a>
1342 </li>
1343
1344
1345
1346
1347
1348
1349
1350 <li class="md-nav__item">
1351 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1352 userGroupOption
1353 </a>
1354 </li>
1355
1356
1357
1358
1359
1360
1361
1362 <li class="md-nav__item">
1363 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1364 userMenu
1365 </a>
1366 </li>
1367
1368
1369
1370
1371
1372
1373
1374 <li class="md-nav__item">
1375 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1376 userNotificationEvent
1377 </a>
1378 </li>
1379
1380
1381
1382
1383
1384
1385
1386 <li class="md-nav__item">
1387 <a href="../../../package/pip/user-option/" class="md-nav__link">
1388 userOption
1389 </a>
1390 </li>
1391
1392
1393
1394
1395
1396
1397
1398 <li class="md-nav__item">
1399 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1400 userProfileMenu
1401 </a>
1402 </li>
1403
1404
1405
1406 </ul>
1407 </nav>
1408 </li>
1409
1410
1411
1412
1413
1414
1415
1416 <li class="md-nav__item">
1417 <a href="../../../package/database-php-api/" class="md-nav__link">
1418 Database PHP API
1419 </a>
1420 </li>
1421
1422
1423
1424 </ul>
1425 </nav>
1426 </li>
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438 <li class="md-nav__item md-nav__item--nested">
1439
1440
1441 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1442
1443 <label class="md-nav__link" for="__nav_6">
1444 Migration
1445 <span class="md-nav__icon md-icon"></span>
1446 </label>
1447 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1448 <label class="md-nav__title" for="__nav_6">
1449 <span class="md-nav__icon md-icon"></span>
1450 Migration
1451 </label>
1452 <ul class="md-nav__list" data-md-scrollfix>
1453
1454
1455
1456
1457
1458
1459 <li class="md-nav__item md-nav__item--nested">
1460
1461
1462 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1463
1464 <label class="md-nav__link" for="__nav_6_1">
1465 Migrating from WSC 5.3
1466 <span class="md-nav__icon md-icon"></span>
1467 </label>
1468 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1469 <label class="md-nav__title" for="__nav_6_1">
1470 <span class="md-nav__icon md-icon"></span>
1471 Migrating from WSC 5.3
1472 </label>
1473 <ul class="md-nav__list" data-md-scrollfix>
1474
1475
1476
1477
1478
1479 <li class="md-nav__item">
1480 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1481 PHP API
1482 </a>
1483 </li>
1484
1485
1486
1487
1488
1489
1490
1491 <li class="md-nav__item">
1492 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1493 Session Handling and Authentication
1494 </a>
1495 </li>
1496
1497
1498
1499
1500
1501
1502
1503 <li class="md-nav__item">
1504 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
77efcd46 1505 TypeScript and JavaScript
45ca63d0
TD		 1506 </a>
1507 </li>
1508
1509
1510
1511
1512
1513
1514
1515 <li class="md-nav__item">
1516 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1517 Templates
1518 </a>
1519 </li>
1520
1521
1522
1523
1524
1525
1526
1527 <li class="md-nav__item">
1528 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1529 Third Party Libraries
1530 </a>
1531 </li>
1532
1533
1534
1535 </ul>
1536 </nav>
1537 </li>
1538
1539
1540
1541
1542
1543
1544
1545
1546 <li class="md-nav__item md-nav__item--nested">
1547
1548
1549 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1550
1551 <label class="md-nav__link" for="__nav_6_2">
1552 Migrating from WSC 5.2
1553 <span class="md-nav__icon md-icon"></span>
1554 </label>
1555 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1556 <label class="md-nav__title" for="__nav_6_2">
1557 <span class="md-nav__icon md-icon"></span>
1558 Migrating from WSC 5.2
1559 </label>
1560 <ul class="md-nav__list" data-md-scrollfix>
1561
1562
1563
1564
1565
1566 <li class="md-nav__item">
1567 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1568 PHP API
1569 </a>
1570 </li>
1571
1572
1573
1574
1575
1576
1577
1578 <li class="md-nav__item">
1579 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1580 Templates and Languages
1581 </a>
1582 </li>
1583
1584
1585
1586
1587
1588
1589
1590 <li class="md-nav__item">
1591 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1592 Third Party Libraries
1593 </a>
1594 </li>
1595
1596
1597
1598 </ul>
1599 </nav>
1600 </li>
1601
1602
1603
1604
1605
1606
1607
1608
1609 <li class="md-nav__item md-nav__item--nested">
1610
1611
1612 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1613
1614 <label class="md-nav__link" for="__nav_6_3">
1615 Migrating from WSC 3.1
1616 <span class="md-nav__icon md-icon"></span>
1617 </label>
1618 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1619 <label class="md-nav__title" for="__nav_6_3">
1620 <span class="md-nav__icon md-icon"></span>
1621 Migrating from WSC 3.1
1622 </label>
1623 <ul class="md-nav__list" data-md-scrollfix>
1624
1625
1626
1627
1628
1629 <li class="md-nav__item">
1630 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1631 PHP API
1632 </a>
1633 </li>
1634
1635
1636
1637 </ul>
1638 </nav>
1639 </li>
1640
1641
1642
1643
1644
1645
1646
1647
1648 <li class="md-nav__item md-nav__item--nested">
1649
1650
1651 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1652
1653 <label class="md-nav__link" for="__nav_6_4">
1654 Migrating from WSC 3.0
1655 <span class="md-nav__icon md-icon"></span>
1656 </label>
1657 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1658 <label class="md-nav__title" for="__nav_6_4">
1659 <span class="md-nav__icon md-icon"></span>
1660 Migrating from WSC 3.0
1661 </label>
1662 <ul class="md-nav__list" data-md-scrollfix>
1663
1664
1665
1666
1667
1668 <li class="md-nav__item">
1669 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1670 PHP API
1671 </a>
1672 </li>
1673
1674
1675
1676
1677
1678
1679
1680 <li class="md-nav__item">
1681 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1682 JavaScript API
1683 </a>
1684 </li>
1685
1686
1687
1688
1689
1690
1691
1692 <li class="md-nav__item">
1693 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1694 Templates
1695 </a>
1696 </li>
1697
1698
1699
1700
1701
1702
1703
1704 <li class="md-nav__item">
1705 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1706 CSS
1707 </a>
1708 </li>
1709
1710
1711
1712
1713
1714
1715
1716 <li class="md-nav__item">
1717 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1718 Package Components
1719 </a>
1720 </li>
1721
1722
1723
1724 </ul>
1725 </nav>
1726 </li>
1727
1728
1729
1730
1731
1732
1733
1734
1735 <li class="md-nav__item md-nav__item--nested">
1736
1737
1738 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1739
1740 <label class="md-nav__link" for="__nav_6_5">
1741 Migrating from WCF 2.1
1742 <span class="md-nav__icon md-icon"></span>
1743 </label>
1744 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1745 <label class="md-nav__title" for="__nav_6_5">
1746 <span class="md-nav__icon md-icon"></span>
1747 Migrating from WCF 2.1
1748 </label>
1749 <ul class="md-nav__list" data-md-scrollfix>
1750
1751
1752
1753
1754
1755 <li class="md-nav__item">
1756 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1757 PHP API
1758 </a>
1759 </li>
1760
1761
1762
1763
1764
1765
1766
1767 <li class="md-nav__item">
1768 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1769 Templates
1770 </a>
1771 </li>
1772
1773
1774
1775
1776
1777
1778
1779 <li class="md-nav__item">
1780 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1781 CSS
1782 </a>
1783 </li>
1784
1785
1786
1787
1788
1789
1790
1791 <li class="md-nav__item">
1792 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1793 Package Components
1794 </a>
1795 </li>
1796
1797
1798
1799 </ul>
1800 </nav>
1801 </li>
1802
1803
1804
1805 </ul>
1806 </nav>
1807 </li>
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819 <li class="md-nav__item md-nav__item--nested">
1820
1821
1822 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1823
1824 <label class="md-nav__link" for="__nav_7">
1825 Tutorials
1826 <span class="md-nav__icon md-icon"></span>
1827 </label>
1828 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1829 <label class="md-nav__title" for="__nav_7">
1830 <span class="md-nav__icon md-icon"></span>
1831 Tutorials
1832 </label>
1833 <ul class="md-nav__list" data-md-scrollfix>
1834
1835
1836
1837
1838
1839
1840 <li class="md-nav__item md-nav__item--nested">
1841
1842
1843 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1844
1845 <label class="md-nav__link" for="__nav_7_1">
1846 Tutorial Series
1847 <span class="md-nav__icon md-icon"></span>
1848 </label>
1849 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1850 <label class="md-nav__title" for="__nav_7_1">
1851 <span class="md-nav__icon md-icon"></span>
1852 Tutorial Series
1853 </label>
1854 <ul class="md-nav__list" data-md-scrollfix>
1855
1856
1857
1858
1859
1860 <li class="md-nav__item">
1861 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1862 Overview
1863 </a>
1864 </li>
1865
1866
1867
1868
1869
1870
1871
1872 <li class="md-nav__item">
1873 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1874 Part 1
1875 </a>
1876 </li>
1877
1878
1879
1880
1881
1882
1883
1884 <li class="md-nav__item">
1885 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1886 Part 2
1887 </a>
1888 </li>
1889
1890
1891
1892
1893
1894
1895
1896 <li class="md-nav__item">
1897 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1898 Part 3
1899 </a>
41eda543
WG		 1900 </li>
1901
1902
1903
1904
1905
1906
1907
1908 <li class="md-nav__item">
1909 <a href="../../../tutorial/series/part_4/" class="md-nav__link">
1910 Part 4
1911 </a>
45ca63d0
TD		 1912 </li>
1913
1914
1915
1916 </ul>
1917 </nav>
1918 </li>
1919
1920
1921
1922 </ul>
1923 </nav>
1924 </li>
1925
1926
1927
1928 </ul>
1929</nav>
1930 </div>
1931 </div>
1932 </div>
1933
1934
1935
1936 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1937 <div class="md-sidebar__scrollwrap">
1938 <div class="md-sidebar__inner">
1939
1940<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1941
1942
1943
1944
1945
1946 <label class="md-nav__title" for="__toc">
1947 <span class="md-nav__icon md-icon"></span>
1948 Table of contents
1949 </label>
1950 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1951
1952 <li class="md-nav__item">
1953 <a href="#objecttypexml" class="md-nav__link">
1954 objectType.xml
1955 </a>
1956
1957</li>
1958
1959 <li class="md-nav__item">
1960 <a href="#usernotificationeventxml" class="md-nav__link">
1961 userNotificationEvent.xml
1962 </a>
1963
1964</li>
1965
1966 <li class="md-nav__item">
1967 <a href="#firing-events" class="md-nav__link">
1968 Firing Events
1969 </a>
1970
1971</li>
1972
1973 <li class="md-nav__item">
1974 <a href="#marking-notifications-as-confirmed" class="md-nav__link">
1975 Marking Notifications as Confirmed
1976 </a>
1977
1978</li>
1979
1980 </ul>
1981
1982</nav>
1983 </div>
1984 </div>
1985 </div>
1986
1987
1988 <div class="md-content" data-md-component="content">
1989 <article class="md-content__inner md-typeset">
1990
1991
9b8bddda 1992 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/user_notifications.md" title="Edit this page" class="md-content__button md-icon">
7124f4cb
WG		 1993 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
1994 </a>
1995
45ca63d0
TD		 1996
1997 <h1 id="user-notifications">User Notifications<a class="headerlink" href="#user-notifications" title="Permanent link">#</a></h1>
1998<p>WoltLab Suite includes a powerful user notification system that supports notifications directly shown on the website and emails sent immediately or on a daily basis.</p>
1999<h2 id="objecttypexml"><code>objectType.xml</code><a class="headerlink" href="#objecttypexml" title="Permanent link">#</a></h2>
2000<p>For any type of object related to events, you have to define an object type for the object type definition <code>com.woltlab.wcf.notification.objectType</code>:</p>
2001<div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2002<span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/objectType.xsd&quot;</span><span class="nt">&gt;</span>
2003 <span class="nt">&lt;import&gt;</span>
2004 <span class="nt">&lt;type&gt;</span>
2005 <span class="nt">&lt;name&gt;</span>com.woltlab.example.foo<span class="nt">&lt;/name&gt;</span>
2006 <span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.notification.objectType<span class="nt">&lt;/definitionname&gt;</span>
2007 <span class="nt">&lt;classname&gt;</span>example\system\user\notification\object\type\FooUserNotificationObjectType<span class="nt">&lt;/classname&gt;</span>
2008 <span class="nt">&lt;category&gt;</span>com.woltlab.example<span class="nt">&lt;/category&gt;</span>
2009 <span class="nt">&lt;/type&gt;</span>
2010 <span class="nt">&lt;/import&gt;</span>
2011<span class="nt">&lt;/data&gt;</span>
2012</code></pre></div>
45ca63d0
TD		 2013<p>The referenced class <code>FooUserNotificationObjectType</code> has to implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/object/type/IUserNotificationObjectType.class.php">IUserNotificationObjectType</a> interface, which should be done by extending <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/object/type/AbstractUserNotificationObjectType.class.php">AbstractUserNotificationObjectType</a>.</p>
2014<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2015<span class="k">namespace</span> <span class="nx">example\system\user\notification\object\type</span><span class="p">;</span>
2016<span class="k">use</span> <span class="nx">example\data\foo\Foo</span><span class="p">;</span>
2017<span class="k">use</span> <span class="nx">example\data\foo\FooList</span><span class="p">;</span>
2018<span class="k">use</span> <span class="nx">example\system\user\notification\object\FooUserNotificationObject</span><span class="p">;</span>
2019<span class="k">use</span> <span class="nx">wcf\system\user\notification\object\type\AbstractUserNotificationObjectType</span><span class="p">;</span>
2020
2021<span class="sd">/**</span>
2022<span class="sd"> * Represents a foo as a notification object type.</span>
2023<span class="sd"> * </span>
2024<span class="sd"> * @author Matthias Schmidt</span>
2025<span class="sd"> * @copyright 2001-2017 WoltLab GmbH</span>
2026<span class="sd"> * @license WoltLab License &lt;http://www.woltlab.com/license-agreement.html&gt;</span>
2027<span class="sd"> * @package WoltLabSuite\Example\System\User\Notification\Object\Type</span>
2028<span class="sd"> */</span>
2029<span class="k">class</span> <span class="nc">FooUserNotificationObjectType</span> <span class="k">extends</span> <span class="nx">AbstractUserNotificationObjectType</span> <span class="p">{</span>
2030 <span class="sd">/**</span>
2031<span class="sd"> * @inheritDoc</span>
2032<span class="sd"> */</span>
2033 <span class="k">protected</span> <span class="k">static</span> <span class="nv">$decoratorClassName</span> <span class="o">=</span> <span class="nx">FooUserNotificationObject</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2034
2035 <span class="sd">/**</span>
2036<span class="sd"> * @inheritDoc</span>
2037<span class="sd"> */</span>
2038 <span class="k">protected</span> <span class="k">static</span> <span class="nv">$objectClassName</span> <span class="o">=</span> <span class="nx">Foo</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2039
2040 <span class="sd">/**</span>
2041<span class="sd"> * @inheritDoc</span>
2042<span class="sd"> */</span>
2043 <span class="k">protected</span> <span class="k">static</span> <span class="nv">$objectListClassName</span> <span class="o">=</span> <span class="nx">FooList</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2044<span class="p">}</span>
2045</code></pre></div>
45ca63d0
TD		 2046<p>You have to set the class names of the database object (<code>$objectClassName</code>) and the related list (<code>$objectListClassName</code>).
2047Additionally, you have to create a class that implements the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/object/IUserNotificationObject.class.php">IUserNotificationObject</a> whose name you have to set as the value of the <code>$decoratorClassName</code> property. </p>
2048<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2049<span class="k">namespace</span> <span class="nx">example\system\user\notification\object</span><span class="p">;</span>
2050<span class="k">use</span> <span class="nx">example\data\foo\Foo</span><span class="p">;</span>
2051<span class="k">use</span> <span class="nx">wcf\data\DatabaseObjectDecorator</span><span class="p">;</span>
2052<span class="k">use</span> <span class="nx">wcf\system\user\notification\object\IUserNotificationObject</span><span class="p">;</span>
2053
2054<span class="sd">/**</span>
2055<span class="sd"> * Represents a foo as a notification object.</span>
2056<span class="sd"> * </span>
2057<span class="sd"> * @author Matthias Schmidt</span>
2058<span class="sd"> * @copyright 2001-2017 WoltLab GmbH</span>
2059<span class="sd"> * @license WoltLab License &lt;http://www.woltlab.com/license-agreement.html&gt;</span>
2060<span class="sd"> * @package WoltLabSuite\Example\System\User\Notification\Object</span>
2061<span class="sd"> * </span>
2062<span class="sd"> * @method Foo getDecoratedObject()</span>
2063<span class="sd"> * @mixin Foo</span>
2064<span class="sd"> */</span>
2065<span class="k">class</span> <span class="nc">FooUserNotificationObject</span> <span class="k">extends</span> <span class="nx">DatabaseObjectDecorator</span> <span class="k">implements</span> <span class="nx">IUserNotificationObject</span> <span class="p">{</span>
2066 <span class="sd">/**</span>
2067<span class="sd"> * @inheritDoc</span>
2068<span class="sd"> */</span>
2069 <span class="k">protected</span> <span class="k">static</span> <span class="nv">$baseClass</span> <span class="o">=</span> <span class="nx">Foo</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2070
2071 <span class="sd">/**</span>
2072<span class="sd"> * @inheritDoc</span>
2073<span class="sd"> */</span>
2074 <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">()</span> <span class="p">{</span>
2075 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getDecoratedObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="p">();</span>
2076 <span class="p">}</span>
2077
2078 <span class="sd">/**</span>
2079<span class="sd"> * @inheritDoc</span>
2080<span class="sd"> */</span>
2081 <span class="k">public</span> <span class="k">function</span> <span class="nf">getURL</span><span class="p">()</span> <span class="p">{</span>
2082 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getDecoratedObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">();</span>
2083 <span class="p">}</span>
2084
2085 <span class="sd">/**</span>
2086<span class="sd"> * @inheritDoc</span>
2087<span class="sd"> */</span>
2088 <span class="k">public</span> <span class="k">function</span> <span class="nf">getAuthorID</span><span class="p">()</span> <span class="p">{</span>
2089 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getDecoratedObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">;</span>
2090 <span class="p">}</span>
2091<span class="p">}</span>
2092</code></pre></div>
45ca63d0
TD		 2093<ul>
2094<li>The <code>getTitle()</code> method returns the title of the object.
2095 In this case, we assume that the <code>Foo</code> class has implemented the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/data/ITitledObject.class.php">ITitledObject</a> interface so that the decorated <code>Foo</code> can handle this method call itself.</li>
2096<li>The <code>getURL()</code> method returns the link to the object.
2097 As for the <code>getTitle()</code>, we assume that the <code>Foo</code> class has implemented the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/data/ILinkableObject.class.php">ILinkableObject</a> interface so that the decorated <code>Foo</code> can also handle this method call itself.</li>
2098<li>The <code>getAuthorID()</code> method returns the id of the user who created the decorated <code>Foo</code> object.
2099 We assume that <code>Foo</code> objects have a <code>userID</code> property that contains this id.</li>
2100</ul>
2101<h2 id="usernotificationeventxml"><code>userNotificationEvent.xml</code><a class="headerlink" href="#usernotificationeventxml" title="Permanent link">#</a></h2>
2102<p>Each event that you fire in your package needs to be registered using the <a href="../../../package/pip/user-notification-event/">user notification event package installation plugin</a>.
2103An example file might look like this:</p>
2104<div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2105<span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/userNotificationEvent.xsd&quot;</span><span class="nt">&gt;</span>
2106 <span class="nt">&lt;import&gt;</span>
2107 <span class="nt">&lt;event&gt;</span>
2108 <span class="nt">&lt;name&gt;</span>bar<span class="nt">&lt;/name&gt;</span>
2109 <span class="nt">&lt;objecttype&gt;</span>com.woltlab.example.foo<span class="nt">&lt;/objecttype&gt;</span>
2110 <span class="nt">&lt;classname&gt;</span>example\system\user\notification\event\FooUserNotificationEvent<span class="nt">&lt;/classname&gt;</span>
2111 <span class="nt">&lt;preset&gt;</span>1<span class="nt">&lt;/preset&gt;</span>
2112 <span class="nt">&lt;/event&gt;</span>
2113 <span class="nt">&lt;/import&gt;</span>
2114<span class="nt">&lt;/data&gt;</span>
2115</code></pre></div>
45ca63d0
TD		 2116<p>Here, you reference the user notification object type created via <code>objectType.xml</code>.
2117The referenced class in the <code>&lt;classname&gt;</code> element has to implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/event/IUserNotificationEvent.class.php">IUserNotificationEvent</a> interface by extending the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/event/AbstractUserNotificationEvent.class.php">AbstractUserNotificationEvent</a> class or the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/user/notification/event/AbstractSharedUserNotificationEvent.class.php">AbstractSharedUserNotificationEvent</a> class if you want to pre-load additional data before processing notifications.
2118In <code>AbstractSharedUserNotificationEvent::prepare()</code>, you can, for example, tell runtime caches to prepare to load certain objects which then are loaded all at once when the objects are needed.</p>
2119<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2120<span class="k">namespace</span> <span class="nx">example\system\user\notification\event</span><span class="p">;</span>
2121<span class="k">use</span> <span class="nx">example\system\cache\runtime\BazRuntimeCache</span><span class="p">;</span>
2122<span class="k">use</span> <span class="nx">example\system\user\notification\object\FooUserNotificationObject</span><span class="p">;</span>
2123<span class="k">use</span> <span class="nx">wcf\system\email\Email</span><span class="p">;</span>
2124<span class="k">use</span> <span class="nx">wcf\system\request\LinkHandler</span><span class="p">;</span>
2125<span class="k">use</span> <span class="nx">wcf\system\user\notification\event\AbstractSharedUserNotificationEvent</span><span class="p">;</span>
2126
2127<span class="sd">/**</span>
2128<span class="sd"> * Notification event for foos.</span>
2129<span class="sd"> * </span>
2130<span class="sd"> * @author Matthias Schmidt</span>
2131<span class="sd"> * @copyright 2001-2017 WoltLab GmbH</span>
2132<span class="sd"> * @license WoltLab License &lt;http://www.woltlab.com/license-agreement.html&gt;</span>
2133<span class="sd"> * @package WoltLabSuite\Example\System\User\Notification\Event</span>
2134<span class="sd"> * </span>
2135<span class="sd"> * @method FooUserNotificationObject getUserNotificationObject()</span>
2136<span class="sd"> */</span>
2137<span class="k">class</span> <span class="nc">FooUserNotificationEvent</span> <span class="k">extends</span> <span class="nx">AbstractSharedUserNotificationEvent</span> <span class="p">{</span>
2138 <span class="sd">/**</span>
2139<span class="sd"> * @inheritDoc</span>
2140<span class="sd"> */</span>
2141 <span class="k">protected</span> <span class="nv">$stackable</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
2142
2143 <span class="sd">/** @noinspection PhpMissingParentCallCommonInspection */</span>
2144 <span class="sd">/**</span>
2145<span class="sd"> * @inheritDoc</span>
2146<span class="sd"> */</span>
2147 <span class="k">public</span> <span class="k">function</span> <span class="nf">checkAccess</span><span class="p">()</span> <span class="p">{</span>
2148 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">setBaz</span><span class="p">(</span><span class="nx">BazRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getObject</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="p">));</span>
2149
2150 <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">isAccessible</span><span class="p">())</span> <span class="p">{</span>
2151 <span class="c1">// do some cleanup, if necessary</span>
2152
2153 <span class="k">return</span> <span class="k">false</span><span class="p">;</span>
2154 <span class="p">}</span>
2155
2156 <span class="k">return</span> <span class="k">true</span><span class="p">;</span>
2157 <span class="p">}</span>
2158
2159 <span class="sd">/** @noinspection PhpMissingParentCallCommonInspection */</span>
2160 <span class="sd">/**</span>
2161<span class="sd"> * @inheritDoc</span>
2162<span class="sd"> */</span>
2163 <span class="k">public</span> <span class="k">function</span> <span class="nf">getEmailMessage</span><span class="p">(</span><span class="nv">$notificationType</span> <span class="o">=</span> <span class="s1">&#39;instant&#39;</span><span class="p">)</span> <span class="p">{</span>
2164 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">setBaz</span><span class="p">(</span><span class="nx">BazRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getObject</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="p">));</span>
2165
2166 <span class="nv">$messageID</span> <span class="o">=</span> <span class="s1">&#39;&lt;com.woltlab.example.baz/&#39;</span><span class="o">.</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="o">.</span><span class="s1">&#39;@&#39;</span><span class="o">.</span><span class="nx">Email</span><span class="o">::</span><span class="na">getHost</span><span class="p">()</span><span class="o">.</span><span class="s1">&#39;&gt;&#39;</span><span class="p">;</span>
2167
2168 <span class="k">return</span> <span class="p">[</span>
2169 <span class="s1">&#39;application&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;example&#39;</span><span class="p">,</span>
2170 <span class="s1">&#39;in-reply-to&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nv">$messageID</span><span class="p">],</span>
2171 <span class="s1">&#39;message-id&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;com.woltlab.example.foo/&#39;</span><span class="o">.</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fooID</span><span class="p">,</span>
2172 <span class="s1">&#39;references&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span><span class="nv">$messageID</span><span class="p">],</span>
2173 <span class="s1">&#39;template&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;email_notification_foo&#39;</span>
2174 <span class="p">];</span>
2175 <span class="p">}</span>
2176
2177 <span class="sd">/**</span>
2178<span class="sd"> * @inheritDoc</span>
2179<span class="sd"> * @since 5.0</span>
2180<span class="sd"> */</span>
2181 <span class="k">public</span> <span class="k">function</span> <span class="nf">getEmailTitle</span><span class="p">()</span> <span class="p">{</span>
2182 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">setBaz</span><span class="p">(</span><span class="nx">BazRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getObject</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="p">));</span>
2183
2184 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">&#39;example.foo.notification.mail.title&#39;</span><span class="p">,</span> <span class="p">[</span>
2185 <span class="s1">&#39;userNotificationObject&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span>
2186 <span class="p">]);</span>
2187 <span class="p">}</span>
2188
2189 <span class="sd">/** @noinspection PhpMissingParentCallCommonInspection */</span>
2190 <span class="sd">/**</span>
2191<span class="sd"> * @inheritDoc</span>
2192<span class="sd"> */</span>
2193 <span class="k">public</span> <span class="k">function</span> <span class="nf">getEventHash</span><span class="p">()</span> <span class="p">{</span>
2194 <span class="k">return</span> <span class="nb">sha1</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">eventID</span> <span class="o">.</span> <span class="s1">&#39;-&#39;</span> <span class="o">.</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="p">);</span>
2195 <span class="p">}</span>
2196
2197 <span class="sd">/**</span>
2198<span class="sd"> * @inheritDoc</span>
2199<span class="sd"> */</span>
2200 <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">()</span> <span class="p">{</span>
2201 <span class="k">return</span> <span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">(</span><span class="s1">&#39;Foo&#39;</span><span class="p">,</span> <span class="p">[</span>
2202 <span class="s1">&#39;application&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;example&#39;</span><span class="p">,</span>
2203 <span class="s1">&#39;object&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getDecoratedObject</span><span class="p">()</span>
2204 <span class="p">]);</span>
2205 <span class="p">}</span>
2206
2207 <span class="sd">/**</span>
2208<span class="sd"> * @inheritDoc</span>
2209<span class="sd"> */</span>
2210 <span class="k">public</span> <span class="k">function</span> <span class="nf">getMessage</span><span class="p">()</span> <span class="p">{</span>
2211 <span class="nv">$authors</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getAuthors</span><span class="p">();</span>
2212 <span class="nv">$count</span> <span class="o">=</span> <span class="nb">count</span><span class="p">(</span><span class="nv">$authors</span><span class="p">);</span>
2213
2214 <span class="k">if</span> <span class="p">(</span><span class="nv">$count</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
2215 <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$authors</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span> <span class="p">{</span>
2216 <span class="nb">unset</span><span class="p">(</span><span class="nv">$authors</span><span class="p">[</span><span class="mi">0</span><span class="p">]);</span>
2217 <span class="p">}</span>
2218 <span class="nv">$count</span> <span class="o">=</span> <span class="nb">count</span><span class="p">(</span><span class="nv">$authors</span><span class="p">);</span>
2219
2220 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">&#39;example.foo.notification.message.stacked&#39;</span><span class="p">,</span> <span class="p">[</span>
2221 <span class="s1">&#39;author&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">author</span><span class="p">,</span>
2222 <span class="s1">&#39;authors&#39;</span> <span class="o">=&gt;</span> <span class="nb">array_values</span><span class="p">(</span><span class="nv">$authors</span><span class="p">),</span>
2223 <span class="s1">&#39;count&#39;</span> <span class="o">=&gt;</span> <span class="nv">$count</span><span class="p">,</span>
2224 <span class="s1">&#39;guestTimesTriggered&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">notification</span><span class="o">-&gt;</span><span class="na">guestTimesTriggered</span><span class="p">,</span>
2225 <span class="s1">&#39;message&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">(),</span>
2226 <span class="s1">&#39;others&#39;</span> <span class="o">=&gt;</span> <span class="nv">$count</span> <span class="o">-</span> <span class="mi">1</span>
2227 <span class="p">]);</span>
2228 <span class="p">}</span>
2229
2230 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">&#39;example.foo.notification.message&#39;</span><span class="p">,</span> <span class="p">[</span>
2231 <span class="s1">&#39;author&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">author</span><span class="p">,</span>
2232 <span class="s1">&#39;userNotificationObject&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span>
2233 <span class="p">]);</span>
2234 <span class="p">}</span>
2235
2236 <span class="sd">/**</span>
2237<span class="sd"> * @inheritDoc</span>
2238<span class="sd"> */</span>
2239 <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">()</span> <span class="p">{</span>
2240 <span class="nv">$count</span> <span class="o">=</span> <span class="nb">count</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getAuthors</span><span class="p">());</span>
2241 <span class="k">if</span> <span class="p">(</span><span class="nv">$count</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
2242 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getDynamicVariable</span><span class="p">(</span><span class="s1">&#39;example.foo.notification.title.stacked&#39;</span><span class="p">,</span> <span class="p">[</span>
2243 <span class="s1">&#39;count&#39;</span> <span class="o">=&gt;</span> <span class="nv">$count</span><span class="p">,</span>
2244 <span class="s1">&#39;timesTriggered&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">notification</span><span class="o">-&gt;</span><span class="na">timesTriggered</span>
2245 <span class="p">]);</span>
2246 <span class="p">}</span>
2247
2248 <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getLanguage</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">get</span><span class="p">(</span><span class="s1">&#39;example.foo.notification.title&#39;</span><span class="p">);</span>
2249 <span class="p">}</span>
2250
2251 <span class="sd">/**</span>
2252<span class="sd"> * @inheritDoc</span>
2253<span class="sd"> */</span>
2254 <span class="k">protected</span> <span class="k">function</span> <span class="nf">prepare</span><span class="p">()</span> <span class="p">{</span>
2255 <span class="nx">BazRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">cacheObjectID</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getUserNotificationObject</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">bazID</span><span class="p">);</span>
2256 <span class="p">}</span>
2257<span class="p">}</span>
2258</code></pre></div>
45ca63d0
TD		 2259<ul>
2260<li>The <code>$stackable</code> property is <code>false</code> by default and has to be explicitly set to <code>true</code> if stacking of notifications should be enabled.
2261 Stacking of notification does not create new notifications for the same event for a certain object if the related action as been triggered by different users.
2262 For example, if something is liked by one user and then liked again by another user before the recipient of the notification has confirmed it, the existing notification will be amended to include both users who liked the content.
2263 Stacking can thus be used to avoid cluttering the notification list of users.</li>
2264<li>The <code>checkAccess()</code> method makes sure that the active user still has access to the object related to the notification.
2265 If that is not the case, the user notification system will automatically deleted the user notification based on the return value of the method.
2266 If you have any cached values related to notifications, you should also reset these values here.</li>
2267<li>The <code>getEmailMessage()</code> method return data to create the instant email or the daily summary email.
2268 For instant emails (<code>$notificationType = 'instant'</code>), you have to return an array like the one shown in the code above with the following components:</li>
2269<li><code>application</code>:
2270 abbreviation of application</li>
2271<li><code>in-reply-to</code> (optional):
2272 message id of the notification for the parent item and used to improve the ordering in threaded email clients</li>
2273<li><code>message-id</code> (optional):
2274 message id of the notification mail and has to be used in <code>in-reply-to</code> and <code>references</code> for follow up mails</li>
2275<li><code>references</code> (optional):
2276 all of the message ids of parent items (i.e. recursive in-reply-to)</li>
2277<li><code>template</code>:
2278 name of the template used to render the email body, should start with <code>email_</code></li>
2279<li><code>variables</code> (optional):
2280 template variables passed to the email template where they can be accessed via <code>$notificationContent[variables]</code></li>
2281</ul>
2282<p>For daily emails (<code>$notificationType = 'daily'</code>), only <code>application</code>, <code>template</code>, and <code>variables</code> are supported.
2283- The <code>getEmailTitle()</code> returns the title of the instant email sent to the user.
2284 By default, <code>getEmailTitle()</code> simply calls <code>getTitle()</code>.
2285- The <code>getEventHash()</code> method returns a hash by which user notifications are grouped.
2286 Here, we want to group them not by the actual <code>Foo</code> object but by its parent <code>Baz</code> object and thus overwrite the default implementation provided by <code>AbstractUserNotificationEvent</code>.
2287- The <code>getLink()</code> returns the link to the <code>Foo</code> object the notification belongs to.
2288- The <code>getMessage()</code> method and the <code>getTitle()</code> return the message and the title of the user notification respectively.
2289 By checking the value of <code>count($this-&gt;getAuthors())</code>, we check if the notification is stacked, thus if the event has been triggered for multiple users so that different languages items are used.
2290 If your notification event does not support stacking, this distinction is not necessary.
2291- The <code>prepare()</code> method is called for each user notification before all user notifications are rendered.
2292 This allows to tell runtime caches to prepare to load objects later on (see <a href="../caches_runtime-caches/">Runtime Caches</a>).</p>
2293<h2 id="firing-events">Firing Events<a class="headerlink" href="#firing-events" title="Permanent link">#</a></h2>
2294<p>When the action related to a user notification is executed, you can use <code>UserNotificationHandler::fireEvent()</code> to create the notifications:</p>
2295<div class="highlight"><pre><span></span><code><span class="nv">$recipientIDs</span> <span class="o">=</span> <span class="p">[];</span> <span class="c1">// fill with user ids of the recipients of the notification</span>
2296<span class="nx">UserNotificationHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireEvent</span><span class="p">(</span>
2297 <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="c1">// event name</span>
2298 <span class="s1">&#39;com.woltlab.example.foo&#39;</span><span class="p">,</span> <span class="c1">// event object type name</span>
2299 <span class="k">new</span> <span class="nx">FooUserNotificationObject</span><span class="p">(</span><span class="k">new</span> <span class="nx">Foo</span><span class="p">(</span><span class="nv">$fooID</span><span class="p">)),</span> <span class="c1">// object related to the event</span>
2300 <span class="nv">$recipientIDs</span>
2301<span class="p">);</span>
2302</code></pre></div>
45ca63d0
TD		 2303<h2 id="marking-notifications-as-confirmed">Marking Notifications as Confirmed<a class="headerlink" href="#marking-notifications-as-confirmed" title="Permanent link">#</a></h2>
2304<p>In some instances, you might want to manually mark user notifications as confirmed without the user manually confirming them, for example when they visit the page that is related to the user notification.
2305In this case, you can use <code>UserNotificationHandler::markAsConfirmed()</code>:</p>
2306<div class="highlight"><pre><span></span><code><span class="nv">$recipientIDs</span> <span class="o">=</span> <span class="p">[];</span> <span class="c1">// fill with user ids of the recipients of the notification</span>
2307<span class="nv">$fooIDs</span> <span class="o">=</span> <span class="p">[];</span> <span class="c1">// fill with ids of related foo objects</span>
2308<span class="nx">UserNotificationHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">markAsConfirmed</span><span class="p">(</span>
2309 <span class="s1">&#39;bar&#39;</span><span class="p">,</span> <span class="c1">// event name</span>
2310 <span class="s1">&#39;com.woltlab.example.foo&#39;</span><span class="p">,</span> <span class="c1">// event object type name</span>
2311 <span class="nv">$recipientIDs</span><span class="p">,</span>
2312 <span class="nv">$fooIDs</span>
2313<span class="p">);</span>
2314</code></pre></div>
2315
4a5c32e1
WG		 2316
2317
2318
2319<hr>
2320<div class="md-source-date">
2321 <small>
2322
2323 Last update: 2021-01-08
2324
2325 </small>
2326</div>
2327
2328
45ca63d0
TD		 2329
2330
2331
2332
2333
2334
2335 </article>
2336 </div>
2337 </div>
fb962f09 2338
45ca63d0
TD		 2339 </main>
2340
2341
2342<footer class="md-footer">
2343
2344 <nav class="md-footer__inner md-grid" aria-label="Footer">
2345
2346 <a href="../user_activity_points/" class="md-footer__link md-footer__link--prev" rel="prev">
2347 <div class="md-footer__button md-icon">
2348 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2349 </div>
2350 <div class="md-footer__title">
2351 <div class="md-ellipsis">
2352 <span class="md-footer__direction">
2353 Previous
2354 </span>
2355 User Activity Points
2356 </div>
2357 </div>
2358 </a>
2359
2360
2361 <a href="../sitemaps/" class="md-footer__link md-footer__link--next" rel="next">
2362 <div class="md-footer__title">
2363 <div class="md-ellipsis">
2364 <span class="md-footer__direction">
2365 Next
2366 </span>
2367 Sitemaps
2368 </div>
2369 </div>
2370 <div class="md-footer__button md-icon">
2371 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2372 </div>
2373 </a>
2374
2375 </nav>
2376
2377 <div class="md-footer-meta md-typeset">
2378 <div class="md-footer-meta__inner md-grid">
2379 <div class="md-footer-copyright">
2380
2381 <div class="md-footer-copyright__highlight">
2382 Copyright © 2020 WoltLab GmbH
2383 </div>
2384
2385 Made with
2386 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2387 Material for MkDocs
2388 </a>
fb88dc6e 2389
45ca63d0
TD		 2390 </div>
2391 <div class="md-footer-copyright">
2392 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2393 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2394</div>
2395 </div>
2396 </div>
2397</footer>
2398
2399 </div>
2400 <div class="md-dialog" data-md-component="dialog">
2401 <div class="md-dialog__inner md-typeset"></div>
2402 </div>
fb962f09 2403 <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
45ca63d0
TD		 2404
2405
fb962f09 2406 <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
45ca63d0
TD		 2407
2408
2409 </body>
2410</html>