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