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