Deployed 2063d78 to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / tutorial / series / part_3 / index.html
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
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
14
15
16
17 <title>Part 3 - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
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="">
53
54
55
56 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
57 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
58 <label class="md-overlay" for="__drawer"></label>
59 <div data-md-component="skip">
60
61
62 <a href="#tutorial-series-part-3-person-page-and-comments" class="md-skip">
63 Skip to content
64 </a>
65
66 </div>
67 <div data-md-component="announce">
68
69 <aside class="md-announce">
70 <div class="md-announce__inner md-grid md-typeset">
71
72 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
73
74 </div>
75 </aside>
76
77 </div>
78
79
80
81 <header class="md-header" data-md-component="header">
82 <nav class="md-header__inner md-grid" aria-label="Header">
83 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
84
85 <img src="../../../assets/logo.png" alt="logo">
86
87 </a>
88 <label class="md-header__button md-icon" for="__drawer">
89 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
90 </label>
91 <div class="md-header__title" data-md-component="header-title">
92 <div class="md-header__ellipsis">
93 <div class="md-header__topic">
94 <span class="md-ellipsis">
95 WoltLab Suite Documentation
96 </span>
97 </div>
98 <div class="md-header__topic" data-md-component="header-topic">
99 <span class="md-ellipsis">
100
101 Part 3
102
103 </span>
104 </div>
105 </div>
106 </div>
107 <div class="md-header__options">
108
109 </div>
110
111
112 <div class="md-header__source">
113
114 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
115 <div class="md-source__icon md-icon">
116
117 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
118 </div>
119 <div class="md-source__repository">
120 GitHub
121 </div>
122 </a>
123 </div>
124
125 </nav>
126 </header>
127
128 <div class="md-container" data-md-component="container">
129
130
131
132
133 <main class="md-main" data-md-component="main">
134 <div class="md-main__inner md-grid">
135
136
137
138 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
139 <div class="md-sidebar__scrollwrap">
140 <div class="md-sidebar__inner">
141
142
143
144
145
146 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
147 <label class="md-nav__title" for="__drawer">
148 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
149
150 <img src="../../../assets/logo.png" alt="logo">
151
152 </a>
153 WoltLab Suite Documentation
154 </label>
155
156 <div class="md-nav__source">
157
158 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
159 <div class="md-source__icon md-icon">
160
161 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 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>
162 </div>
163 <div class="md-source__repository">
164 GitHub
165 </div>
166 </a>
167 </div>
168
169 <ul class="md-nav__list" data-md-scrollfix>
170
171
172
173
174
175
176
177
178 <li class="md-nav__item">
179 <a href="../../../getting-started/" class="md-nav__link">
180 Getting Started
181 </a>
182 </li>
183
184
185
186
187
188
189
190
191
192
193
194 <li class="md-nav__item md-nav__item--nested">
195
196
197 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
198
199 <label class="md-nav__link" for="__nav_2">
200 PHP API
201 <span class="md-nav__icon md-icon"></span>
202 </label>
203 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
204 <label class="md-nav__title" for="__nav_2">
205 <span class="md-nav__icon md-icon"></span>
206 PHP API
207 </label>
208 <ul class="md-nav__list" data-md-scrollfix>
209
210
211
212
213
214 <li class="md-nav__item">
215 <a href="../../../php/pages/" class="md-nav__link">
216 Pages
217 </a>
218 </li>
219
220
221
222
223
224
225
226 <li class="md-nav__item">
227 <a href="../../../php/database-objects/" class="md-nav__link">
228 Database Objects
229 </a>
230 </li>
231
232
233
234
235
236
237
238 <li class="md-nav__item">
239 <a href="../../../php/database-access/" class="md-nav__link">
240 Database Access
241 </a>
242 </li>
243
244
245
246
247
248
249
250 <li class="md-nav__item">
251 <a href="../../../php/exceptions/" class="md-nav__link">
252 Exceptions
253 </a>
254 </li>
255
256
257
258
259
260
261
262
263 <li class="md-nav__item md-nav__item--nested">
264
265
266 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
267
268 <label class="md-nav__link" for="__nav_2_5">
269 API
270 <span class="md-nav__icon md-icon"></span>
271 </label>
272 <nav class="md-nav" aria-label="API" data-md-level="2">
273 <label class="md-nav__title" for="__nav_2_5">
274 <span class="md-nav__icon md-icon"></span>
275 API
276 </label>
277 <ul class="md-nav__list" data-md-scrollfix>
278
279
280
281
282
283 <li class="md-nav__item">
284 <a href="../../../php/api/caches/" class="md-nav__link">
285 Caches
286 </a>
287 </li>
288
289
290
291
292
293
294
295 <li class="md-nav__item">
296 <a href="../../../php/api/comments/" class="md-nav__link">
297 Comments
298 </a>
299 </li>
300
301
302
303
304
305
306
307 <li class="md-nav__item">
308 <a href="../../../php/api/cronjobs/" class="md-nav__link">
309 Cronjobs
310 </a>
311 </li>
312
313
314
315
316
317
318
319 <li class="md-nav__item">
320 <a href="../../../php/api/events/" class="md-nav__link">
321 Events
322 </a>
323 </li>
324
325
326
327
328
329
330
331
332 <li class="md-nav__item md-nav__item--nested">
333
334
335 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
336
337 <label class="md-nav__link" for="__nav_2_5_5">
338 Form Builder
339 <span class="md-nav__icon md-icon"></span>
340 </label>
341 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
342 <label class="md-nav__title" for="__nav_2_5_5">
343 <span class="md-nav__icon md-icon"></span>
344 Form Builder
345 </label>
346 <ul class="md-nav__list" data-md-scrollfix>
347
348
349
350
351
352 <li class="md-nav__item">
353 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
354 Overview
355 </a>
356 </li>
357
358
359
360
361
362
363
364 <li class="md-nav__item">
365 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
366 Structure
367 </a>
368 </li>
369
370
371
372
373
374
375
376 <li class="md-nav__item">
377 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
378 Fields
379 </a>
380 </li>
381
382
383
384
385
386
387
388 <li class="md-nav__item">
389 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
390 Validation and Data
391 </a>
392 </li>
393
394
395
396
397
398
399
400 <li class="md-nav__item">
401 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
402 Dependencies
403 </a>
404 </li>
405
406
407
408 </ul>
409 </nav>
410 </li>
411
412
413
414
415
416
417
418 <li class="md-nav__item">
419 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
420 Package Installation Plugins
421 </a>
422 </li>
423
424
425
426
427
428
429
430 <li class="md-nav__item">
431 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
432 User Activity Points
433 </a>
434 </li>
435
436
437
438
439
440
441
442 <li class="md-nav__item">
443 <a href="../../../php/api/user_notifications/" class="md-nav__link">
444 User Notifications
445 </a>
446 </li>
447
448
449
450
451
452
453
454 <li class="md-nav__item">
455 <a href="../../../php/api/sitemaps/" class="md-nav__link">
456 Sitemaps
457 </a>
458 </li>
459
460
461
462 </ul>
463 </nav>
464 </li>
465
466
467
468
469
470
471
472 <li class="md-nav__item">
473 <a href="../../../php/code-style/" class="md-nav__link">
474 Code Style
475 </a>
476 </li>
477
478
479
480
481
482
483
484 <li class="md-nav__item">
485 <a href="../../../php/apps/" class="md-nav__link">
486 Apps
487 </a>
488 </li>
489
490
491
492
493
494
495
496 <li class="md-nav__item">
497 <a href="../../../php/gdpr/" class="md-nav__link">
498 GDPR
499 </a>
500 </li>
501
502
503
504 </ul>
505 </nav>
506 </li>
507
508
509
510
511
512
513
514
515
516
517
518 <li class="md-nav__item md-nav__item--nested">
519
520
521 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
522
523 <label class="md-nav__link" for="__nav_3">
524 Languages, Templates & CSS
525 <span class="md-nav__icon md-icon"></span>
526 </label>
527 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
528 <label class="md-nav__title" for="__nav_3">
529 <span class="md-nav__icon md-icon"></span>
530 Languages, Templates & CSS
531 </label>
532 <ul class="md-nav__list" data-md-scrollfix>
533
534
535
536
537
538 <li class="md-nav__item">
539 <a href="../../../view/languages/" class="md-nav__link">
540 Languages
541 </a>
542 </li>
543
544
545
546
547
548
549
550 <li class="md-nav__item">
551 <a href="../../../view/templates/" class="md-nav__link">
552 Templates
553 </a>
554 </li>
555
556
557
558
559
560
561
562 <li class="md-nav__item">
563 <a href="../../../view/css/" class="md-nav__link">
564 CSS
565 </a>
566 </li>
567
568
569
570 </ul>
571 </nav>
572 </li>
573
574
575
576
577
578
579
580
581
582
583
584 <li class="md-nav__item md-nav__item--nested">
585
586
587 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
588
589 <label class="md-nav__link" for="__nav_4">
590 JavaScript API
591 <span class="md-nav__icon md-icon"></span>
592 </label>
593 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
594 <label class="md-nav__title" for="__nav_4">
595 <span class="md-nav__icon md-icon"></span>
596 JavaScript API
597 </label>
598 <ul class="md-nav__list" data-md-scrollfix>
599
600
601
602
603
604 <li class="md-nav__item">
605 <a href="../../../javascript/general-usage/" class="md-nav__link">
606 General Usage
607 </a>
608 </li>
609
610
611
612
613
614
615
616
617 <li class="md-nav__item md-nav__item--nested">
618
619
620 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
621
622 <label class="md-nav__link" for="__nav_4_2">
623 New API
624 <span class="md-nav__icon md-icon"></span>
625 </label>
626 <nav class="md-nav" aria-label="New API" data-md-level="2">
627 <label class="md-nav__title" for="__nav_4_2">
628 <span class="md-nav__icon md-icon"></span>
629 New API
630 </label>
631 <ul class="md-nav__list" data-md-scrollfix>
632
633
634
635
636
637 <li class="md-nav__item">
638 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
639 Writing a module
640 </a>
641 </li>
642
643
644
645
646
647
648
649 <li class="md-nav__item">
650 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
651 Data Structures
652 </a>
653 </li>
654
655
656
657
658
659
660
661 <li class="md-nav__item">
662 <a href="../../../javascript/new-api_core/" class="md-nav__link">
663 Core Functions
664 </a>
665 </li>
666
667
668
669
670
671
672
673 <li class="md-nav__item">
674 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
675 DOM
676 </a>
677 </li>
678
679
680
681
682
683
684
685 <li class="md-nav__item">
686 <a href="../../../javascript/new-api_events/" class="md-nav__link">
687 Event Handling
688 </a>
689 </li>
690
691
692
693
694
695
696
697 <li class="md-nav__item">
698 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
699 Ajax
700 </a>
701 </li>
702
703
704
705
706
707
708
709 <li class="md-nav__item">
710 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
711 Dialogs
712 </a>
713 </li>
714
715
716
717
718
719
720
721 <li class="md-nav__item">
722 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
723 Browser and Screen Sizes
724 </a>
725 </li>
726
727
728
729
730
731
732
733 <li class="md-nav__item">
734 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
735 User Interface
736 </a>
737 </li>
738
739
740
741 </ul>
742 </nav>
743 </li>
744
745
746
747
748
749
750
751 <li class="md-nav__item">
752 <a href="../../../javascript/legacy-api/" class="md-nav__link">
753 Legacy API
754 </a>
755 </li>
756
757
758
759
760
761
762
763 <li class="md-nav__item">
764 <a href="../../../javascript/helper-functions/" class="md-nav__link">
765 Helper Functions
766 </a>
767 </li>
768
769
770
771
772
773
774
775 <li class="md-nav__item">
776 <a href="../../../javascript/code-snippets/" class="md-nav__link">
777 Code Snippets
778 </a>
779 </li>
780
781
782
783 </ul>
784 </nav>
785 </li>
786
787
788
789
790
791
792
793
794
795
796
797 <li class="md-nav__item md-nav__item--nested">
798
799
800 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
801
802 <label class="md-nav__link" for="__nav_5">
803 Package Components
804 <span class="md-nav__icon md-icon"></span>
805 </label>
806 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
807 <label class="md-nav__title" for="__nav_5">
808 <span class="md-nav__icon md-icon"></span>
809 Package Components
810 </label>
811 <ul class="md-nav__list" data-md-scrollfix>
812
813
814
815
816
817 <li class="md-nav__item">
818 <a href="../../../package/package-xml/" class="md-nav__link">
819 package.xml
820 </a>
821 </li>
822
823
824
825
826
827
828
829
830 <li class="md-nav__item md-nav__item--nested">
831
832
833 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
834
835 <label class="md-nav__link" for="__nav_5_2">
836 PIPs
837 <span class="md-nav__icon md-icon"></span>
838 </label>
839 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
840 <label class="md-nav__title" for="__nav_5_2">
841 <span class="md-nav__icon md-icon"></span>
842 PIPs
843 </label>
844 <ul class="md-nav__list" data-md-scrollfix>
845
846
847
848
849
850 <li class="md-nav__item">
851 <a href="../../../package/pip/" class="md-nav__link">
852 Overview
853 </a>
854 </li>
855
856
857
858
859
860
861
862 <li class="md-nav__item">
863 <a href="../../../package/pip/acl-option/" class="md-nav__link">
864 aclOption
865 </a>
866 </li>
867
868
869
870
871
872
873
874 <li class="md-nav__item">
875 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
876 acpMenu
877 </a>
878 </li>
879
880
881
882
883
884
885
886 <li class="md-nav__item">
887 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
888 acpSearchProvider
889 </a>
890 </li>
891
892
893
894
895
896
897
898 <li class="md-nav__item">
899 <a href="../../../package/pip/acp-template/" class="md-nav__link">
900 acpTemplate
901 </a>
902 </li>
903
904
905
906
907
908
909
910 <li class="md-nav__item">
911 <a href="../../../package/pip/bbcode/" class="md-nav__link">
912 bbcode
913 </a>
914 </li>
915
916
917
918
919
920
921
922 <li class="md-nav__item">
923 <a href="../../../package/pip/box/" class="md-nav__link">
924 box
925 </a>
926 </li>
927
928
929
930
931
932
933
934 <li class="md-nav__item">
935 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
936 clipboardAction
937 </a>
938 </li>
939
940
941
942
943
944
945
946 <li class="md-nav__item">
947 <a href="../../../package/pip/core-object/" class="md-nav__link">
948 coreObject
949 </a>
950 </li>
951
952
953
954
955
956
957
958 <li class="md-nav__item">
959 <a href="../../../package/pip/cronjob/" class="md-nav__link">
960 cronjob
961 </a>
962 </li>
963
964
965
966
967
968
969
970 <li class="md-nav__item">
971 <a href="../../../package/pip/event-listener/" class="md-nav__link">
972 eventListener
973 </a>
974 </li>
975
976
977
978
979
980
981
982 <li class="md-nav__item">
983 <a href="../../../package/pip/file/" class="md-nav__link">
984 file
985 </a>
986 </li>
987
988
989
990
991
992
993
994 <li class="md-nav__item">
995 <a href="../../../package/pip/language/" class="md-nav__link">
996 language
997 </a>
998 </li>
999
1000
1001
1002
1003
1004
1005
1006 <li class="md-nav__item">
1007 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1008 mediaProvider
1009 </a>
1010 </li>
1011
1012
1013
1014
1015
1016
1017
1018 <li class="md-nav__item">
1019 <a href="../../../package/pip/menu/" class="md-nav__link">
1020 menu
1021 </a>
1022 </li>
1023
1024
1025
1026
1027
1028
1029
1030 <li class="md-nav__item">
1031 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1032 menuItem
1033 </a>
1034 </li>
1035
1036
1037
1038
1039
1040
1041
1042 <li class="md-nav__item">
1043 <a href="../../../package/pip/object-type/" class="md-nav__link">
1044 objectType
1045 </a>
1046 </li>
1047
1048
1049
1050
1051
1052
1053
1054 <li class="md-nav__item">
1055 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1056 objectTypeDefinition
1057 </a>
1058 </li>
1059
1060
1061
1062
1063
1064
1065
1066 <li class="md-nav__item">
1067 <a href="../../../package/pip/option/" class="md-nav__link">
1068 option
1069 </a>
1070 </li>
1071
1072
1073
1074
1075
1076
1077
1078 <li class="md-nav__item">
1079 <a href="../../../package/pip/page/" class="md-nav__link">
1080 page
1081 </a>
1082 </li>
1083
1084
1085
1086
1087
1088
1089
1090 <li class="md-nav__item">
1091 <a href="../../../package/pip/pip/" class="md-nav__link">
1092 pip
1093 </a>
1094 </li>
1095
1096
1097
1098
1099
1100
1101
1102 <li class="md-nav__item">
1103 <a href="../../../package/pip/script/" class="md-nav__link">
1104 script
1105 </a>
1106 </li>
1107
1108
1109
1110
1111
1112
1113
1114 <li class="md-nav__item">
1115 <a href="../../../package/pip/smiley/" class="md-nav__link">
1116 smiley
1117 </a>
1118 </li>
1119
1120
1121
1122
1123
1124
1125
1126 <li class="md-nav__item">
1127 <a href="../../../package/pip/sql/" class="md-nav__link">
1128 sql
1129 </a>
1130 </li>
1131
1132
1133
1134
1135
1136
1137
1138 <li class="md-nav__item">
1139 <a href="../../../package/pip/style/" class="md-nav__link">
1140 style
1141 </a>
1142 </li>
1143
1144
1145
1146
1147
1148
1149
1150 <li class="md-nav__item">
1151 <a href="../../../package/pip/template/" class="md-nav__link">
1152 template
1153 </a>
1154 </li>
1155
1156
1157
1158
1159
1160
1161
1162 <li class="md-nav__item">
1163 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1164 templateListener
1165 </a>
1166 </li>
1167
1168
1169
1170
1171
1172
1173
1174 <li class="md-nav__item">
1175 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1176 userGroupOption
1177 </a>
1178 </li>
1179
1180
1181
1182
1183
1184
1185
1186 <li class="md-nav__item">
1187 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1188 userMenu
1189 </a>
1190 </li>
1191
1192
1193
1194
1195
1196
1197
1198 <li class="md-nav__item">
1199 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1200 userNotificationEvent
1201 </a>
1202 </li>
1203
1204
1205
1206
1207
1208
1209
1210 <li class="md-nav__item">
1211 <a href="../../../package/pip/user-option/" class="md-nav__link">
1212 userOption
1213 </a>
1214 </li>
1215
1216
1217
1218
1219
1220
1221
1222 <li class="md-nav__item">
1223 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1224 userProfileMenu
1225 </a>
1226 </li>
1227
1228
1229
1230 </ul>
1231 </nav>
1232 </li>
1233
1234
1235
1236
1237
1238
1239
1240 <li class="md-nav__item">
1241 <a href="../../../package/database-php-api/" class="md-nav__link">
1242 Database PHP API
1243 </a>
1244 </li>
1245
1246
1247
1248 </ul>
1249 </nav>
1250 </li>
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262 <li class="md-nav__item md-nav__item--nested">
1263
1264
1265 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1266
1267 <label class="md-nav__link" for="__nav_6">
1268 Migration
1269 <span class="md-nav__icon md-icon"></span>
1270 </label>
1271 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1272 <label class="md-nav__title" for="__nav_6">
1273 <span class="md-nav__icon md-icon"></span>
1274 Migration
1275 </label>
1276 <ul class="md-nav__list" data-md-scrollfix>
1277
1278
1279
1280
1281
1282
1283 <li class="md-nav__item md-nav__item--nested">
1284
1285
1286 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1287
1288 <label class="md-nav__link" for="__nav_6_1">
1289 Migrating from WSC 5.3
1290 <span class="md-nav__icon md-icon"></span>
1291 </label>
1292 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1293 <label class="md-nav__title" for="__nav_6_1">
1294 <span class="md-nav__icon md-icon"></span>
1295 Migrating from WSC 5.3
1296 </label>
1297 <ul class="md-nav__list" data-md-scrollfix>
1298
1299
1300
1301
1302
1303 <li class="md-nav__item">
1304 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1305 PHP API
1306 </a>
1307 </li>
1308
1309
1310
1311
1312
1313
1314
1315 <li class="md-nav__item">
1316 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1317 Session Handling and Authentication
1318 </a>
1319 </li>
1320
1321
1322
1323
1324
1325
1326
1327 <li class="md-nav__item">
1328 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1329 JavaScript
1330 </a>
1331 </li>
1332
1333
1334
1335
1336
1337
1338
1339 <li class="md-nav__item">
1340 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1341 Templates
1342 </a>
1343 </li>
1344
1345
1346
1347
1348
1349
1350
1351 <li class="md-nav__item">
1352 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1353 Third Party Libraries
1354 </a>
1355 </li>
1356
1357
1358
1359 </ul>
1360 </nav>
1361 </li>
1362
1363
1364
1365
1366
1367
1368
1369
1370 <li class="md-nav__item md-nav__item--nested">
1371
1372
1373 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1374
1375 <label class="md-nav__link" for="__nav_6_2">
1376 Migrating from WSC 5.2
1377 <span class="md-nav__icon md-icon"></span>
1378 </label>
1379 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1380 <label class="md-nav__title" for="__nav_6_2">
1381 <span class="md-nav__icon md-icon"></span>
1382 Migrating from WSC 5.2
1383 </label>
1384 <ul class="md-nav__list" data-md-scrollfix>
1385
1386
1387
1388
1389
1390 <li class="md-nav__item">
1391 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1392 PHP API
1393 </a>
1394 </li>
1395
1396
1397
1398
1399
1400
1401
1402 <li class="md-nav__item">
1403 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1404 Templates and Languages
1405 </a>
1406 </li>
1407
1408
1409
1410
1411
1412
1413
1414 <li class="md-nav__item">
1415 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1416 Third Party Libraries
1417 </a>
1418 </li>
1419
1420
1421
1422 </ul>
1423 </nav>
1424 </li>
1425
1426
1427
1428
1429
1430
1431
1432
1433 <li class="md-nav__item md-nav__item--nested">
1434
1435
1436 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1437
1438 <label class="md-nav__link" for="__nav_6_3">
1439 Migrating from WSC 3.1
1440 <span class="md-nav__icon md-icon"></span>
1441 </label>
1442 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1443 <label class="md-nav__title" for="__nav_6_3">
1444 <span class="md-nav__icon md-icon"></span>
1445 Migrating from WSC 3.1
1446 </label>
1447 <ul class="md-nav__list" data-md-scrollfix>
1448
1449
1450
1451
1452
1453 <li class="md-nav__item">
1454 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1455 PHP API
1456 </a>
1457 </li>
1458
1459
1460
1461 </ul>
1462 </nav>
1463 </li>
1464
1465
1466
1467
1468
1469
1470
1471
1472 <li class="md-nav__item md-nav__item--nested">
1473
1474
1475 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1476
1477 <label class="md-nav__link" for="__nav_6_4">
1478 Migrating from WSC 3.0
1479 <span class="md-nav__icon md-icon"></span>
1480 </label>
1481 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1482 <label class="md-nav__title" for="__nav_6_4">
1483 <span class="md-nav__icon md-icon"></span>
1484 Migrating from WSC 3.0
1485 </label>
1486 <ul class="md-nav__list" data-md-scrollfix>
1487
1488
1489
1490
1491
1492 <li class="md-nav__item">
1493 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1494 PHP API
1495 </a>
1496 </li>
1497
1498
1499
1500
1501
1502
1503
1504 <li class="md-nav__item">
1505 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1506 JavaScript API
1507 </a>
1508 </li>
1509
1510
1511
1512
1513
1514
1515
1516 <li class="md-nav__item">
1517 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1518 Templates
1519 </a>
1520 </li>
1521
1522
1523
1524
1525
1526
1527
1528 <li class="md-nav__item">
1529 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1530 CSS
1531 </a>
1532 </li>
1533
1534
1535
1536
1537
1538
1539
1540 <li class="md-nav__item">
1541 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1542 Package Components
1543 </a>
1544 </li>
1545
1546
1547
1548 </ul>
1549 </nav>
1550 </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559 <li class="md-nav__item md-nav__item--nested">
1560
1561
1562 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1563
1564 <label class="md-nav__link" for="__nav_6_5">
1565 Migrating from WCF 2.1
1566 <span class="md-nav__icon md-icon"></span>
1567 </label>
1568 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1569 <label class="md-nav__title" for="__nav_6_5">
1570 <span class="md-nav__icon md-icon"></span>
1571 Migrating from WCF 2.1
1572 </label>
1573 <ul class="md-nav__list" data-md-scrollfix>
1574
1575
1576
1577
1578
1579 <li class="md-nav__item">
1580 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1581 PHP API
1582 </a>
1583 </li>
1584
1585
1586
1587
1588
1589
1590
1591 <li class="md-nav__item">
1592 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1593 Templates
1594 </a>
1595 </li>
1596
1597
1598
1599
1600
1601
1602
1603 <li class="md-nav__item">
1604 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1605 CSS
1606 </a>
1607 </li>
1608
1609
1610
1611
1612
1613
1614
1615 <li class="md-nav__item">
1616 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1617 Package Components
1618 </a>
1619 </li>
1620
1621
1622
1623 </ul>
1624 </nav>
1625 </li>
1626
1627
1628
1629 </ul>
1630 </nav>
1631 </li>
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1646
1647
1648 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
1649
1650 <label class="md-nav__link" for="__nav_7">
1651 Tutorials
1652 <span class="md-nav__icon md-icon"></span>
1653 </label>
1654 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1655 <label class="md-nav__title" for="__nav_7">
1656 <span class="md-nav__icon md-icon"></span>
1657 Tutorials
1658 </label>
1659 <ul class="md-nav__list" data-md-scrollfix>
1660
1661
1662
1663
1664
1665
1666
1667
1668 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1669
1670
1671 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" checked>
1672
1673 <label class="md-nav__link" for="__nav_7_1">
1674 Tutorial Series
1675 <span class="md-nav__icon md-icon"></span>
1676 </label>
1677 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1678 <label class="md-nav__title" for="__nav_7_1">
1679 <span class="md-nav__icon md-icon"></span>
1680 Tutorial Series
1681 </label>
1682 <ul class="md-nav__list" data-md-scrollfix>
1683
1684
1685
1686
1687
1688 <li class="md-nav__item">
1689 <a href="../overview/" class="md-nav__link">
1690 Overview
1691 </a>
1692 </li>
1693
1694
1695
1696
1697
1698
1699
1700 <li class="md-nav__item">
1701 <a href="../part_1/" class="md-nav__link">
1702 Part 1
1703 </a>
1704 </li>
1705
1706
1707
1708
1709
1710
1711
1712 <li class="md-nav__item">
1713 <a href="../part_2/" class="md-nav__link">
1714 Part 2
1715 </a>
1716 </li>
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726 <li class="md-nav__item md-nav__item--active">
1727
1728 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1729
1730
1731
1732
1733 <label class="md-nav__link md-nav__link--active" for="__toc">
1734 Part 3
1735 <span class="md-nav__icon md-icon"></span>
1736 </label>
1737
1738 <a href="./" class="md-nav__link md-nav__link--active">
1739 Part 3
1740 </a>
1741
1742
1743 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1744
1745
1746
1747
1748
1749 <label class="md-nav__title" for="__toc">
1750 <span class="md-nav__icon md-icon"></span>
1751 Table of contents
1752 </label>
1753 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1754
1755 <li class="md-nav__item">
1756 <a href="#package-functionality" class="md-nav__link">
1757 Package Functionality
1758 </a>
1759
1760 </li>
1761
1762 <li class="md-nav__item">
1763 <a href="#used-components" class="md-nav__link">
1764 Used Components
1765 </a>
1766
1767 </li>
1768
1769 <li class="md-nav__item">
1770 <a href="#package-structure" class="md-nav__link">
1771 Package Structure
1772 </a>
1773
1774 </li>
1775
1776 <li class="md-nav__item">
1777 <a href="#runtime-cache" class="md-nav__link">
1778 Runtime Cache
1779 </a>
1780
1781 </li>
1782
1783 <li class="md-nav__item">
1784 <a href="#comments" class="md-nav__link">
1785 Comments
1786 </a>
1787
1788 </li>
1789
1790 <li class="md-nav__item">
1791 <a href="#person-page" class="md-nav__link">
1792 Person Page
1793 </a>
1794
1795 <nav class="md-nav" aria-label="Person Page">
1796 <ul class="md-nav__list">
1797
1798 <li class="md-nav__item">
1799 <a href="#personpage" class="md-nav__link">
1800 PersonPage
1801 </a>
1802
1803 </li>
1804
1805 <li class="md-nav__item">
1806 <a href="#persontpl" class="md-nav__link">
1807 person.tpl
1808 </a>
1809
1810 </li>
1811
1812 <li class="md-nav__item">
1813 <a href="#pagexml" class="md-nav__link">
1814 page.xml
1815 </a>
1816
1817 </li>
1818
1819 <li class="md-nav__item">
1820 <a href="#personpagehandler" class="md-nav__link">
1821 PersonPageHandler
1822 </a>
1823
1824 </li>
1825
1826 </ul>
1827 </nav>
1828
1829 </li>
1830
1831 </ul>
1832
1833 </nav>
1834
1835 </li>
1836
1837
1838
1839 </ul>
1840 </nav>
1841 </li>
1842
1843
1844
1845 </ul>
1846 </nav>
1847 </li>
1848
1849
1850
1851 </ul>
1852 </nav>
1853 </div>
1854 </div>
1855 </div>
1856
1857
1858
1859 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1860 <div class="md-sidebar__scrollwrap">
1861 <div class="md-sidebar__inner">
1862
1863 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1864
1865
1866
1867
1868
1869 <label class="md-nav__title" for="__toc">
1870 <span class="md-nav__icon md-icon"></span>
1871 Table of contents
1872 </label>
1873 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1874
1875 <li class="md-nav__item">
1876 <a href="#package-functionality" class="md-nav__link">
1877 Package Functionality
1878 </a>
1879
1880 </li>
1881
1882 <li class="md-nav__item">
1883 <a href="#used-components" class="md-nav__link">
1884 Used Components
1885 </a>
1886
1887 </li>
1888
1889 <li class="md-nav__item">
1890 <a href="#package-structure" class="md-nav__link">
1891 Package Structure
1892 </a>
1893
1894 </li>
1895
1896 <li class="md-nav__item">
1897 <a href="#runtime-cache" class="md-nav__link">
1898 Runtime Cache
1899 </a>
1900
1901 </li>
1902
1903 <li class="md-nav__item">
1904 <a href="#comments" class="md-nav__link">
1905 Comments
1906 </a>
1907
1908 </li>
1909
1910 <li class="md-nav__item">
1911 <a href="#person-page" class="md-nav__link">
1912 Person Page
1913 </a>
1914
1915 <nav class="md-nav" aria-label="Person Page">
1916 <ul class="md-nav__list">
1917
1918 <li class="md-nav__item">
1919 <a href="#personpage" class="md-nav__link">
1920 PersonPage
1921 </a>
1922
1923 </li>
1924
1925 <li class="md-nav__item">
1926 <a href="#persontpl" class="md-nav__link">
1927 person.tpl
1928 </a>
1929
1930 </li>
1931
1932 <li class="md-nav__item">
1933 <a href="#pagexml" class="md-nav__link">
1934 page.xml
1935 </a>
1936
1937 </li>
1938
1939 <li class="md-nav__item">
1940 <a href="#personpagehandler" class="md-nav__link">
1941 PersonPageHandler
1942 </a>
1943
1944 </li>
1945
1946 </ul>
1947 </nav>
1948
1949 </li>
1950
1951 </ul>
1952
1953 </nav>
1954 </div>
1955 </div>
1956 </div>
1957
1958
1959 <div class="md-content" data-md-component="content">
1960 <article class="md-content__inner md-typeset">
1961
1962
1963 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/part_3.md" title="Edit this page" class="md-content__button md-icon">
1964 <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>
1965 </a>
1966
1967
1968 <h1 id="tutorial-series-part-3-person-page-and-comments">Tutorial Series Part 3: Person Page and Comments<a class="headerlink" href="#tutorial-series-part-3-person-page-and-comments" title="Permanent link">#</a></h1>
1969 <p>In this part of our tutorial series, we will add a new front end page to our package that is dedicated to each person and shows their personal details.
1970 To make good use of this new page and introduce a new API of WoltLab Suite, we will add the opportunity for users to comment on the person using WoltLab Suite’s reusable comment functionality.</p>
1971 <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
1972 <p>In addition to the existing functions from <a href="../part_1/">part 1</a>, the package will provide the following possibilities/functions after this part of the tutorial:</p>
1973 <ul>
1974 <li>Details page for each person linked in the front end person list</li>
1975 <li>Comment on people on their respective page (can be disabled per person)</li>
1976 <li>User online location for person details page with name and link to person details page</li>
1977 <li>Create menu items linking to specific person details pages</li>
1978 </ul>
1979 <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2>
1980 <p>In addition to the components used in <a href="../part_1/">part 1</a>, we will use the <a href="../../../package/pip/object-type/">objectType package installation plugin</a>, use the <a href="../../../php/api/comments/">comment API</a>, create a <a href="../../../php/api/caches_runtime-caches/">runtime cache</a>, and create a page handler.</p>
1981 <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
1982 <p>The complete package will have the following file structure (including the files from <a href="../part_1/">part 1</a>):</p>
1983 <div class="highlight"><pre><span></span><code>├── acpMenu.xml
1984 ├── acptemplates
1985 │ ├── personAdd.tpl
1986 │ └── personList.tpl
1987 ├── files
1988 │ └── lib
1989 │ ├── acp
1990 │ │ ├── form
1991 │ │ │ ├── PersonAddForm.class.php
1992 │ │ │ └── PersonEditForm.class.php
1993 │ │ └── page
1994 │ │ └── PersonListPage.class.php
1995 │ ├── data
1996 │ │ └── person
1997 │ │ ├── Person.class.php
1998 │ │ ├── PersonAction.class.php
1999 │ │ ├── PersonEditor.class.php
2000 │ │ └── PersonList.class.php
2001 │ ├── page
2002 │ │ ├── PersonListPage.class.php
2003 │ │ └── PersonPage.class.php
2004 │ └── system
2005 │ ├── cache
2006 │ │ └── runtime
2007 │ │ └── PersonRuntimeCache.class.php
2008 │ ├── comment
2009 │ │ └── manager
2010 │ │ └── PersonCommentManager.class.php
2011 │ └── page
2012 │ └── handler
2013 │ └── PersonPageHandler.class.php
2014 ├── install.sql
2015 ├── language
2016 │ ├── de.xml
2017 │ └── en.xml
2018 ├── menuItem.xml
2019 ├── objectType.xml
2020 ├── package.xml
2021 ├── page.xml
2022 ├── templates
2023 │ ├── person.tpl
2024 │ └── personList.tpl
2025 └── userGroupOption.xml
2026 </code></pre></div>
2027 <div class="admonition warning">
2028 <p class="admonition-title">We will not mention every code change between the first part and this part, as we only want to focus on the important, new parts of the code. For example, there is a new <code>Person::getLink()</code> method and new language items have been added. For all changes, please refer to the <a href="https://github.com/WoltLab/woltlab.github.io/tree/master/_includes/tutorial/tutorial-series/part-3">source code on GitHub</a>.</p>
2029 </div>
2030 <h2 id="runtime-cache">Runtime Cache<a class="headerlink" href="#runtime-cache" title="Permanent link">#</a></h2>
2031 <p>To reduce the number of database queries when different APIs require person objects, we implement a <a href="../../../php/api/caches_runtime-caches/">runtime cache</a> for people:</p>
2032 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2033 <span class="k">namespace</span> <span class="nx">wcf\system\cache\runtime</span><span class="p">;</span>
2034 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
2035 <span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
2036
2037 <span class="sd">/**</span>
2038 <span class="sd"> * Runtime cache implementation for people.</span>
2039 <span class="sd"> *</span>
2040 <span class="sd"> * @author Matthias Schmidt</span>
2041 <span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2042 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2043 <span class="sd"> * @package WoltLabSuite\Core\System\Cache\Runtime</span>
2044 <span class="sd"> * @since 3.0</span>
2045 <span class="sd"> *</span>
2046 <span class="sd"> * @method Person[] getCachedObjects()</span>
2047 <span class="sd"> * @method Person getObject($objectID)</span>
2048 <span class="sd"> * @method Person[] getObjects(array $objectIDs)</span>
2049 <span class="sd"> */</span>
2050 <span class="k">class</span> <span class="nc">PersonRuntimeCache</span> <span class="k">extends</span> <span class="nx">AbstractRuntimeCache</span> <span class="p">{</span>
2051 <span class="sd">/**</span>
2052 <span class="sd"> * @inheritDoc</span>
2053 <span class="sd"> */</span>
2054 <span class="k">protected</span> <span class="nv">$listClassName</span> <span class="o">=</span> <span class="nx">PersonList</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2055 <span class="p">}</span>
2056 </code></pre></div>
2057 <h2 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h2>
2058 <p>To allow users to comment on people, we need to tell the system that people support comments.
2059 This is done by registering a <code>com.woltlab.wcf.comment.commentableContent</code> object type whose processor implements <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php">ICommentManager</a>:</p>
2060 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2061 <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/tornado/objectType.xsd&quot;</span><span class="nt">&gt;</span>
2062 <span class="nt">&lt;import&gt;</span>
2063 <span class="nt">&lt;type&gt;</span>
2064 <span class="nt">&lt;name&gt;</span>com.woltlab.wcf.person.personComment<span class="nt">&lt;/name&gt;</span>
2065 <span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.comment.commentableContent<span class="nt">&lt;/definitionname&gt;</span>
2066 <span class="nt">&lt;classname&gt;</span>wcf\system\comment\manager\PersonCommentManager<span class="nt">&lt;/classname&gt;</span>
2067 <span class="nt">&lt;/type&gt;</span>
2068 <span class="nt">&lt;/import&gt;</span>
2069 <span class="nt">&lt;/data&gt;</span>
2070 </code></pre></div>
2071 <p>The <code>PersonCommentManager</code> class extended <code>ICommentManager</code>’s default implementation <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/comment/manager/AbstractCommentManager.class.php">AbstractCommentManager</a>:</p>
2072 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2073 <span class="k">namespace</span> <span class="nx">wcf\system\comment\manager</span><span class="p">;</span>
2074 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
2075 <span class="k">use</span> <span class="nx">wcf\data\person\PersonEditor</span><span class="p">;</span>
2076 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
2077 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2078
2079 <span class="sd">/**</span>
2080 <span class="sd"> * Comment manager implementation for people.</span>
2081 <span class="sd"> *</span>
2082 <span class="sd"> * @author Matthias Schmidt</span>
2083 <span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2084 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2085 <span class="sd"> * @package WoltLabSuite\Core\System\Comment\Manager</span>
2086 <span class="sd"> */</span>
2087 <span class="k">class</span> <span class="nc">PersonCommentManager</span> <span class="k">extends</span> <span class="nx">AbstractCommentManager</span> <span class="p">{</span>
2088 <span class="sd">/**</span>
2089 <span class="sd"> * @inheritDoc</span>
2090 <span class="sd"> */</span>
2091 <span class="k">protected</span> <span class="nv">$permissionAdd</span> <span class="o">=</span> <span class="s1">&#39;user.person.canAddComment&#39;</span><span class="p">;</span>
2092
2093 <span class="sd">/**</span>
2094 <span class="sd"> * @inheritDoc</span>
2095 <span class="sd"> */</span>
2096 <span class="k">protected</span> <span class="nv">$permissionAddWithoutModeration</span> <span class="o">=</span> <span class="s1">&#39;user.person.canAddCommentWithoutModeration&#39;</span><span class="p">;</span>
2097
2098 <span class="sd">/**</span>
2099 <span class="sd"> * @inheritDoc</span>
2100 <span class="sd"> */</span>
2101 <span class="k">protected</span> <span class="nv">$permissionCanModerate</span> <span class="o">=</span> <span class="s1">&#39;mod.person.canModerateComment&#39;</span><span class="p">;</span>
2102
2103 <span class="sd">/**</span>
2104 <span class="sd"> * @inheritDoc</span>
2105 <span class="sd"> */</span>
2106 <span class="k">protected</span> <span class="nv">$permissionDelete</span> <span class="o">=</span> <span class="s1">&#39;user.person.canDeleteComment&#39;</span><span class="p">;</span>
2107
2108 <span class="sd">/**</span>
2109 <span class="sd"> * @inheritDoc</span>
2110 <span class="sd"> */</span>
2111 <span class="k">protected</span> <span class="nv">$permissionEdit</span> <span class="o">=</span> <span class="s1">&#39;user.person.canEditComment&#39;</span><span class="p">;</span>
2112
2113 <span class="sd">/**</span>
2114 <span class="sd"> * @inheritDoc</span>
2115 <span class="sd"> */</span>
2116 <span class="k">protected</span> <span class="nv">$permissionModDelete</span> <span class="o">=</span> <span class="s1">&#39;mod.person.canDeleteComment&#39;</span><span class="p">;</span>
2117
2118 <span class="sd">/**</span>
2119 <span class="sd"> * @inheritDoc</span>
2120 <span class="sd"> */</span>
2121 <span class="k">protected</span> <span class="nv">$permissionModEdit</span> <span class="o">=</span> <span class="s1">&#39;mod.person.canEditComment&#39;</span><span class="p">;</span>
2122
2123 <span class="sd">/**</span>
2124 <span class="sd"> * @inheritDoc</span>
2125 <span class="sd"> */</span>
2126 <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">)</span> <span class="p">{</span>
2127 <span class="k">return</span> <span class="nx">PersonRuntimeCache</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">$objectID</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">();</span>
2128 <span class="p">}</span>
2129
2130 <span class="sd">/**</span>
2131 <span class="sd"> * @inheritDoc</span>
2132 <span class="sd"> */</span>
2133 <span class="k">public</span> <span class="k">function</span> <span class="nf">isAccessible</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$validateWritePermission</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span> <span class="p">{</span>
2134 <span class="k">return</span> <span class="nx">PersonRuntimeCache</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">$objectID</span><span class="p">)</span> <span class="o">!==</span> <span class="k">null</span><span class="p">;</span>
2135 <span class="p">}</span>
2136
2137 <span class="sd">/**</span>
2138 <span class="sd"> * @inheritDoc</span>
2139 <span class="sd"> */</span>
2140 <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">(</span><span class="nv">$objectTypeID</span><span class="p">,</span> <span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$isResponse</span> <span class="o">=</span> <span class="k">false</span><span class="p">)</span> <span class="p">{</span>
2141 <span class="k">if</span> <span class="p">(</span><span class="nv">$isResponse</span><span class="p">)</span> <span class="p">{</span>
2142 <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</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;wcf.person.commentResponse&#39;</span><span class="p">);</span>
2143 <span class="p">}</span>
2144
2145 <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</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;wcf.person.comment&#39;</span><span class="p">);</span>
2146 <span class="p">}</span>
2147
2148 <span class="sd">/**</span>
2149 <span class="sd"> * @inheritDoc</span>
2150 <span class="sd"> */</span>
2151 <span class="k">public</span> <span class="k">function</span> <span class="nf">updateCounter</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">,</span> <span class="nv">$value</span><span class="p">)</span> <span class="p">{</span>
2152 <span class="p">(</span><span class="k">new</span> <span class="nx">PersonEditor</span><span class="p">(</span><span class="k">new</span> <span class="nx">Person</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)))</span><span class="o">-&gt;</span><span class="na">updateCounters</span><span class="p">([</span><span class="s1">&#39;comments&#39;</span> <span class="o">=&gt;</span> <span class="nv">$value</span><span class="p">]);</span>
2153 <span class="p">}</span>
2154 <span class="p">}</span>
2155 </code></pre></div>
2156 <ul>
2157 <li>First, the system is told the names of the permissions via the <code>$permission*</code> properties.
2158 More information about comment permissions can be found <a href="../../../php/api/comments/#user-group-options">here</a>.</li>
2159 <li>The <code>getLink()</code> method returns the link to the person with the passed comment id.
2160 As in <code>isAccessible()</code>, <code>PersonRuntimeCache</code> is used to potentially save database queries.</li>
2161 <li>The <code>isAccessible()</code> method checks if the active user can access the relevant person.
2162 As we do not have any special restrictions for accessing people, we only need to check if the person exists.</li>
2163 <li>The <code>getTitle()</code> method returns the title used for comments and responses, which is just a generic language item in this case.</li>
2164 <li>The <code>updateCounter()</code> updates the comments’ counter of the person.
2165 We have added a new <code>comments</code> database table column to the <code>wcf1_person</code> database table in order to keep track on the number of comments.</li>
2166 </ul>
2167 <p>Additionally, we have added a new <code>enableComments</code> database table column to the <code>wcf1_person</code> database table whose value can be set when creating or editing a person in the ACP.
2168 With this option, comments on individual people can be disabled.</p>
2169 <div class="admonition info">
2170 <p class="admonition-title">Liking comments is already built-in and only requires some extra code in the <code>PersonPage</code> class for showing the likes of pre-loaded comments.</p>
2171 </div>
2172 <h2 id="person-page">Person Page<a class="headerlink" href="#person-page" title="Permanent link">#</a></h2>
2173 <h3 id="personpage"><code>PersonPage</code><a class="headerlink" href="#personpage" title="Permanent link">#</a></h3>
2174 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2175 <span class="k">namespace</span> <span class="nx">wcf\page</span><span class="p">;</span>
2176 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
2177 <span class="k">use</span> <span class="nx">wcf\system\comment\CommentHandler</span><span class="p">;</span>
2178 <span class="k">use</span> <span class="nx">wcf\system\comment\manager\PersonCommentManager</span><span class="p">;</span>
2179 <span class="k">use</span> <span class="nx">wcf\system\exception\IllegalLinkException</span><span class="p">;</span>
2180 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2181
2182 <span class="sd">/**</span>
2183 <span class="sd"> * Shows the details of a certain person.</span>
2184 <span class="sd"> * </span>
2185 <span class="sd"> * @author Matthias Schmidt</span>
2186 <span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2187 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2188 <span class="sd"> * @package WoltLabSuite\Core\Page</span>
2189 <span class="sd"> */</span>
2190 <span class="k">class</span> <span class="nc">PersonPage</span> <span class="k">extends</span> <span class="nx">AbstractPage</span> <span class="p">{</span>
2191 <span class="sd">/**</span>
2192 <span class="sd"> * list of comments</span>
2193 <span class="sd"> * @var StructuredCommentList</span>
2194 <span class="sd"> */</span>
2195 <span class="k">public</span> <span class="nv">$commentList</span><span class="p">;</span>
2196
2197 <span class="sd">/**</span>
2198 <span class="sd"> * person comment manager object</span>
2199 <span class="sd"> * @var PersonCommentManager</span>
2200 <span class="sd"> */</span>
2201 <span class="k">public</span> <span class="nv">$commentManager</span><span class="p">;</span>
2202
2203 <span class="sd">/**</span>
2204 <span class="sd"> * id of the person comment object type</span>
2205 <span class="sd"> * @var integer</span>
2206 <span class="sd"> */</span>
2207 <span class="k">public</span> <span class="nv">$commentObjectTypeID</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
2208
2209 <span class="sd">/**</span>
2210 <span class="sd"> * shown person</span>
2211 <span class="sd"> * @var Person</span>
2212 <span class="sd"> */</span>
2213 <span class="k">public</span> <span class="nv">$person</span><span class="p">;</span>
2214
2215 <span class="sd">/**</span>
2216 <span class="sd"> * id of the shown person</span>
2217 <span class="sd"> * @var integer</span>
2218 <span class="sd"> */</span>
2219 <span class="k">public</span> <span class="nv">$personID</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
2220
2221 <span class="sd">/**</span>
2222 <span class="sd"> * @inheritDoc</span>
2223 <span class="sd"> */</span>
2224 <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
2225 <span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
2226
2227 <span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">assign</span><span class="p">([</span>
2228 <span class="s1">&#39;commentCanAdd&#39;</span> <span class="o">=&gt;</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getSession</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getPermission</span><span class="p">(</span><span class="s1">&#39;user.person.canAddComment&#39;</span><span class="p">),</span>
2229 <span class="s1">&#39;commentList&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span><span class="p">,</span>
2230 <span class="s1">&#39;commentObjectTypeID&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentObjectTypeID</span><span class="p">,</span>
2231 <span class="s1">&#39;lastCommentTime&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span> <span class="o">?</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span><span class="o">-&gt;</span><span class="na">getMinCommentTime</span><span class="p">()</span> <span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
2232 <span class="s1">&#39;likeData&#39;</span> <span class="o">=&gt;</span> <span class="p">(</span><span class="nx">MODULE_LIKE</span> <span class="o">&amp;&amp;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span><span class="p">)</span> <span class="o">?</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span><span class="o">-&gt;</span><span class="na">getLikeData</span><span class="p">()</span> <span class="o">:</span> <span class="p">[],</span>
2233 <span class="s1">&#39;person&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span>
2234 <span class="p">]);</span>
2235 <span class="p">}</span>
2236
2237 <span class="sd">/**</span>
2238 <span class="sd"> * @inheritDoc</span>
2239 <span class="sd"> */</span>
2240 <span class="k">public</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">()</span> <span class="p">{</span>
2241 <span class="k">parent</span><span class="o">::</span><span class="na">readData</span><span class="p">();</span>
2242
2243 <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span><span class="o">-&gt;</span><span class="na">enableComments</span><span class="p">)</span> <span class="p">{</span>
2244 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentObjectTypeID</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getObjectTypeID</span><span class="p">(</span><span class="s1">&#39;com.woltlab.wcf.person.personComment&#39;</span><span class="p">);</span>
2245 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentManager</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getObjectType</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentObjectTypeID</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">getProcessor</span><span class="p">();</span>
2246 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentList</span> <span class="o">=</span> <span class="nx">CommentHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getCommentList</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentManager</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">commentObjectTypeID</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">);</span>
2247 <span class="p">}</span>
2248 <span class="p">}</span>
2249
2250 <span class="sd">/**</span>
2251 <span class="sd"> * @inheritDoc</span>
2252 <span class="sd"> */</span>
2253 <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
2254 <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
2255
2256 <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">personID</span> <span class="o">=</span> <span class="nb">intval</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]);</span>
2257 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Person</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">);</span>
2258 <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">person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">)</span> <span class="p">{</span>
2259 <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
2260 <span class="p">}</span>
2261 <span class="p">}</span>
2262 <span class="p">}</span>
2263 </code></pre></div>
2264 <p>The <code>PersonPage</code> class is similar to the <code>PersonEditForm</code> in the ACP in that it reads the id of the requested person from the request data and validates the id in <code>readParameters()</code>.
2265 The rest of the code only handles fetching the list of comments on the requested person.
2266 In <code>readData()</code>, this list is fetched using <code>CommentHandler::getCommentList()</code> if comments are enabled for the person.
2267 The <code>assignVariables()</code> method assigns some additional template variables like <code>$commentCanAdd</code>, which is <code>1</code> if the active person can add comments and is <code>0</code> otherwise, <code>$lastCommentTime</code>, which contains the UNIX timestamp of the last comment, and <code>$likeData</code>, which contains data related to the likes for the disabled comments.</p>
2268 <h3 id="persontpl"><code>person.tpl</code><a class="headerlink" href="#persontpl" title="Permanent link">#</a></h3>
2269 <div class="highlight"><pre><span></span><code>{capture assign=&#39;pageTitle&#39;}{$person} - {lang}wcf.person.list{/lang}{/capture}
2270
2271 {capture assign=&#39;contentTitle&#39;}{$person}{/capture}
2272
2273 {include file=&#39;header&#39;}
2274
2275 {if $person-&gt;enableComments}
2276 {if $commentList|count || $commentCanAdd}
2277 &lt;section id=&quot;comments&quot; class=&quot;section sectionContainerList&quot;&gt;
2278 &lt;header class=&quot;sectionHeader&quot;&gt;
2279 &lt;h2 class=&quot;sectionTitle&quot;&gt;{lang}wcf.person.comments{/lang}{if $person-&gt;comments} &lt;span class=&quot;badge&quot;&gt;{#$person-&gt;comments}&lt;/span&gt;{/if}&lt;/h2&gt;
2280 &lt;/header&gt;
2281
2282 {include file=&#39;__commentJavaScript&#39; commentContainerID=&#39;personCommentList&#39;}
2283
2284 &lt;div class=&quot;personComments&quot;&gt;
2285 &lt;ul id=&quot;personCommentList&quot; class=&quot;commentList containerList&quot;
2286 data-can-add=&quot;{if $commentCanAdd}true{else}false{/if}&quot;
2287 data-object-id=&quot;{@$person-&gt;personID}&quot;
2288 data-object-type-id=&quot;{@$commentObjectTypeID}&quot;
2289 data-comments=&quot;{if $person-&gt;comments}{@$commentList-&gt;countObjects()}{else}0{/if}&quot;
2290 data-last-comment-time=&quot;{@$lastCommentTime}&quot;
2291 &gt;
2292 {include file=&#39;commentListAddComment&#39; wysiwygSelector=&#39;personCommentListAddComment&#39;}
2293 {include file=&#39;commentList&#39;}
2294 &lt;/ul&gt;
2295 &lt;/div&gt;
2296 &lt;/section&gt;
2297 {/if}
2298 {/if}
2299
2300 &lt;footer class=&quot;contentFooter&quot;&gt;
2301 {hascontent}
2302 &lt;nav class=&quot;contentFooterNavigation&quot;&gt;
2303 &lt;ul&gt;
2304 {content}{event name=&#39;contentFooterNavigation&#39;}{/content}
2305 &lt;/ul&gt;
2306 &lt;/nav&gt;
2307 {/hascontent}
2308 &lt;/footer&gt;
2309
2310 {include file=&#39;footer&#39;}
2311 </code></pre></div>
2312 <p>For now, the <code>person</code> template is still very empty and only shows the comments in the content area.
2313 The template code shown for comments is very generic and used in this form in many locations as it only sets the header of the comment list and the container <code>ul#personCommentList</code> element for the comments shown by <code>commentList</code> template.
2314 The <code>ul#personCommentList</code> elements has five additional <code>data-</code> attributes required by the JavaScript API for comments for loading more comments or creating new ones.
2315 The <code>commentListAddComment</code> template adds the WYSIWYG support.
2316 The attribute <code>wysiwygSelector</code> should be the id of the comment list <code>personCommentList</code> with an additional <code>AddComment</code> suffix.</p>
2317 <h3 id="pagexml"><code>page.xml</code><a class="headerlink" href="#pagexml" title="Permanent link">#</a></h3>
2318 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2319 <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/tornado/page.xsd&quot;</span><span class="nt">&gt;</span>
2320 <span class="nt">&lt;import&gt;</span>
2321 <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.people.PersonList&quot;</span><span class="nt">&gt;</span>
2322 <span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
2323 <span class="nt">&lt;controller&gt;</span>wcf\page\PersonListPage<span class="nt">&lt;/controller&gt;</span>
2324 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Personen-Liste<span class="nt">&lt;/name&gt;</span>
2325 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Person List<span class="nt">&lt;/name&gt;</span>
2326
2327 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>
2328 <span class="nt">&lt;title&gt;</span>Personen<span class="nt">&lt;/title&gt;</span>
2329 <span class="nt">&lt;/content&gt;</span>
2330 <span class="nt">&lt;content</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>
2331 <span class="nt">&lt;title&gt;</span>People<span class="nt">&lt;/title&gt;</span>
2332 <span class="nt">&lt;/content&gt;</span>
2333 <span class="nt">&lt;/page&gt;</span>
2334 <span class="nt">&lt;page</span> <span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.people.Person&quot;</span><span class="nt">&gt;</span>
2335 <span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
2336 <span class="nt">&lt;controller&gt;</span>wcf\page\PersonPage<span class="nt">&lt;/controller&gt;</span>
2337 <span class="nt">&lt;handler&gt;</span>wcf\system\page\handler\PersonPageHandler<span class="nt">&lt;/handler&gt;</span>
2338 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>Person<span class="nt">&lt;/name&gt;</span>
2339 <span class="nt">&lt;name</span> <span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Person<span class="nt">&lt;/name&gt;</span>
2340 <span class="nt">&lt;requireObjectID&gt;</span>1<span class="nt">&lt;/requireObjectID&gt;</span>
2341 <span class="nt">&lt;parent&gt;</span>com.woltlab.wcf.people.PersonList<span class="nt">&lt;/parent&gt;</span>
2342 <span class="nt">&lt;/page&gt;</span>
2343 <span class="nt">&lt;/import&gt;</span>
2344 <span class="nt">&lt;/data&gt;</span>
2345 </code></pre></div>
2346 <p>The <code>page.xml</code> file has been extended for the new person page with identifier <code>com.woltlab.wcf.people.Person</code>.
2347 Compared to the pre-existing <code>com.woltlab.wcf.people.PersonList</code> page, there are four differences:</p>
2348 <ol>
2349 <li>It has a <code>&lt;handler&gt;</code> element with a class name as value.
2350 This aspect will be discussed in more detail in the next section.</li>
2351 <li>There are no <code>&lt;content&gt;</code> elements because, both, the title and the content of the page are dynamically generated in the template.</li>
2352 <li>The <code>&lt;requireObjectID&gt;</code> tells the system that this page requires an object id to properly work, in this case a valid person id.</li>
2353 <li>This page has a <code>&lt;parent&gt;</code> page, the person list page.
2354 In general, the details page for any type of object that is listed on a different page has the list page as its parent.</li>
2355 </ol>
2356 <h3 id="personpagehandler"><code>PersonPageHandler</code><a class="headerlink" href="#personpagehandler" title="Permanent link">#</a></h3>
2357 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2358 <span class="k">namespace</span> <span class="nx">wcf\system\page\handler</span><span class="p">;</span>
2359 <span class="k">use</span> <span class="nx">wcf\data\page\Page</span><span class="p">;</span>
2360 <span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
2361 <span class="k">use</span> <span class="nx">wcf\data\user\online\UserOnline</span><span class="p">;</span>
2362 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
2363 <span class="k">use</span> <span class="nx">wcf\system\database\util\PreparedStatementConditionBuilder</span><span class="p">;</span>
2364 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2365
2366 <span class="sd">/**</span>
2367 <span class="sd"> * Page handler implementation for person page.</span>
2368 <span class="sd"> * </span>
2369 <span class="sd"> * @author Matthias Schmidt</span>
2370 <span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2371 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2372 <span class="sd"> * @package WoltLabSuite\Core\System\Page\Handler</span>
2373 <span class="sd"> */</span>
2374 <span class="k">class</span> <span class="nc">PersonPageHandler</span> <span class="k">extends</span> <span class="nx">AbstractLookupPageHandler</span> <span class="k">implements</span> <span class="nx">IOnlineLocationPageHandler</span> <span class="p">{</span>
2375 <span class="k">use</span> <span class="nx">TOnlineLocationPageHandler</span><span class="p">;</span>
2376
2377 <span class="sd">/**</span>
2378 <span class="sd"> * @inheritDoc</span>
2379 <span class="sd"> */</span>
2380 <span class="k">public</span> <span class="k">function</span> <span class="nf">getLink</span><span class="p">(</span><span class="nv">$objectID</span><span class="p">)</span> <span class="p">{</span>
2381 <span class="k">return</span> <span class="nx">PersonRuntimeCache</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">$objectID</span><span class="p">)</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">();</span>
2382 <span class="p">}</span>
2383
2384 <span class="sd">/**</span>
2385 <span class="sd"> * Returns the textual description if a user is currently online viewing this page.</span>
2386 <span class="sd"> *</span>
2387 <span class="sd"> * @see IOnlineLocationPageHandler::getOnlineLocation()</span>
2388 <span class="sd"> *</span>
2389 <span class="sd"> * @param Page $page visited page</span>
2390 <span class="sd"> * @param UserOnline $user user online object with request data</span>
2391 <span class="sd"> * @return string</span>
2392 <span class="sd"> */</span>
2393 <span class="k">public</span> <span class="k">function</span> <span class="nf">getOnlineLocation</span><span class="p">(</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span> <span class="p">{</span>
2394 <span class="k">if</span> <span class="p">(</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">pageObjectID</span> <span class="o">===</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
2395 <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
2396 <span class="p">}</span>
2397
2398 <span class="nv">$person</span> <span class="o">=</span> <span class="nx">PersonRuntimeCache</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">$user</span><span class="o">-&gt;</span><span class="na">pageObjectID</span><span class="p">);</span>
2399 <span class="k">if</span> <span class="p">(</span><span class="nv">$person</span> <span class="o">===</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
2400 <span class="k">return</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
2401 <span class="p">}</span>
2402
2403 <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</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;wcf.page.onlineLocation.&#39;</span><span class="o">.</span><span class="nv">$page</span><span class="o">-&gt;</span><span class="na">identifier</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;person&#39;</span> <span class="o">=&gt;</span> <span class="nv">$person</span><span class="p">]);</span>
2404 <span class="p">}</span>
2405
2406 <span class="sd">/**</span>
2407 <span class="sd"> * @inheritDoc</span>
2408 <span class="sd"> */</span>
2409 <span class="k">public</span> <span class="k">function</span> <span class="nf">isValid</span><span class="p">(</span><span class="nv">$objectID</span> <span class="o">=</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
2410 <span class="k">return</span> <span class="nx">PersonRuntimeCache</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">$objectID</span><span class="p">)</span> <span class="o">!==</span> <span class="k">null</span><span class="p">;</span>
2411 <span class="p">}</span>
2412
2413 <span class="sd">/**</span>
2414 <span class="sd"> * @inheritDoc</span>
2415 <span class="sd"> */</span>
2416 <span class="k">public</span> <span class="k">function</span> <span class="nf">lookup</span><span class="p">(</span><span class="nv">$searchString</span><span class="p">)</span> <span class="p">{</span>
2417 <span class="nv">$conditionBuilder</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PreparedStatementConditionBuilder</span><span class="p">(</span><span class="k">false</span><span class="p">,</span> <span class="s1">&#39;OR&#39;</span><span class="p">);</span>
2418 <span class="nv">$conditionBuilder</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="s1">&#39;person.firstName LIKE ?&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;%&#39;</span> <span class="o">.</span> <span class="nv">$searchString</span> <span class="o">.</span> <span class="s1">&#39;%&#39;</span><span class="p">]);</span>
2419 <span class="nv">$conditionBuilder</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="s1">&#39;person.lastName LIKE ?&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;%&#39;</span> <span class="o">.</span> <span class="nv">$searchString</span> <span class="o">.</span> <span class="s1">&#39;%&#39;</span><span class="p">]);</span>
2420
2421 <span class="nv">$personList</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PersonList</span><span class="p">();</span>
2422 <span class="nv">$personList</span><span class="o">-&gt;</span><span class="na">getConditionBuilder</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="nv">$conditionBuilder</span><span class="p">,</span> <span class="nv">$conditionBuilder</span><span class="o">-&gt;</span><span class="na">getParameters</span><span class="p">());</span>
2423 <span class="nv">$personList</span><span class="o">-&gt;</span><span class="na">readObjects</span><span class="p">();</span>
2424
2425 <span class="nv">$results</span> <span class="o">=</span> <span class="p">[];</span>
2426 <span class="k">foreach</span> <span class="p">(</span><span class="nv">$personList</span> <span class="k">as</span> <span class="nv">$person</span><span class="p">)</span> <span class="p">{</span>
2427 <span class="nv">$results</span><span class="p">[]</span> <span class="o">=</span> <span class="p">[</span>
2428 <span class="s1">&#39;image&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;fa-user&#39;</span><span class="p">,</span>
2429 <span class="s1">&#39;link&#39;</span> <span class="o">=&gt;</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="p">(),</span>
2430 <span class="s1">&#39;objectID&#39;</span> <span class="o">=&gt;</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">,</span>
2431 <span class="s1">&#39;title&#39;</span> <span class="o">=&gt;</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="p">()</span>
2432 <span class="p">];</span>
2433 <span class="p">}</span>
2434
2435 <span class="k">return</span> <span class="nv">$results</span><span class="p">;</span>
2436 <span class="p">}</span>
2437
2438 <span class="sd">/**</span>
2439 <span class="sd"> * Prepares fetching all necessary data for the textual description if a user is currently online</span>
2440 <span class="sd"> * viewing this page.</span>
2441 <span class="sd"> * </span>
2442 <span class="sd"> * @see IOnlineLocationPageHandler::prepareOnlineLocation()</span>
2443 <span class="sd"> *</span>
2444 <span class="sd"> * @param Page $page visited page</span>
2445 <span class="sd"> * @param UserOnline $user user online object with request data</span>
2446 <span class="sd"> */</span>
2447 <span class="k">public</span> <span class="k">function</span> <span class="nf">prepareOnlineLocation</span><span class="p">(</span><span class="sd">/** @noinspection PhpUnusedParameterInspection */</span><span class="nx">Page</span> <span class="nv">$page</span><span class="p">,</span> <span class="nx">UserOnline</span> <span class="nv">$user</span><span class="p">)</span> <span class="p">{</span>
2448 <span class="k">if</span> <span class="p">(</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">pageObjectID</span> <span class="o">!==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
2449 <span class="nx">PersonRuntimeCache</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">$user</span><span class="o">-&gt;</span><span class="na">pageObjectID</span><span class="p">);</span>
2450 <span class="p">}</span>
2451 <span class="p">}</span>
2452 <span class="p">}</span>
2453 </code></pre></div>
2454 <p>Like any page handler, the <code>PersonPageHandler</code> class has to implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/IMenuPageHandler.class.php">IMenuPageHandler</a> interface, which should be done by extending the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/AbstractMenuPageHandler.class.php">AbstractMenuPageHandler</a> class.
2455 As we want administrators to link to specific people in menus, for example, we have to also implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/ILookupPageHandler.class.php">ILookupPageHandler</a> interface by extending the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/AbstractLookupPageHandler.class.php">AbstractLookupPageHandler</a> class.</p>
2456 <p>For the <code>ILookupPageHandler</code> interface, we need to implement three methods:</p>
2457 <ol>
2458 <li><code>getLink($objectID)</code> returns the link to the person page with the given id.
2459 In this case, we simply delegate this method call to the <code>Person</code> object returned by <code>PersonRuntimeCache::getObject()</code>.</li>
2460 <li><code>isValid($objectID)</code> returns <code>true</code> if the person with the given id exists, otherwise <code>false</code>.
2461 Here, we use <code>PersonRuntimeCache::getObject()</code> again and check if the return value is <code>null</code>, which is the case for non-existing people.</li>
2462 <li><code>lookup($searchString)</code> is used when setting up an internal link and when searching for the linked person.
2463 This method simply searches the first and last name of the people and returns an array with the person data.
2464 While the <code>link</code>, the <code>objectID</code>, and the <code>title</code> element are self-explanatory, the <code>image</code> element can either contain an HTML <code>&lt;img&gt;</code> tag, which is displayed next to the search result (WoltLab Suite uses an image tag for users showing their avatar, for example), or a FontAwesome icon class (starting with <code>fa-</code>).</li>
2465 </ol>
2466 <p>Additionally, the class also implements <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/IOnlineLocationPageHandler.class.php">IOnlineLocationPageHandler</a> which is used to determine the online location of users.
2467 To ensure upwards-compatibility if the <code>IOnlineLocationPageHandler</code> interface changes, the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/page/handler/TOnlineLocationPageHandler.class.php">TOnlineLocationPageHandler</a> trait is used.
2468 The <code>IOnlineLocationPageHandler</code> interface requires two methods to be implemented:</p>
2469 <ol>
2470 <li><code>getOnlineLocation(Page $page, UserOnline $user)</code> returns the textual description of the online location.
2471 The language item for the user online locations should use the pattern <code>wcf.page.onlineLocation.{page identifier}</code>.</li>
2472 <li><code>prepareOnlineLocation(Page $page, UserOnline $user)</code> is called for each user online before the <code>getOnlineLocation()</code> calls.
2473 In this case, calling <code>prepareOnlineLocation()</code> first enables us to add all relevant person ids to the person runtime cache so that for all <code>getOnlineLocation()</code> calls combined, only one database query is necessary to fetch all person objects.</li>
2474 </ol>
2475 <hr />
2476 <p>This concludes the third part of our tutorial series after which each person has a dedicated page on which people can comment on the person.</p>
2477 <p>The complete source code of this part can be found on <a href="https://github.com/WoltLab/woltlab.github.io/tree/master/_includes/tutorial/tutorial-series/part-3">GitHub</a>.</p>
2478
2479
2480
2481
2482 <hr>
2483 <div class="md-source-date">
2484 <small>
2485
2486 Last update: 2021-01-15
2487
2488 </small>
2489 </div>
2490
2491
2492
2493
2494
2495
2496
2497
2498 </article>
2499 </div>
2500 </div>
2501 </main>
2502
2503
2504 <footer class="md-footer">
2505
2506 <nav class="md-footer__inner md-grid" aria-label="Footer">
2507
2508 <a href="../part_2/" class="md-footer__link md-footer__link--prev" rel="prev">
2509 <div class="md-footer__button md-icon">
2510 <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>
2511 </div>
2512 <div class="md-footer__title">
2513 <div class="md-ellipsis">
2514 <span class="md-footer__direction">
2515 Previous
2516 </span>
2517 Part 2
2518 </div>
2519 </div>
2520 </a>
2521
2522
2523 </nav>
2524
2525 <div class="md-footer-meta md-typeset">
2526 <div class="md-footer-meta__inner md-grid">
2527 <div class="md-footer-copyright">
2528
2529 <div class="md-footer-copyright__highlight">
2530 Copyright © 2020 WoltLab GmbH
2531 </div>
2532
2533 Made with
2534 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2535 Material for MkDocs
2536 </a>
2537
2538 </div>
2539 <div class="md-footer-copyright">
2540 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2541 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2542 </div>
2543 </div>
2544 </div>
2545 </footer>
2546
2547 </div>
2548 <div class="md-dialog" data-md-component="dialog">
2549 <div class="md-dialog__inner md-typeset"></div>
2550 </div>
2551 <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.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2552
2553
2554 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2555
2556
2557 </body>
2558 </html>