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