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