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