5.4/tutorial/series/part_5/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_5/">
  13
  14       <link rel="icon" href="../../../assets/default.favicon.ico">
  15       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.2">
  16
  17
  18
  19         <title>Part 5 - WoltLab Suite Documentation</title>
  20
  21
  22
  23       <link rel="stylesheet" href="../../../assets/stylesheets/main.6f955dcd.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-5-person-information" 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 5
 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     <li class="md-nav__item">
1840       <a href="../part_3/" class="md-nav__link">
1841         Part 3
1842       </a>
1843     </li>
1844
1845
1846
1847
1848
1849
1850
1851     <li class="md-nav__item">
1852       <a href="../part_4/" class="md-nav__link">
1853         Part 4
1854       </a>
1855     </li>
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865     <li class="md-nav__item md-nav__item--active">
1866
1867       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1868
1869
1870
1871
1872
1873         <label class="md-nav__link md-nav__link--active" for="__toc">
1874           Part 5
1875           <span class="md-nav__icon md-icon"></span>
1876         </label>
1877
1878       <a href="./" class="md-nav__link md-nav__link--active">
1879         Part 5
1880       </a>
1881
1882
1883 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1884
1885
1886
1887
1888
1889
1890     <label class="md-nav__title" for="__toc">
1891       <span class="md-nav__icon md-icon"></span>
1892       Table of contents
1893     </label>
1894     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1895
1896         <li class="md-nav__item">
1897   <a href="#package-functionality" class="md-nav__link">
1898     Package Functionality
1899   </a>
1900
1901 </li>
1902
1903         <li class="md-nav__item">
1904   <a href="#used-components" class="md-nav__link">
1905     Used Components
1906   </a>
1907
1908 </li>
1909
1910         <li class="md-nav__item">
1911   <a href="#package-structure" class="md-nav__link">
1912     Package Structure
1913   </a>
1914
1915 </li>
1916
1917         <li class="md-nav__item">
1918   <a href="#miscellaneous" class="md-nav__link">
1919     Miscellaneous
1920   </a>
1921
1922 </li>
1923
1924         <li class="md-nav__item">
1925   <a href="#person-information-model" class="md-nav__link">
1926     Person Information Model
1927   </a>
1928
1929 </li>
1930
1931         <li class="md-nav__item">
1932   <a href="#listing-and-deleting-person-information" class="md-nav__link">
1933     Listing and Deleting Person Information
1934   </a>
1935
1936 </li>
1937
1938         <li class="md-nav__item">
1939   <a href="#creating-and-editing-person-information" class="md-nav__link">
1940     Creating and Editing Person Information
1941   </a>
1942
1943 </li>
1944
1945         <li class="md-nav__item">
1946   <a href="#username-and-ip-address-event-listeners" class="md-nav__link">
1947     Username and IP Address Event Listeners
1948   </a>
1949
1950 </li>
1951
1952     </ul>
1953
1954 </nav>
1955
1956     </li>
1957
1958
1959
1960         </ul>
1961       </nav>
1962     </li>
1963
1964
1965
1966         </ul>
1967       </nav>
1968     </li>
1969
1970
1971
1972   </ul>
1973 </nav>
1974                   </div>
1975                 </div>
1976               </div>
1977
1978
1979
1980               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1981                 <div class="md-sidebar__scrollwrap">
1982                   <div class="md-sidebar__inner">
1983
1984 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1985
1986
1987
1988
1989
1990
1991     <label class="md-nav__title" for="__toc">
1992       <span class="md-nav__icon md-icon"></span>
1993       Table of contents
1994     </label>
1995     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1996
1997         <li class="md-nav__item">
1998   <a href="#package-functionality" class="md-nav__link">
1999     Package Functionality
2000   </a>
2001
2002 </li>
2003
2004         <li class="md-nav__item">
2005   <a href="#used-components" class="md-nav__link">
2006     Used Components
2007   </a>
2008
2009 </li>
2010
2011         <li class="md-nav__item">
2012   <a href="#package-structure" class="md-nav__link">
2013     Package Structure
2014   </a>
2015
2016 </li>
2017
2018         <li class="md-nav__item">
2019   <a href="#miscellaneous" class="md-nav__link">
2020     Miscellaneous
2021   </a>
2022
2023 </li>
2024
2025         <li class="md-nav__item">
2026   <a href="#person-information-model" class="md-nav__link">
2027     Person Information Model
2028   </a>
2029
2030 </li>
2031
2032         <li class="md-nav__item">
2033   <a href="#listing-and-deleting-person-information" class="md-nav__link">
2034     Listing and Deleting Person Information
2035   </a>
2036
2037 </li>
2038
2039         <li class="md-nav__item">
2040   <a href="#creating-and-editing-person-information" class="md-nav__link">
2041     Creating and Editing Person Information
2042   </a>
2043
2044 </li>
2045
2046         <li class="md-nav__item">
2047   <a href="#username-and-ip-address-event-listeners" class="md-nav__link">
2048     Username and IP Address Event Listeners
2049   </a>
2050
2051 </li>
2052
2053     </ul>
2054
2055 </nav>
2056                   </div>
2057                 </div>
2058               </div>
2059
2060
2061           <div class="md-content" data-md-component="content">
2062             <article class="md-content__inner md-typeset">
2063
2064
2065                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/part_5.md" title="Edit this page" class="md-content__button md-icon">
2066                     <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>
2067                   </a>
2068
2069
2070                 <h1 id="part-5-person-information">Part 5: Person Information<a class="headerlink" href="#part-5-person-information" title="Permanent link">#</a></h1>
2071 <p>This part of our tutorial series lays the foundation for future parts in which we will be using additional APIs, which we have not used in this series yet.
2072 To make use of those APIs, we need content generated by users in the frontend.</p>
2073 <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
2074 <p>In addition to the existing functions from <a href="../part_4/">part 4</a>, the package will provide the following functionality after this part of the tutorial:</p>
2075 <ul>
2076 <li>Users are able to add information on the people in the frontend.</li>
2077 <li>Users are able to edit and delete the pieces of information they added.</li>
2078 <li>Moderators are able to edit and delete all pieces of information.</li>
2079 </ul>
2080 <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2>
2081 <p>In addition to the components used in previous parts, we will use the <a href="../../../php/api/form_builder/overview/">form builder API</a> to create forms shown in dialogs instead of dedicated pages and we will, for the first time, add <a href="../../../javascript/typescript/">TypeScript code</a>.</p>
2082 <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
2083 <p>The package will have the following file structure <em>excluding</em> unchanged files from previous parts:</p>
2084 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2085 <span class="normal"> 2</span>
2086 <span class="normal"> 3</span>
2087 <span class="normal"> 4</span>
2088 <span class="normal"> 5</span>
2089 <span class="normal"> 6</span>
2090 <span class="normal"> 7</span>
2091 <span class="normal"> 8</span>
2092 <span class="normal"> 9</span>
2093 <span class="normal">10</span>
2094 <span class="normal">11</span>
2095 <span class="normal">12</span>
2096 <span class="normal">13</span>
2097 <span class="normal">14</span>
2098 <span class="normal">15</span>
2099 <span class="normal">16</span>
2100 <span class="normal">17</span>
2101 <span class="normal">18</span>
2102 <span class="normal">19</span>
2103 <span class="normal">20</span>
2104 <span class="normal">21</span>
2105 <span class="normal">22</span>
2106 <span class="normal">23</span>
2107 <span class="normal">24</span>
2108 <span class="normal">25</span>
2109 <span class="normal">26</span>
2110 <span class="normal">27</span>
2111 <span class="normal">28</span>
2112 <span class="normal">29</span>
2113 <span class="normal">30</span>
2114 <span class="normal">31</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code>├── files
2115 │   ├── acp
2116 │   │   └── database
2117 │   │       └── install_com.woltlab.wcf.people.php
2118 │   ├── js
2119 │   │   └── WoltLabSuite
2120 │   │       └── Core
2121 │   │           └── Controller
2122 │   │               └── Person.js
2123 │   └── lib
2124 │       └── data
2125 │           └── person
2126 │               ├── Person.class.php
2127 │               └── information
2128 │                   ├── PersonInformation.class.php
2129 │                   ├── PersonInformationAction.class.php
2130 │                   ├── PersonInformationEditor.class.php
2131 │                   └── PersonInformationList.class.php
2132 ├── language
2133 │   ├── de.xml
2134 │   └── en.xml
2135 ├── objectType.xml
2136 ├── templates
2137 │   ├── person.tpl
2138 │   └── personList.tpl
2139 ├── ts
2140 │   └── WoltLabSuite
2141 │       └── Core
2142 │           └── Controller
2143 │               └── Person.ts
2144 └── userGroupOption.xml
2145 </code></pre></div>
2146 </td></tr></table>
2147 <p>For all changes, please refer to the <a href="https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-5">source code on GitHub</a>.</p>
2148 <h2 id="miscellaneous">Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permanent link">#</a></h2>
2149 <p>Before we focus on the main aspects of this part, we mention some minor aspects that will be used later on:</p>
2150 <ul>
2151 <li>Several new user group options and the relevant language items have been added related to creating, editing, and deleting information:<ul>
2152 <li><code>mod.person.canEditInformation</code> and <code>mod.person.canDeleteInformation</code> are moderative permissions to edit and delete any piece of information, regardless of who created it.</li>
2153 <li><code>user.person.canAddInformation</code> is the permission for users to add new pieces of information.</li>
2154 <li><code>user.person.canEditInformation</code> and <code>user.person.canDeleteInformation</code> are the user permissions to edit and the piece of information they created.</li>
2155 </ul>
2156 </li>
2157 <li>The actual information text will be entered via a WYSIWYG editor, which requires an object type of the definition <code>com.woltlab.wcf.message</code>: <code>com.woltlab.wcf.people.information</code>.</li>
2158 <li><code>personList.tpl</code> has been adjusted to show the number of pieces of information in the person statistics section.</li>
2159 <li>We have not updated the person list box to also support sorting by the number of pieces of information added for each person.</li>
2160 </ul>
2161 <h2 id="person-information-model">Person Information Model<a class="headerlink" href="#person-information-model" title="Permanent link">#</a></h2>
2162 <p>The PHP file with the database layout has been updated as follows:</p>
2163 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2164 <span class="normal"> 2</span>
2165 <span class="normal"> 3</span>
2166 <span class="normal"> 4</span>
2167 <span class="normal"> 5</span>
2168 <span class="normal"> 6</span>
2169 <span class="normal"> 7</span>
2170 <span class="normal"> 8</span>
2171 <span class="normal"> 9</span>
2172 <span class="normal">10</span>
2173 <span class="normal">11</span>
2174 <span class="normal">12</span>
2175 <span class="normal">13</span>
2176 <span class="normal">14</span>
2177 <span class="normal">15</span>
2178 <span class="normal">16</span>
2179 <span class="normal">17</span>
2180 <span class="normal">18</span>
2181 <span class="normal">19</span>
2182 <span class="normal">20</span>
2183 <span class="normal">21</span>
2184 <span class="normal">22</span>
2185 <span class="normal">23</span>
2186 <span class="normal">24</span>
2187 <span class="normal">25</span>
2188 <span class="normal">26</span>
2189 <span class="normal">27</span>
2190 <span class="normal">28</span>
2191 <span class="normal">29</span>
2192 <span class="normal">30</span>
2193 <span class="normal">31</span>
2194 <span class="normal">32</span>
2195 <span class="normal">33</span>
2196 <span class="normal">34</span>
2197 <span class="normal">35</span>
2198 <span class="normal">36</span>
2199 <span class="normal">37</span>
2200 <span class="normal">38</span>
2201 <span class="normal">39</span>
2202 <span class="normal">40</span>
2203 <span class="normal">41</span>
2204 <span class="normal">42</span>
2205 <span class="normal">43</span>
2206 <span class="normal">44</span>
2207 <span class="normal">45</span>
2208 <span class="normal">46</span>
2209 <span class="normal">47</span>
2210 <span class="normal">48</span>
2211 <span class="normal">49</span>
2212 <span class="normal">50</span>
2213 <span class="normal">51</span>
2214 <span class="normal">52</span>
2215 <span class="normal">53</span>
2216 <span class="normal">54</span>
2217 <span class="normal">55</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2218
2219 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\DefaultTrueBooleanDatabaseTableColumn</span><span class="p">;</span>
2220 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\IntDatabaseTableColumn</span><span class="p">;</span>
2221 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\NotNullInt10DatabaseTableColumn</span><span class="p">;</span>
2222 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\NotNullVarchar255DatabaseTableColumn</span><span class="p">;</span>
2223 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\ObjectIdDatabaseTableColumn</span><span class="p">;</span>
2224 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\SmallintDatabaseTableColumn</span><span class="p">;</span>
2225 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\TextDatabaseTableColumn</span><span class="p">;</span>
2226 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\VarcharDatabaseTableColumn</span><span class="p">;</span>
2227 <span class="k">use</span> <span class="nx">wcf\system\database\table\DatabaseTable</span><span class="p">;</span>
2228 <span class="k">use</span> <span class="nx">wcf\system\database\table\index\DatabaseTableForeignKey</span><span class="p">;</span>
2229
2230 <span class="k">return</span> <span class="p">[</span>
2231     <span class="nx">DatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;wcf1_person&#39;</span><span class="p">)</span>
2232         <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2233             <span class="nx">ObjectIdDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;personID&#39;</span><span class="p">),</span>
2234             <span class="nx">NotNullVarchar255DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">),</span>
2235             <span class="nx">NotNullVarchar255DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">),</span>
2236             <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;informationCount&#39;</span><span class="p">)</span>
2237                 <span class="o">-&gt;</span><span class="na">defaultValue</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span>
2238             <span class="nx">SmallintDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;comments&#39;</span><span class="p">)</span>
2239                 <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
2240                 <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">()</span>
2241                 <span class="o">-&gt;</span><span class="na">defaultValue</span><span class="p">(</span><span class="mi">0</span><span class="p">),</span>
2242             <span class="nx">DefaultTrueBooleanDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;enableComments&#39;</span><span class="p">),</span>
2243         <span class="p">]),</span>
2244
2245     <span class="nx">DatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;wcf1_person_information&#39;</span><span class="p">)</span>
2246         <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2247             <span class="nx">ObjectIdDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;informationID&#39;</span><span class="p">),</span>
2248             <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;personID&#39;</span><span class="p">),</span>
2249             <span class="nx">TextDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;information&#39;</span><span class="p">),</span>
2250             <span class="nx">IntDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;userID&#39;</span><span class="p">)</span>
2251                 <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">10</span><span class="p">),</span>
2252             <span class="nx">NotNullVarchar255DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;username&#39;</span><span class="p">),</span>
2253             <span class="nx">VarcharDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;ipAddress&#39;</span><span class="p">)</span>
2254                 <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">39</span><span class="p">)</span>
2255                 <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">(</span><span class="k">true</span><span class="p">)</span>
2256                 <span class="o">-&gt;</span><span class="na">defaultValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">),</span>
2257             <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;time&#39;</span><span class="p">),</span>
2258         <span class="p">])</span>
2259         <span class="o">-&gt;</span><span class="na">foreignKeys</span><span class="p">([</span>
2260             <span class="nx">DatabaseTableForeignKey</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
2261                 <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;personID&#39;</span><span class="p">])</span>
2262                 <span class="o">-&gt;</span><span class="na">referencedTable</span><span class="p">(</span><span class="s1">&#39;wcf1_person&#39;</span><span class="p">)</span>
2263                 <span class="o">-&gt;</span><span class="na">referencedColumns</span><span class="p">([</span><span class="s1">&#39;personID&#39;</span><span class="p">])</span>
2264                 <span class="o">-&gt;</span><span class="na">onDelete</span><span class="p">(</span><span class="s1">&#39;CASCADE&#39;</span><span class="p">),</span>
2265             <span class="nx">DatabaseTableForeignKey</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
2266                 <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;userID&#39;</span><span class="p">])</span>
2267                 <span class="o">-&gt;</span><span class="na">referencedTable</span><span class="p">(</span><span class="s1">&#39;wcf1_user&#39;</span><span class="p">)</span>
2268                 <span class="o">-&gt;</span><span class="na">referencedColumns</span><span class="p">([</span><span class="s1">&#39;userID&#39;</span><span class="p">])</span>
2269                 <span class="o">-&gt;</span><span class="na">onDelete</span><span class="p">(</span><span class="s1">&#39;SET NULL&#39;</span><span class="p">),</span>
2270         <span class="p">]),</span>
2271 <span class="p">];</span>
2272 </code></pre></div>
2273 </td></tr></table>
2274 <ul>
2275 <li>The number of pieces of information per person is tracked via the new <code>informationCount</code> column.</li>
2276 <li>The <code>wcf1_person_information</code> table has been added for the <code>PersonInformation</code> model.
2277   The meaning of the different columns is explained in the property documentation part of <code>PersonInformation</code>'s documentation (see below).
2278   The two foreign keys ensure that if a person is deleted, all of their information is also deleted, and that if a user is deleted, the <code>userID</code> column is set to <code>NULL</code>.</li>
2279 </ul>
2280 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2281 <span class="normal"> 2</span>
2282 <span class="normal"> 3</span>
2283 <span class="normal"> 4</span>
2284 <span class="normal"> 5</span>
2285 <span class="normal"> 6</span>
2286 <span class="normal"> 7</span>
2287 <span class="normal"> 8</span>
2288 <span class="normal"> 9</span>
2289 <span class="normal">10</span>
2290 <span class="normal">11</span>
2291 <span class="normal">12</span>
2292 <span class="normal">13</span>
2293 <span class="normal">14</span>
2294 <span class="normal">15</span>
2295 <span class="normal">16</span>
2296 <span class="normal">17</span>
2297 <span class="normal">18</span>
2298 <span class="normal">19</span>
2299 <span class="normal">20</span>
2300 <span class="normal">21</span>
2301 <span class="normal">22</span>
2302 <span class="normal">23</span>
2303 <span class="normal">24</span>
2304 <span class="normal">25</span>
2305 <span class="normal">26</span>
2306 <span class="normal">27</span>
2307 <span class="normal">28</span>
2308 <span class="normal">29</span>
2309 <span class="normal">30</span>
2310 <span class="normal">31</span>
2311 <span class="normal">32</span>
2312 <span class="normal">33</span>
2313 <span class="normal">34</span>
2314 <span class="normal">35</span>
2315 <span class="normal">36</span>
2316 <span class="normal">37</span>
2317 <span class="normal">38</span>
2318 <span class="normal">39</span>
2319 <span class="normal">40</span>
2320 <span class="normal">41</span>
2321 <span class="normal">42</span>
2322 <span class="normal">43</span>
2323 <span class="normal">44</span>
2324 <span class="normal">45</span>
2325 <span class="normal">46</span>
2326 <span class="normal">47</span>
2327 <span class="normal">48</span>
2328 <span class="normal">49</span>
2329 <span class="normal">50</span>
2330 <span class="normal">51</span>
2331 <span class="normal">52</span>
2332 <span class="normal">53</span>
2333 <span class="normal">54</span>
2334 <span class="normal">55</span>
2335 <span class="normal">56</span>
2336 <span class="normal">57</span>
2337 <span class="normal">58</span>
2338 <span class="normal">59</span>
2339 <span class="normal">60</span>
2340 <span class="normal">61</span>
2341 <span class="normal">62</span>
2342 <span class="normal">63</span>
2343 <span class="normal">64</span>
2344 <span class="normal">65</span>
2345 <span class="normal">66</span>
2346 <span class="normal">67</span>
2347 <span class="normal">68</span>
2348 <span class="normal">69</span>
2349 <span class="normal">70</span>
2350 <span class="normal">71</span>
2351 <span class="normal">72</span>
2352 <span class="normal">73</span>
2353 <span class="normal">74</span>
2354 <span class="normal">75</span>
2355 <span class="normal">76</span>
2356 <span class="normal">77</span>
2357 <span class="normal">78</span>
2358 <span class="normal">79</span>
2359 <span class="normal">80</span>
2360 <span class="normal">81</span>
2361 <span class="normal">82</span>
2362 <span class="normal">83</span>
2363 <span class="normal">84</span>
2364 <span class="normal">85</span>
2365 <span class="normal">86</span>
2366 <span class="normal">87</span>
2367 <span class="normal">88</span>
2368 <span class="normal">89</span>
2369 <span class="normal">90</span>
2370 <span class="normal">91</span>
2371 <span class="normal">92</span>
2372 <span class="normal">93</span>
2373 <span class="normal">94</span>
2374 <span class="normal">95</span>
2375 <span class="normal">96</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2376
2377 <span class="k">namespace</span> <span class="nx">wcf\data\person\information</span><span class="p">;</span>
2378
2379 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObject</span><span class="p">;</span>
2380 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
2381 <span class="k">use</span> <span class="nx">wcf\data\user\UserProfile</span><span class="p">;</span>
2382 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
2383 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\UserProfileRuntimeCache</span><span class="p">;</span>
2384 <span class="k">use</span> <span class="nx">wcf\system\html\output\HtmlOutputProcessor</span><span class="p">;</span>
2385 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2386
2387 <span class="sd">/**</span>
2388 <span class="sd"> * Represents a piece of information for a person.</span>
2389 <span class="sd"> *</span>
2390 <span class="sd"> * @author  Matthias Schmidt</span>
2391 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
2392 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2393 <span class="sd"> * @package WoltLabSuite\Core\Data\Person\Information</span>
2394 <span class="sd"> *</span>
2395 <span class="sd"> * @property-read   int         $informationID  unique id of the information</span>
2396 <span class="sd"> * @property-read   int         $personID       id of the person the information belongs to</span>
2397 <span class="sd"> * @property-read   string      $information    information text</span>
2398 <span class="sd"> * @property-read   int|null    $userID         id of the user who added the information or `null` if the user no longer exists</span>
2399 <span class="sd"> * @property-read   string      $username       name of the user who added the information</span>
2400 <span class="sd"> * @property-read   int         $time           timestamp at which the information was created</span>
2401 <span class="sd"> */</span>
2402 <span class="k">class</span> <span class="nc">PersonInformation</span> <span class="k">extends</span> <span class="nx">DatabaseObject</span>
2403 <span class="p">{</span>
2404     <span class="sd">/**</span>
2405 <span class="sd">     * Returns `true` if the active user can delete this piece of information and `false` otherwise.</span>
2406 <span class="sd">     */</span>
2407     <span class="k">public</span> <span class="k">function</span> <span class="nf">canDelete</span><span class="p">()</span><span class="o">:</span> <span class="nx">bool</span>
2408     <span class="p">{</span>
2409         <span class="k">if</span> <span class="p">(</span>
2410             <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span>
2411             <span class="o">&amp;&amp;</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span> <span class="o">==</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">userID</span>
2412             <span class="o">&amp;&amp;</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.canDeleteInformation&#39;</span><span class="p">)</span>
2413         <span class="p">)</span> <span class="p">{</span>
2414             <span class="k">return</span> <span class="k">true</span><span class="p">;</span>
2415         <span class="p">}</span>
2416
2417         <span class="k">return</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;mod.person.canDeleteInformation&#39;</span><span class="p">);</span>
2418     <span class="p">}</span>
2419
2420     <span class="sd">/**</span>
2421 <span class="sd">     * Returns `true` if the active user can edit this piece of information and `false` otherwise.</span>
2422 <span class="sd">     */</span>
2423     <span class="k">public</span> <span class="k">function</span> <span class="nf">canEdit</span><span class="p">()</span><span class="o">:</span> <span class="nx">bool</span>
2424     <span class="p">{</span>
2425         <span class="k">if</span> <span class="p">(</span>
2426             <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span>
2427             <span class="o">&amp;&amp;</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span> <span class="o">==</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">userID</span>
2428             <span class="o">&amp;&amp;</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.canEditInformation&#39;</span><span class="p">)</span>
2429         <span class="p">)</span> <span class="p">{</span>
2430             <span class="k">return</span> <span class="k">true</span><span class="p">;</span>
2431         <span class="p">}</span>
2432
2433         <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getSession</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getPermission</span><span class="p">(</span><span class="s1">&#39;mod.person.canEditInformation&#39;</span><span class="p">);</span>
2434     <span class="p">}</span>
2435
2436     <span class="sd">/**</span>
2437 <span class="sd">     * Returns the formatted information.</span>
2438 <span class="sd">     */</span>
2439     <span class="k">public</span> <span class="k">function</span> <span class="nf">getFormattedInformation</span><span class="p">()</span><span class="o">:</span> <span class="nx">string</span>
2440     <span class="p">{</span>
2441         <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">HtmlOutputProcessor</span><span class="p">();</span>
2442         <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span>
2443             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="p">,</span>
2444             <span class="s1">&#39;com.woltlab.wcf.people.information&#39;</span><span class="p">,</span>
2445             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">informationID</span>
2446         <span class="p">);</span>
2447
2448         <span class="k">return</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2449     <span class="p">}</span>
2450
2451     <span class="sd">/**</span>
2452 <span class="sd">     * Returns the person the information belongs to.</span>
2453 <span class="sd">     */</span>
2454     <span class="k">public</span> <span class="k">function</span> <span class="nf">getPerson</span><span class="p">()</span><span class="o">:</span> <span class="nx">Person</span>
2455     <span class="p">{</span>
2456         <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">$this</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">);</span>
2457     <span class="p">}</span>
2458
2459     <span class="sd">/**</span>
2460 <span class="sd">     * Returns the user profile of the user who added the information.</span>
2461 <span class="sd">     */</span>
2462     <span class="k">public</span> <span class="k">function</span> <span class="nf">getUserProfile</span><span class="p">()</span><span class="o">:</span> <span class="nx">UserProfile</span>
2463     <span class="p">{</span>
2464         <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">)</span> <span class="p">{</span>
2465             <span class="k">return</span> <span class="nx">UserProfileRuntimeCache</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">$this</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">);</span>
2466         <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
2467             <span class="k">return</span> <span class="nx">UserProfile</span><span class="o">::</span><span class="na">getGuestUserProfile</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">username</span><span class="p">);</span>
2468         <span class="p">}</span>
2469     <span class="p">}</span>
2470 <span class="p">}</span>
2471 </code></pre></div>
2472 </td></tr></table>
2473 <p><code>PersonInformation</code> provides two methods, <code>canDelete()</code> and <code>canEdit()</code>, to check whether the active user can delete or edit a specific piece of information.
2474 In both cases, it is checked if the current user has created the relevant piece of information to check the user-specific permissions or to fall back to the moderator-specific permissions.</p>
2475 <p>There also two getter methods for the person, the piece of information belongs to (<code>getPerson()</code>), and for the user profile of the user who created the information (<code>getUserProfile()</code>).
2476 In both cases, we use runtime caches, though in <code>getUserProfile()</code>, we also have to consider the case of the user who created the information being deleted, i.e. <code>userID</code> being <code>null</code>.
2477 For such a case, we also save the name of the user who created the information in <code>username</code>, so that we can return a guest user profile object in this case.
2478 The most interesting method is <code>getFormattedInformation()</code>, which returns the HTML code of the information text meant for output.
2479 To generate such an output, <code>HtmlOutputProcessor::process()</code> is used and here is where we first use the associated message object type <code>com.woltlab.wcf.people.information</code> mentioned <a href="#miscellaneous">before</a>.</p>
2480 <p>While <code>PersonInformationEditor</code> is simply the default implementation and thus not explicitly shown here, <code>PersonInformationList::readObjects()</code> caches the relevant ids of the associated people and users who created the pieces of information using runtime caches:</p>
2481 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2482 <span class="normal"> 2</span>
2483 <span class="normal"> 3</span>
2484 <span class="normal"> 4</span>
2485 <span class="normal"> 5</span>
2486 <span class="normal"> 6</span>
2487 <span class="normal"> 7</span>
2488 <span class="normal"> 8</span>
2489 <span class="normal"> 9</span>
2490 <span class="normal">10</span>
2491 <span class="normal">11</span>
2492 <span class="normal">12</span>
2493 <span class="normal">13</span>
2494 <span class="normal">14</span>
2495 <span class="normal">15</span>
2496 <span class="normal">16</span>
2497 <span class="normal">17</span>
2498 <span class="normal">18</span>
2499 <span class="normal">19</span>
2500 <span class="normal">20</span>
2501 <span class="normal">21</span>
2502 <span class="normal">22</span>
2503 <span class="normal">23</span>
2504 <span class="normal">24</span>
2505 <span class="normal">25</span>
2506 <span class="normal">26</span>
2507 <span class="normal">27</span>
2508 <span class="normal">28</span>
2509 <span class="normal">29</span>
2510 <span class="normal">30</span>
2511 <span class="normal">31</span>
2512 <span class="normal">32</span>
2513 <span class="normal">33</span>
2514 <span class="normal">34</span>
2515 <span class="normal">35</span>
2516 <span class="normal">36</span>
2517 <span class="normal">37</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2518
2519 <span class="k">namespace</span> <span class="nx">wcf\data\person\information</span><span class="p">;</span>
2520
2521 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObjectList</span><span class="p">;</span>
2522 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
2523 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\UserProfileRuntimeCache</span><span class="p">;</span>
2524
2525 <span class="sd">/**</span>
2526 <span class="sd"> * Represents a list of person information.</span>
2527 <span class="sd"> *</span>
2528 <span class="sd"> * @author  Matthias Schmidt</span>
2529 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
2530 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2531 <span class="sd"> * @package WoltLabSuite\Core\Data\PersonInformation</span>
2532 <span class="sd"> *</span>
2533 <span class="sd"> * @method      PersonInformation       current()</span>
2534 <span class="sd"> * @method      PersonInformation[]     getObjects()</span>
2535 <span class="sd"> * @method      PersonInformation|null  search($objectID)</span>
2536 <span class="sd"> * @property    PersonInformation[]     $objects</span>
2537 <span class="sd"> */</span>
2538 <span class="k">class</span> <span class="nc">PersonInformationList</span> <span class="k">extends</span> <span class="nx">DatabaseObjectList</span>
2539 <span class="p">{</span>
2540     <span class="k">public</span> <span class="k">function</span> <span class="nf">readObjects</span><span class="p">()</span>
2541     <span class="p">{</span>
2542         <span class="k">parent</span><span class="o">::</span><span class="na">readObjects</span><span class="p">();</span>
2543
2544         <span class="nx">UserProfileRuntimeCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">cacheObjectIDs</span><span class="p">(</span><span class="nx">\array_unique</span><span class="p">(</span><span class="nx">\array_filter</span><span class="p">(</span><span class="nx">\array_column</span><span class="p">(</span>
2545             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objects</span><span class="p">,</span>
2546             <span class="s1">&#39;userID&#39;</span>
2547         <span class="p">))));</span>
2548         <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">cacheObjectIDs</span><span class="p">(</span><span class="nx">\array_unique</span><span class="p">(</span><span class="nx">\array_column</span><span class="p">(</span>
2549             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objects</span><span class="p">,</span>
2550             <span class="s1">&#39;personID&#39;</span>
2551         <span class="p">)));</span>
2552     <span class="p">}</span>
2553 <span class="p">}</span>
2554 </code></pre></div>
2555 </td></tr></table>
2556 <h2 id="listing-and-deleting-person-information">Listing and Deleting Person Information<a class="headerlink" href="#listing-and-deleting-person-information" title="Permanent link">#</a></h2>
2557 <p>The <code>person.tpl</code> template has been updated to include a block for listing the information at the beginning:</p>
2558 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">  1</span>
2559 <span class="normal">  2</span>
2560 <span class="normal">  3</span>
2561 <span class="normal">  4</span>
2562 <span class="normal">  5</span>
2563 <span class="normal">  6</span>
2564 <span class="normal">  7</span>
2565 <span class="normal">  8</span>
2566 <span class="normal">  9</span>
2567 <span class="normal"> 10</span>
2568 <span class="normal"> 11</span>
2569 <span class="normal"> 12</span>
2570 <span class="normal"> 13</span>
2571 <span class="normal"> 14</span>
2572 <span class="normal"> 15</span>
2573 <span class="normal"> 16</span>
2574 <span class="normal"> 17</span>
2575 <span class="normal"> 18</span>
2576 <span class="normal"> 19</span>
2577 <span class="normal"> 20</span>
2578 <span class="normal"> 21</span>
2579 <span class="normal"> 22</span>
2580 <span class="normal"> 23</span>
2581 <span class="normal"> 24</span>
2582 <span class="normal"> 25</span>
2583 <span class="normal"> 26</span>
2584 <span class="normal"> 27</span>
2585 <span class="normal"> 28</span>
2586 <span class="normal"> 29</span>
2587 <span class="normal"> 30</span>
2588 <span class="normal"> 31</span>
2589 <span class="normal"> 32</span>
2590 <span class="normal"> 33</span>
2591 <span class="normal"> 34</span>
2592 <span class="normal"> 35</span>
2593 <span class="normal"> 36</span>
2594 <span class="normal"> 37</span>
2595 <span class="normal"> 38</span>
2596 <span class="normal"> 39</span>
2597 <span class="normal"> 40</span>
2598 <span class="normal"> 41</span>
2599 <span class="normal"> 42</span>
2600 <span class="normal"> 43</span>
2601 <span class="normal"> 44</span>
2602 <span class="normal"> 45</span>
2603 <span class="normal"> 46</span>
2604 <span class="normal"> 47</span>
2605 <span class="normal"> 48</span>
2606 <span class="normal"> 49</span>
2607 <span class="normal"> 50</span>
2608 <span class="normal"> 51</span>
2609 <span class="normal"> 52</span>
2610 <span class="normal"> 53</span>
2611 <span class="normal"> 54</span>
2612 <span class="normal"> 55</span>
2613 <span class="normal"> 56</span>
2614 <span class="normal"> 57</span>
2615 <span class="normal"> 58</span>
2616 <span class="normal"> 59</span>
2617 <span class="normal"> 60</span>
2618 <span class="normal"> 61</span>
2619 <span class="normal"> 62</span>
2620 <span class="normal"> 63</span>
2621 <span class="normal"> 64</span>
2622 <span class="normal"> 65</span>
2623 <span class="normal"> 66</span>
2624 <span class="normal"> 67</span>
2625 <span class="normal"> 68</span>
2626 <span class="normal"> 69</span>
2627 <span class="normal"> 70</span>
2628 <span class="normal"> 71</span>
2629 <span class="normal"> 72</span>
2630 <span class="normal"> 73</span>
2631 <span class="normal"> 74</span>
2632 <span class="normal"> 75</span>
2633 <span class="normal"> 76</span>
2634 <span class="normal"> 77</span>
2635 <span class="normal"> 78</span>
2636 <span class="normal"> 79</span>
2637 <span class="normal"> 80</span>
2638 <span class="normal"> 81</span>
2639 <span class="normal"> 82</span>
2640 <span class="normal"> 83</span>
2641 <span class="normal"> 84</span>
2642 <span class="normal"> 85</span>
2643 <span class="normal"> 86</span>
2644 <span class="normal"> 87</span>
2645 <span class="normal"> 88</span>
2646 <span class="normal"> 89</span>
2647 <span class="normal"> 90</span>
2648 <span class="normal"> 91</span>
2649 <span class="normal"> 92</span>
2650 <span class="normal"> 93</span>
2651 <span class="normal"> 94</span>
2652 <span class="normal"> 95</span>
2653 <span class="normal"> 96</span>
2654 <span class="normal"> 97</span>
2655 <span class="normal"> 98</span>
2656 <span class="normal"> 99</span>
2657 <span class="normal">100</span>
2658 <span class="normal">101</span>
2659 <span class="normal">102</span>
2660 <span class="normal">103</span>
2661 <span class="normal">104</span>
2662 <span class="normal">105</span>
2663 <span class="normal">106</span>
2664 <span class="normal">107</span>
2665 <span class="normal">108</span>
2666 <span class="normal">109</span>
2667 <span class="normal">110</span>
2668 <span class="normal">111</span>
2669 <span class="normal">112</span>
2670 <span class="normal">113</span>
2671 <span class="normal">114</span>
2672 <span class="normal">115</span>
2673 <span class="normal">116</span>
2674 <span class="normal">117</span>
2675 <span class="normal">118</span>
2676 <span class="normal">119</span>
2677 <span class="normal">120</span>
2678 <span class="normal">121</span>
2679 <span class="normal">122</span>
2680 <span class="normal">123</span>
2681 <span class="normal">124</span>
2682 <span class="normal">125</span>
2683 <span class="normal">126</span>
2684 <span class="normal">127</span>
2685 <span class="normal">128</span>
2686 <span class="normal">129</span>
2687 <span class="normal">130</span>
2688 <span class="normal">131</span>
2689 <span class="normal">132</span>
2690 <span class="normal">133</span>
2691 <span class="normal">134</span>
2692 <span class="normal">135</span>
2693 <span class="normal">136</span>
2694 <span class="normal">137</span>
2695 <span class="normal">138</span>
2696 <span class="normal">139</span>
2697 <span class="normal">140</span>
2698 <span class="normal">141</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;pageTitle&#39;</span><span class="cp">}{</span><span class="nv">$person</span><span class="cp">}</span><span class="x"> - </span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.list</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2699
2700 <span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;contentTitle&#39;</span><span class="cp">}{</span><span class="nv">$person</span><span class="cp">}{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2701
2702 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span><span class="cp">}</span><span class="x"></span>
2703
2704 <span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">informationCount</span> <span class="o">||</span> <span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">session</span><span class="o">-&gt;</span><span class="na">getPermission</span><span class="o">(</span><span class="s1">&#39;user.person.canAddInformation&#39;</span><span class="o">)</span><span class="cp">}</span><span class="x"></span>
2705 <span class="x">    &lt;section class=&quot;section sectionContainerList&quot;&gt;</span>
2706 <span class="x">        &lt;header class=&quot;sectionHeader&quot;&gt;</span>
2707 <span class="x">            &lt;h2 class=&quot;sectionTitle&quot;&gt;</span>
2708 <span class="x">                </span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.information.list</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2709 <span class="x">                </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">informationCount</span><span class="cp">}</span><span class="x"></span>
2710 <span class="x">                    &lt;span class=&quot;badge&quot;&gt;</span><span class="cp">{</span><span class="err">#</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">informationCount</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
2711 <span class="x">                </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2712 <span class="x">            &lt;/h2&gt;</span>
2713 <span class="x">        &lt;/header&gt;</span>
2714
2715 <span class="x">        &lt;ul class=&quot;commentList containerList personInformationList jsObjectActionContainer&quot; </span><span class="cp">{</span><span class="c">*</span>
2716 <span class="c">            *</span><span class="cp">}</span><span class="x">data-object-action-class-name=&quot;wcf\data\person\information\PersonInformationAction&quot;</span><span class="cp">{</span><span class="c">*</span>
2717 <span class="c">        *</span><span class="cp">}</span><span class="x">&gt;</span>
2718 <span class="x">            </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">session</span><span class="o">-&gt;</span><span class="na">getPermission</span><span class="o">(</span><span class="s1">&#39;user.person.canAddInformation&#39;</span><span class="o">)</span><span class="cp">}</span><span class="x"></span>
2719 <span class="x">                &lt;li class=&quot;containerListButtonGroup&quot;&gt;</span>
2720 <span class="x">                    &lt;ul class=&quot;buttonGroup&quot;&gt;</span>
2721 <span class="x">                        &lt;li&gt;</span>
2722 <span class="x">                            &lt;a href=&quot;#&quot; class=&quot;button&quot; id=&quot;personInformationAddButton&quot;&gt;</span>
2723 <span class="x">                                &lt;span class=&quot;icon icon16 fa-plus&quot;&gt;&lt;/span&gt;</span>
2724 <span class="x">                                &lt;span&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.information.add</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
2725 <span class="x">                            &lt;/a&gt;</span>
2726 <span class="x">                        &lt;/li&gt;</span>
2727 <span class="x">                    &lt;/ul&gt;</span>
2728 <span class="x">                &lt;/li&gt;</span>
2729 <span class="x">            </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2730
2731 <span class="x">            </span><span class="cp">{</span><span class="nf">foreach</span> <span class="na">from</span><span class="o">=</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">getInformation</span><span class="o">()</span> <span class="na">item</span><span class="o">=</span><span class="nv">$information</span><span class="cp">}</span><span class="x"></span>
2732 <span class="x">                &lt;li class=&quot;comment personInformation jsObjectActionObject&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
2733 <span class="x">                    &lt;div class=&quot;box48</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">getUserProfileHandler</span><span class="o">()-&gt;</span><span class="na">isIgnoredUser</span><span class="o">(</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">userID</span><span class="o">)</span><span class="cp">}</span><span class="x"> ignoredUserContent</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
2734 <span class="x">                        </span><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getUserProfile</span><span class="o">()</span> <span class="na">type</span><span class="o">=</span><span class="s1">&#39;avatar48&#39;</span> <span class="na">ariaHidden</span><span class="o">=</span><span class="s1">&#39;true&#39;</span> <span class="na">tabindex</span><span class="o">=</span><span class="s1">&#39;-1&#39;</span><span class="cp">}</span><span class="x"></span>
2735
2736 <span class="x">                        &lt;div class=&quot;commentContentContainer&quot;&gt;</span>
2737 <span class="x">                            &lt;div class=&quot;commentContent&quot;&gt;</span>
2738 <span class="x">                                &lt;div class=&quot;containerHeadline&quot;&gt;</span>
2739 <span class="x">                                    &lt;h3&gt;</span>
2740 <span class="x">                                        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$information</span><span class="o">-&gt;</span><span class="na">userID</span><span class="cp">}</span><span class="x"></span>
2741 <span class="x">                                            </span><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getUserProfile</span><span class="o">()</span><span class="cp">}</span><span class="x"></span>
2742 <span class="x">                                        </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"></span>
2743 <span class="x">                                            &lt;span&gt;</span><span class="cp">{</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">username</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
2744 <span class="x">                                        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2745
2746 <span class="x">                                        &lt;small class=&quot;separatorLeft&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">time</span><span class="o">|</span><span class="na">time</span><span class="cp">}</span><span class="x">&lt;/small&gt;</span>
2747 <span class="x">                                    &lt;/h3&gt;</span>
2748 <span class="x">                                &lt;/div&gt;</span>
2749
2750 <span class="x">                                &lt;div class=&quot;htmlContent userMessage&quot; id=&quot;personInformation</span><span class="cp">{</span><span class="o">@</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
2751 <span class="x">                                    </span><span class="cp">{</span><span class="o">@</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getFormattedInformation</span><span class="o">()</span><span class="cp">}</span><span class="x"></span>
2752 <span class="x">                                &lt;/div&gt;</span>
2753
2754 <span class="x">                                &lt;nav class=&quot;jsMobileNavigation buttonGroupNavigation&quot;&gt;</span>
2755 <span class="x">                                    &lt;ul class=&quot;buttonList iconList&quot;&gt;</span>
2756 <span class="x">                                        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$information</span><span class="o">-&gt;</span><span class="na">canEdit</span><span class="o">()</span><span class="cp">}</span><span class="x"></span>
2757 <span class="x">                                            &lt;li class=&quot;jsOnly&quot;&gt;</span>
2758 <span class="x">                                                &lt;a href=&quot;#&quot; title=&quot;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.edit</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&quot; class=&quot;jsEditInformation jsTooltip&quot;&gt;</span>
2759 <span class="x">                                                    &lt;span class=&quot;icon icon16 fa-pencil&quot;&gt;&lt;/span&gt;</span>
2760 <span class="x">                                                    &lt;span class=&quot;invisible&quot;&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.edit</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
2761 <span class="x">                                                &lt;/a&gt;</span>
2762 <span class="x">                                            &lt;/li&gt;</span>
2763 <span class="x">                                        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2764 <span class="x">                                        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$information</span><span class="o">-&gt;</span><span class="na">canDelete</span><span class="o">()</span><span class="cp">}</span><span class="x"></span>
2765 <span class="x">                                            &lt;li class=&quot;jsOnly&quot;&gt;</span>
2766 <span class="x">                                                &lt;a href=&quot;#&quot; title=&quot;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.delete</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&quot; class=&quot;jsObjectAction jsTooltip&quot; data-object-action=&quot;delete&quot; data-confirm-message=&quot;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.information.delete.confirmMessage</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
2767 <span class="x">                                                    &lt;span class=&quot;icon icon16 fa-times&quot;&gt;&lt;/span&gt;</span>
2768 <span class="x">                                                    &lt;span class=&quot;invisible&quot;&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.button.edit</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span>
2769 <span class="x">                                                &lt;/a&gt;</span>
2770 <span class="x">                                            &lt;/li&gt;</span>
2771 <span class="x">                                        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2772
2773 <span class="x">                                        </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;informationOptions&#39;</span><span class="cp">}</span><span class="x"></span>
2774 <span class="x">                                    &lt;/ul&gt;</span>
2775 <span class="x">                                &lt;/nav&gt;</span>
2776 <span class="x">                            &lt;/div&gt;</span>
2777 <span class="x">                        &lt;/div&gt;</span>
2778 <span class="x">                    &lt;/div&gt;</span>
2779 <span class="x">                &lt;/li&gt;</span>
2780 <span class="x">            </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span><span class="x"></span>
2781 <span class="x">        &lt;/ul&gt;</span>
2782 <span class="x">    &lt;/section&gt;</span>
2783 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2784
2785 <span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">enableComments</span><span class="cp">}</span><span class="x"></span>
2786 <span class="x">    </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$commentList</span><span class="o">|</span><span class="na">count</span> <span class="o">||</span> <span class="nv">$commentCanAdd</span><span class="cp">}</span><span class="x"></span>
2787 <span class="x">        &lt;section id=&quot;comments&quot; class=&quot;section sectionContainerList&quot;&gt;</span>
2788 <span class="x">            &lt;header class=&quot;sectionHeader&quot;&gt;</span>
2789 <span class="x">                &lt;h2 class=&quot;sectionTitle&quot;&gt;</span>
2790 <span class="x">                    </span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.person.comments</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2791 <span class="x">                    </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">comments</span><span class="cp">}</span><span class="x">&lt;span class=&quot;badge&quot;&gt;</span><span class="cp">{</span><span class="err">#</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">comments</span><span class="cp">}</span><span class="x">&lt;/span&gt;</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2792 <span class="x">                &lt;/h2&gt;</span>
2793 <span class="x">            &lt;/header&gt;</span>
2794
2795 <span class="x">            </span><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;__commentJavaScript&#39;</span> <span class="na">commentContainerID</span><span class="o">=</span><span class="s1">&#39;personCommentList&#39;</span><span class="cp">}</span><span class="x"></span>
2796
2797 <span class="x">            &lt;div class=&quot;personComments&quot;&gt;</span>
2798 <span class="x">                &lt;ul id=&quot;personCommentList&quot; class=&quot;commentList containerList&quot; </span><span class="cp">{</span><span class="c">*</span>
2799 <span class="c">                    *</span><span class="cp">}</span><span class="x">data-can-add=&quot;</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$commentCanAdd</span><span class="cp">}</span><span class="x">true</span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x">false</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&quot; </span><span class="cp">{</span><span class="c">*</span>
2800 <span class="c">                    *</span><span class="cp">}</span><span class="x">data-object-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="cp">}</span><span class="x">&quot; </span><span class="cp">{</span><span class="c">*</span>
2801 <span class="c">                    *</span><span class="cp">}</span><span class="x">data-object-type-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$commentObjectTypeID</span><span class="cp">}</span><span class="x">&quot; </span><span class="cp">{</span><span class="c">*</span>
2802 <span class="c">                    *</span><span class="cp">}</span><span class="x">data-comments=&quot;</span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$person</span><span class="o">-&gt;</span><span class="na">comments</span><span class="cp">}{</span><span class="o">@</span><span class="nv">$commentList</span><span class="o">-&gt;</span><span class="na">countObjects</span><span class="o">()</span><span class="cp">}{</span><span class="nf">else</span><span class="cp">}</span><span class="x">0</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&quot; </span><span class="cp">{</span><span class="c">*</span>
2803 <span class="c">                    *</span><span class="cp">}</span><span class="x">data-last-comment-time=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$lastCommentTime</span><span class="cp">}</span><span class="x">&quot; </span><span class="cp">{</span><span class="c">*</span>
2804 <span class="c">                *</span><span class="cp">}</span><span class="x">&gt;</span>
2805 <span class="x">                    </span><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;commentListAddComment&#39;</span> <span class="na">wysiwygSelector</span><span class="o">=</span><span class="s1">&#39;personCommentListAddComment&#39;</span><span class="cp">}</span><span class="x"></span>
2806 <span class="x">                    </span><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;commentList&#39;</span><span class="cp">}</span><span class="x"></span>
2807 <span class="x">                &lt;/ul&gt;</span>
2808 <span class="x">            &lt;/div&gt;</span>
2809 <span class="x">        &lt;/section&gt;</span>
2810 <span class="x">    </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2811 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2812
2813 <span class="x">&lt;footer class=&quot;contentFooter&quot;&gt;</span>
2814 <span class="x">    </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2815 <span class="x">        &lt;nav class=&quot;contentFooterNavigation&quot;&gt;</span>
2816 <span class="x">            &lt;ul&gt;</span>
2817 <span class="x">                </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;contentFooterNavigation&#39;</span><span class="cp">}{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2818 <span class="x">            &lt;/ul&gt;</span>
2819 <span class="x">        &lt;/nav&gt;</span>
2820 <span class="x">    </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2821 <span class="x">&lt;/footer&gt;</span>
2822
2823 <span class="x">&lt;script data-relocate=&quot;true&quot;&gt;</span>
2824 <span class="x">    require([&#39;Language&#39;, &#39;WoltLabSuite/Core/Controller/Person&#39;], (Language, ControllerPerson) =&gt; </span><span class="cp">{</span>
2825         <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span>
2826             <span class="s1">&#39;wcf.person.information.add&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}wcf.person.information.add{/jslang}&#39;</span><span class="o">,</span>
2827             <span class="s1">&#39;wcf.person.information.add.success&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}wcf.person.information.add.success{/jslang}&#39;</span><span class="o">,</span>
2828             <span class="s1">&#39;wcf.person.information.edit&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}wcf.person.information.edit{/jslang}&#39;</span><span class="o">,</span>
2829             <span class="s1">&#39;wcf.person.information.edit.success&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}wcf.person.information.edit.success{/jslang}&#39;</span><span class="o">,</span>
2830         <span class="cp">}</span><span class="o">);</span>
2831
2832         <span class="na">ControllerPerson</span><span class="o">.</span><span class="na">init</span><span class="o">(</span><span class="cp">{</span><span class="o">@</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="cp">}</span><span class="o">,</span> <span class="cp">{</span>
2833             <span class="na">canAddInformation</span><span class="o">:</span> <span class="cp">{</span><span class="na">if</span> <span class="nv">$__wcf</span><span class="o">-&gt;</span><span class="na">session</span><span class="o">-&gt;</span><span class="na">getPermission</span><span class="o">(</span><span class="s1">&#39;user.person.canAddInformation&#39;</span><span class="o">)</span><span class="cp">}</span><span class="kc">true</span><span class="cp">{</span><span class="na">else</span><span class="cp">}</span><span class="kc">false</span><span class="cp">{</span><span class="o">/</span><span class="na">if</span><span class="cp">}</span><span class="o">,</span>
2834         <span class="cp">}</span><span class="o">);</span>
2835     <span class="cp">}</span><span class="x">);</span>
2836 <span class="x">&lt;/script&gt;</span>
2837
2838 <span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="cp">}</span><span class="x"></span>
2839 </code></pre></div>
2840 </td></tr></table>
2841 <p>To keep things simple here, we reuse the structure and CSS classes used for comments.
2842 Additionally, we always list all pieces of information.
2843 If there are many pieces of information, a nicer solution would be a pagination or loading more pieces of information with JavaScript.</p>
2844 <p>First, we note the <code>jsObjectActionContainer</code> class in combination with the <code>data-object-action-class-name</code> attribute, which are needed for the delete button for each piece of information, as explained <a href="../../../migration/wsc53/javascript/#wcfactiondelete-and-wcfactiontoggle">here</a>.
2845 In <code>PersonInformationAction</code>, we have overridden the default implementations of <code>validateDelete()</code> and <code>delete()</code> which are called after clicking on a delete button.
2846 In <code>validateDelete()</code>, we call <code>PersonInformation::canDelete()</code> on all pieces of information to be deleted for proper permission validation, and in <code>delete()</code>, we update the <code>informationCount</code> values of the people the deleted pieces of information belong to (see below).</p>
2847 <p>The button to add a new piece of information, <code>#personInformationAddButton</code>, and the buttons to edit existing pieces of information, <code>.jsEditInformation</code>, are controlled with JavaScript code initialized at the very end of the template.</p>
2848 <p>Lastly, in <code>create()</code> we provide default values for the <code>time</code>, <code>userID</code>, <code>username</code>, and <code>ipAddress</code> for cases like here when creating a new piece of information, where do not explicitly provide this data.
2849 Additionally, we extract the information text from the <code>information_htmlInputProcessor</code> parameter provided by the associated WYSIWYG form field and update the number of pieces of information created for the relevant person.</p>
2850 <h2 id="creating-and-editing-person-information">Creating and Editing Person Information<a class="headerlink" href="#creating-and-editing-person-information" title="Permanent link">#</a></h2>
2851 <p>To create new pieces of information or editing existing ones, we do not add new form controllers but instead use dialogs generated by the form builder API so that the user does not have to leave the person page.</p>
2852 <p>When clicking on the add button or on any of the edit buttons, a dialog opens with the relevant form:</p>
2853 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2854 <span class="normal"> 2</span>
2855 <span class="normal"> 3</span>
2856 <span class="normal"> 4</span>
2857 <span class="normal"> 5</span>
2858 <span class="normal"> 6</span>
2859 <span class="normal"> 7</span>
2860 <span class="normal"> 8</span>
2861 <span class="normal"> 9</span>
2862 <span class="normal">10</span>
2863 <span class="normal">11</span>
2864 <span class="normal">12</span>
2865 <span class="normal">13</span>
2866 <span class="normal">14</span>
2867 <span class="normal">15</span>
2868 <span class="normal">16</span>
2869 <span class="normal">17</span>
2870 <span class="normal">18</span>
2871 <span class="normal">19</span>
2872 <span class="normal">20</span>
2873 <span class="normal">21</span>
2874 <span class="normal">22</span>
2875 <span class="normal">23</span>
2876 <span class="normal">24</span>
2877 <span class="normal">25</span>
2878 <span class="normal">26</span>
2879 <span class="normal">27</span>
2880 <span class="normal">28</span>
2881 <span class="normal">29</span>
2882 <span class="normal">30</span>
2883 <span class="normal">31</span>
2884 <span class="normal">32</span>
2885 <span class="normal">33</span>
2886 <span class="normal">34</span>
2887 <span class="normal">35</span>
2888 <span class="normal">36</span>
2889 <span class="normal">37</span>
2890 <span class="normal">38</span>
2891 <span class="normal">39</span>
2892 <span class="normal">40</span>
2893 <span class="normal">41</span>
2894 <span class="normal">42</span>
2895 <span class="normal">43</span>
2896 <span class="normal">44</span>
2897 <span class="normal">45</span>
2898 <span class="normal">46</span>
2899 <span class="normal">47</span>
2900 <span class="normal">48</span>
2901 <span class="normal">49</span>
2902 <span class="normal">50</span>
2903 <span class="normal">51</span>
2904 <span class="normal">52</span>
2905 <span class="normal">53</span>
2906 <span class="normal">54</span>
2907 <span class="normal">55</span>
2908 <span class="normal">56</span>
2909 <span class="normal">57</span>
2910 <span class="normal">58</span>
2911 <span class="normal">59</span>
2912 <span class="normal">60</span>
2913 <span class="normal">61</span>
2914 <span class="normal">62</span>
2915 <span class="normal">63</span>
2916 <span class="normal">64</span>
2917 <span class="normal">65</span>
2918 <span class="normal">66</span>
2919 <span class="normal">67</span>
2920 <span class="normal">68</span>
2921 <span class="normal">69</span>
2922 <span class="normal">70</span>
2923 <span class="normal">71</span>
2924 <span class="normal">72</span>
2925 <span class="normal">73</span>
2926 <span class="normal">74</span>
2927 <span class="normal">75</span>
2928 <span class="normal">76</span>
2929 <span class="normal">77</span>
2930 <span class="normal">78</span>
2931 <span class="normal">79</span>
2932 <span class="normal">80</span>
2933 <span class="normal">81</span>
2934 <span class="normal">82</span>
2935 <span class="normal">83</span>
2936 <span class="normal">84</span>
2937 <span class="normal">85</span>
2938 <span class="normal">86</span>
2939 <span class="normal">87</span>
2940 <span class="normal">88</span>
2941 <span class="normal">89</span>
2942 <span class="normal">90</span>
2943 <span class="normal">91</span>
2944 <span class="normal">92</span>
2945 <span class="normal">93</span>
2946 <span class="normal">94</span>
2947 <span class="normal">95</span>
2948 <span class="normal">96</span>
2949 <span class="normal">97</span>
2950 <span class="normal">98</span>
2951 <span class="normal">99</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="cm">/**</span>
2952 <span class="cm"> * Provides the JavaScript code for the person page.</span>
2953 <span class="cm"> *</span>
2954 <span class="cm"> * @author  Matthias Schmidt</span>
2955 <span class="cm"> * @copyright  2001-2021 WoltLab GmbH</span>
2956 <span class="cm"> * @license  GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2957 <span class="cm"> * @module  WoltLabSuite/Core/Controller/Person</span>
2958 <span class="cm"> */</span>
2959
2960 <span class="k">import</span> <span class="nx">FormBuilderDialog</span> <span class="nx">from</span> <span class="s2">&quot;WoltLabSuite/Core/Form/Builder/Dialog&quot;</span><span class="p">;</span>
2961 <span class="k">import</span> <span class="o">*</span> <span class="kr">as</span> <span class="nx">Language</span> <span class="nx">from</span> <span class="s2">&quot;WoltLabSuite/Core/Language&quot;</span><span class="p">;</span>
2962 <span class="k">import</span> <span class="o">*</span> <span class="kr">as</span> <span class="nx">UiNotification</span> <span class="nx">from</span> <span class="s2">&quot;WoltLabSuite/Core/Ui/Notification&quot;</span><span class="p">;</span>
2963
2964 <span class="kd">let</span> <span class="nx">addDialog</span>: <span class="kt">FormBuilderDialog</span><span class="p">;</span>
2965 <span class="kd">const</span> <span class="nx">editDialogs</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Map</span><span class="o">&lt;</span><span class="kt">string</span><span class="p">,</span> <span class="nx">FormBuilderDialog</span><span class="o">&gt;</span><span class="p">();</span>
2966
2967 <span class="kd">interface</span> <span class="nx">EditReturnValues</span> <span class="p">{</span>
2968   <span class="nx">formattedInformation</span>: <span class="kt">string</span><span class="p">;</span>
2969   <span class="nx">informationID</span>: <span class="kt">number</span><span class="p">;</span>
2970 <span class="p">}</span>
2971
2972 <span class="kd">interface</span> <span class="nx">Options</span> <span class="p">{</span>
2973   <span class="nx">canAddInformation</span>: <span class="kt">true</span><span class="p">;</span>
2974 <span class="p">}</span>
2975
2976 <span class="cm">/**</span>
2977 <span class="cm"> * Opens the edit dialog after clicking on the edit button for a piece of information.</span>
2978 <span class="cm"> */</span>
2979 <span class="kd">function</span> <span class="nx">editInformation</span><span class="p">(</span><span class="nx">event</span>: <span class="kt">Event</span><span class="p">)</span><span class="o">:</span> <span class="k">void</span> <span class="p">{</span>
2980   <span class="nx">event</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">();</span>
2981
2982   <span class="kd">const</span> <span class="nx">currentTarget</span> <span class="o">=</span> <span class="nx">event</span><span class="p">.</span><span class="nx">currentTarget</span> <span class="kr">as</span> <span class="nx">HTMLElement</span><span class="p">;</span>
2983   <span class="kd">const</span> <span class="nx">information</span> <span class="o">=</span> <span class="nx">currentTarget</span><span class="p">.</span><span class="nx">closest</span><span class="p">(</span><span class="s2">&quot;.jsObjectActionObject&quot;</span><span class="p">)</span> <span class="kr">as</span> <span class="nx">HTMLElement</span><span class="p">;</span>
2984   <span class="kd">const</span> <span class="nx">informationId</span> <span class="o">=</span> <span class="nx">information</span><span class="p">.</span><span class="nx">dataset</span><span class="p">.</span><span class="nx">objectId</span><span class="o">!</span><span class="p">;</span>
2985
2986   <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">editDialogs</span><span class="p">.</span><span class="nx">has</span><span class="p">(</span><span class="nx">informationId</span><span class="p">))</span> <span class="p">{</span>
2987     <span class="nx">editDialogs</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span>
2988       <span class="nx">informationId</span><span class="p">,</span>
2989       <span class="k">new</span> <span class="nx">FormBuilderDialog</span><span class="p">(</span>
2990         <span class="sb">`personInformationEditDialog</span><span class="si">${</span><span class="nx">informationId</span><span class="si">}</span><span class="sb">`</span><span class="p">,</span>
2991         <span class="s2">&quot;wcf\\data\\person\\information\\PersonInformationAction&quot;</span><span class="p">,</span>
2992         <span class="s2">&quot;getEditDialog&quot;</span><span class="p">,</span>
2993         <span class="p">{</span>
2994           <span class="nx">actionParameters</span><span class="o">:</span> <span class="p">{</span>
2995             <span class="nx">informationID</span>: <span class="kt">informationId</span><span class="p">,</span>
2996           <span class="p">},</span>
2997           <span class="nx">dialog</span><span class="o">:</span> <span class="p">{</span>
2998             <span class="nx">title</span>: <span class="kt">Language.get</span><span class="p">(</span><span class="s2">&quot;wcf.person.information.edit&quot;</span><span class="p">),</span>
2999           <span class="p">},</span>
3000           <span class="nx">submitActionName</span><span class="o">:</span> <span class="s2">&quot;submitEditDialog&quot;</span><span class="p">,</span>
3001           <span class="nx">successCallback</span><span class="p">(</span><span class="nx">returnValues</span>: <span class="kt">EditReturnValues</span><span class="p">)</span> <span class="p">{</span>
3002             <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="sb">`personInformation</span><span class="si">${</span><span class="nx">returnValues</span><span class="p">.</span><span class="nx">informationID</span><span class="si">}</span><span class="sb">`</span><span class="p">)</span><span class="o">!</span><span class="p">.</span><span class="nx">innerHTML</span> <span class="o">=</span>
3003               <span class="nx">returnValues</span><span class="p">.</span><span class="nx">formattedInformation</span><span class="p">;</span>
3004
3005             <span class="nx">UiNotification</span><span class="p">.</span><span class="nx">show</span><span class="p">(</span><span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;wcf.person.information.edit.success&quot;</span><span class="p">));</span>
3006           <span class="p">},</span>
3007         <span class="p">},</span>
3008       <span class="p">),</span>
3009     <span class="p">);</span>
3010   <span class="p">}</span>
3011
3012   <span class="nx">editDialogs</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="nx">informationId</span><span class="p">)</span><span class="o">!</span><span class="p">.</span><span class="nx">open</span><span class="p">();</span>
3013 <span class="p">}</span>
3014
3015 <span class="cm">/**</span>
3016 <span class="cm"> * Initializes the JavaScript code for the person page.</span>
3017 <span class="cm"> */</span>
3018 <span class="k">export</span> <span class="kd">function</span> <span class="nx">init</span><span class="p">(</span><span class="nx">personId</span>: <span class="kt">number</span><span class="p">,</span> <span class="nx">options</span>: <span class="kt">Options</span><span class="p">)</span><span class="o">:</span> <span class="k">void</span> <span class="p">{</span>
3019   <span class="k">if</span> <span class="p">(</span><span class="nx">options</span><span class="p">.</span><span class="nx">canAddInformation</span><span class="p">)</span> <span class="p">{</span>
3020     <span class="c1">// Initialize the dialog to add new information.</span>
3021     <span class="nx">addDialog</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">FormBuilderDialog</span><span class="p">(</span>
3022       <span class="s2">&quot;personInformationAddDialog&quot;</span><span class="p">,</span>
3023       <span class="s2">&quot;wcf\\data\\person\\information\\PersonInformationAction&quot;</span><span class="p">,</span>
3024       <span class="s2">&quot;getAddDialog&quot;</span><span class="p">,</span>
3025       <span class="p">{</span>
3026         <span class="nx">actionParameters</span><span class="o">:</span> <span class="p">{</span>
3027           <span class="nx">personID</span>: <span class="kt">personId</span><span class="p">,</span>
3028         <span class="p">},</span>
3029         <span class="nx">dialog</span><span class="o">:</span> <span class="p">{</span>
3030           <span class="nx">title</span>: <span class="kt">Language.get</span><span class="p">(</span><span class="s2">&quot;wcf.person.information.add&quot;</span><span class="p">),</span>
3031         <span class="p">},</span>
3032         <span class="nx">submitActionName</span><span class="o">:</span> <span class="s2">&quot;submitAddDialog&quot;</span><span class="p">,</span>
3033         <span class="nx">successCallback</span><span class="p">()</span> <span class="p">{</span>
3034           <span class="nx">UiNotification</span><span class="p">.</span><span class="nx">show</span><span class="p">(</span><span class="nx">Language</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="s2">&quot;wcf.person.information.add.success&quot;</span><span class="p">),</span> <span class="p">()</span> <span class="o">=&gt;</span> <span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">reload</span><span class="p">());</span>
3035         <span class="p">},</span>
3036       <span class="p">},</span>
3037     <span class="p">);</span>
3038
3039     <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s2">&quot;personInformationAddButton&quot;</span><span class="p">)</span><span class="o">!</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s2">&quot;click&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">event</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="p">{</span>
3040       <span class="nx">event</span><span class="p">.</span><span class="nx">preventDefault</span><span class="p">();</span>
3041
3042       <span class="nx">addDialog</span><span class="p">.</span><span class="nx">open</span><span class="p">();</span>
3043     <span class="p">});</span>
3044   <span class="p">}</span>
3045
3046   <span class="nb">document</span>
3047     <span class="p">.</span><span class="nx">querySelectorAll</span><span class="p">(</span><span class="s2">&quot;.jsEditInformation&quot;</span><span class="p">)</span>
3048     <span class="p">.</span><span class="nx">forEach</span><span class="p">((</span><span class="nx">el</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="nx">el</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s2">&quot;click&quot;</span><span class="p">,</span> <span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="nx">editInformation</span><span class="p">(</span><span class="nx">ev</span><span class="p">)));</span>
3049 <span class="p">}</span>
3050 </code></pre></div>
3051 </td></tr></table>
3052 <p>We use the <a href="https://github.com/WoltLab/WCF/blob/master/ts/WoltLabSuite/Core/Form/Builder/Dialog.ts"><code>WoltLabSuite/Core/Form/Builder/Dialog</code> module</a>, which takes care of the internal handling with regard to these dialogs.
3053 We only have to provide some data during for initializing these objects and call the <code>open()</code> function after a button has been clicked.</p>
3054 <p>Explanation of the initialization arguments for <code>WoltLabSuite/Core/Form/Builder/Dialog</code> used here:</p>
3055 <ul>
3056 <li>The first argument is the id of the dialog used to identify it.</li>
3057 <li>The second argument is the PHP class name which provides the contents of the dialog's form and handles the data after the form is submitted.</li>
3058 <li>The third argument is the name of the method in the referenced PHP class in the previous argument that returns the dialog form.</li>
3059 <li>The fourth argument contains additional options:<ul>
3060 <li><code>actionParameters</code> are additional parameters send during each AJAX request.
3061   Here, we either pass the id of the person for who a new piece of information is added or the id of the edited piece of information.</li>
3062 <li><code>dialog</code> contains the options for the dialog, see the <code>DialogOptions</code> interface.
3063   Here, we only provide the title of the dialog.</li>
3064 <li><code>submitActionName</code> is the name of the method in the referenced PHP class that is called with the form data after submitting the form.</li>
3065 <li><code>successCallback</code> is called after the submit AJAX request was successful.
3066   After adding a new piece of information, we reload the page, and after editing an existing piece of information, we update the existing information text with the updated text.
3067   (Dynamically inserting a newly added piece of information instead of reloading the page would also be possible, of course, but for this tutorial series, we kept things simple.)</li>
3068 </ul>
3069 </li>
3070 </ul>
3071 <p>Next, we focus on <code>PersonInformationAction</code>, which actually provides the contents of these dialogs and creates and edits the information:</p>
3072 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">  1</span>
3073 <span class="normal">  2</span>
3074 <span class="normal">  3</span>
3075 <span class="normal">  4</span>
3076 <span class="normal">  5</span>
3077 <span class="normal">  6</span>
3078 <span class="normal">  7</span>
3079 <span class="normal">  8</span>
3080 <span class="normal">  9</span>
3081 <span class="normal"> 10</span>
3082 <span class="normal"> 11</span>
3083 <span class="normal"> 12</span>
3084 <span class="normal"> 13</span>
3085 <span class="normal"> 14</span>
3086 <span class="normal"> 15</span>
3087 <span class="normal"> 16</span>
3088 <span class="normal"> 17</span>
3089 <span class="normal"> 18</span>
3090 <span class="normal"> 19</span>
3091 <span class="normal"> 20</span>
3092 <span class="normal"> 21</span>
3093 <span class="normal"> 22</span>
3094 <span class="normal"> 23</span>
3095 <span class="normal"> 24</span>
3096 <span class="normal"> 25</span>
3097 <span class="normal"> 26</span>
3098 <span class="normal"> 27</span>
3099 <span class="normal"> 28</span>
3100 <span class="normal"> 29</span>
3101 <span class="normal"> 30</span>
3102 <span class="normal"> 31</span>
3103 <span class="normal"> 32</span>
3104 <span class="normal"> 33</span>
3105 <span class="normal"> 34</span>
3106 <span class="normal"> 35</span>
3107 <span class="normal"> 36</span>
3108 <span class="normal"> 37</span>
3109 <span class="normal"> 38</span>
3110 <span class="normal"> 39</span>
3111 <span class="normal"> 40</span>
3112 <span class="normal"> 41</span>
3113 <span class="normal"> 42</span>
3114 <span class="normal"> 43</span>
3115 <span class="normal"> 44</span>
3116 <span class="normal"> 45</span>
3117 <span class="normal"> 46</span>
3118 <span class="normal"> 47</span>
3119 <span class="normal"> 48</span>
3120 <span class="normal"> 49</span>
3121 <span class="normal"> 50</span>
3122 <span class="normal"> 51</span>
3123 <span class="normal"> 52</span>
3124 <span class="normal"> 53</span>
3125 <span class="normal"> 54</span>
3126 <span class="normal"> 55</span>
3127 <span class="normal"> 56</span>
3128 <span class="normal"> 57</span>
3129 <span class="normal"> 58</span>
3130 <span class="normal"> 59</span>
3131 <span class="normal"> 60</span>
3132 <span class="normal"> 61</span>
3133 <span class="normal"> 62</span>
3134 <span class="normal"> 63</span>
3135 <span class="normal"> 64</span>
3136 <span class="normal"> 65</span>
3137 <span class="normal"> 66</span>
3138 <span class="normal"> 67</span>
3139 <span class="normal"> 68</span>
3140 <span class="normal"> 69</span>
3141 <span class="normal"> 70</span>
3142 <span class="normal"> 71</span>
3143 <span class="normal"> 72</span>
3144 <span class="normal"> 73</span>
3145 <span class="normal"> 74</span>
3146 <span class="normal"> 75</span>
3147 <span class="normal"> 76</span>
3148 <span class="normal"> 77</span>
3149 <span class="normal"> 78</span>
3150 <span class="normal"> 79</span>
3151 <span class="normal"> 80</span>
3152 <span class="normal"> 81</span>
3153 <span class="normal"> 82</span>
3154 <span class="normal"> 83</span>
3155 <span class="normal"> 84</span>
3156 <span class="normal"> 85</span>
3157 <span class="normal"> 86</span>
3158 <span class="normal"> 87</span>
3159 <span class="normal"> 88</span>
3160 <span class="normal"> 89</span>
3161 <span class="normal"> 90</span>
3162 <span class="normal"> 91</span>
3163 <span class="normal"> 92</span>
3164 <span class="normal"> 93</span>
3165 <span class="normal"> 94</span>
3166 <span class="normal"> 95</span>
3167 <span class="normal"> 96</span>
3168 <span class="normal"> 97</span>
3169 <span class="normal"> 98</span>
3170 <span class="normal"> 99</span>
3171 <span class="normal">100</span>
3172 <span class="normal">101</span>
3173 <span class="normal">102</span>
3174 <span class="normal">103</span>
3175 <span class="normal">104</span>
3176 <span class="normal">105</span>
3177 <span class="normal">106</span>
3178 <span class="normal">107</span>
3179 <span class="normal">108</span>
3180 <span class="normal">109</span>
3181 <span class="normal">110</span>
3182 <span class="normal">111</span>
3183 <span class="normal">112</span>
3184 <span class="normal">113</span>
3185 <span class="normal">114</span>
3186 <span class="normal">115</span>
3187 <span class="normal">116</span>
3188 <span class="normal">117</span>
3189 <span class="normal">118</span>
3190 <span class="normal">119</span>
3191 <span class="normal">120</span>
3192 <span class="normal">121</span>
3193 <span class="normal">122</span>
3194 <span class="normal">123</span>
3195 <span class="normal">124</span>
3196 <span class="normal">125</span>
3197 <span class="normal">126</span>
3198 <span class="normal">127</span>
3199 <span class="normal">128</span>
3200 <span class="normal">129</span>
3201 <span class="normal">130</span>
3202 <span class="normal">131</span>
3203 <span class="normal">132</span>
3204 <span class="normal">133</span>
3205 <span class="normal">134</span>
3206 <span class="normal">135</span>
3207 <span class="normal">136</span>
3208 <span class="normal">137</span>
3209 <span class="normal">138</span>
3210 <span class="normal">139</span>
3211 <span class="normal">140</span>
3212 <span class="normal">141</span>
3213 <span class="normal">142</span>
3214 <span class="normal">143</span>
3215 <span class="normal">144</span>
3216 <span class="normal">145</span>
3217 <span class="normal">146</span>
3218 <span class="normal">147</span>
3219 <span class="normal">148</span>
3220 <span class="normal">149</span>
3221 <span class="normal">150</span>
3222 <span class="normal">151</span>
3223 <span class="normal">152</span>
3224 <span class="normal">153</span>
3225 <span class="normal">154</span>
3226 <span class="normal">155</span>
3227 <span class="normal">156</span>
3228 <span class="normal">157</span>
3229 <span class="normal">158</span>
3230 <span class="normal">159</span>
3231 <span class="normal">160</span>
3232 <span class="normal">161</span>
3233 <span class="normal">162</span>
3234 <span class="normal">163</span>
3235 <span class="normal">164</span>
3236 <span class="normal">165</span>
3237 <span class="normal">166</span>
3238 <span class="normal">167</span>
3239 <span class="normal">168</span>
3240 <span class="normal">169</span>
3241 <span class="normal">170</span>
3242 <span class="normal">171</span>
3243 <span class="normal">172</span>
3244 <span class="normal">173</span>
3245 <span class="normal">174</span>
3246 <span class="normal">175</span>
3247 <span class="normal">176</span>
3248 <span class="normal">177</span>
3249 <span class="normal">178</span>
3250 <span class="normal">179</span>
3251 <span class="normal">180</span>
3252 <span class="normal">181</span>
3253 <span class="normal">182</span>
3254 <span class="normal">183</span>
3255 <span class="normal">184</span>
3256 <span class="normal">185</span>
3257 <span class="normal">186</span>
3258 <span class="normal">187</span>
3259 <span class="normal">188</span>
3260 <span class="normal">189</span>
3261 <span class="normal">190</span>
3262 <span class="normal">191</span>
3263 <span class="normal">192</span>
3264 <span class="normal">193</span>
3265 <span class="normal">194</span>
3266 <span class="normal">195</span>
3267 <span class="normal">196</span>
3268 <span class="normal">197</span>
3269 <span class="normal">198</span>
3270 <span class="normal">199</span>
3271 <span class="normal">200</span>
3272 <span class="normal">201</span>
3273 <span class="normal">202</span>
3274 <span class="normal">203</span>
3275 <span class="normal">204</span>
3276 <span class="normal">205</span>
3277 <span class="normal">206</span>
3278 <span class="normal">207</span>
3279 <span class="normal">208</span>
3280 <span class="normal">209</span>
3281 <span class="normal">210</span>
3282 <span class="normal">211</span>
3283 <span class="normal">212</span>
3284 <span class="normal">213</span>
3285 <span class="normal">214</span>
3286 <span class="normal">215</span>
3287 <span class="normal">216</span>
3288 <span class="normal">217</span>
3289 <span class="normal">218</span>
3290 <span class="normal">219</span>
3291 <span class="normal">220</span>
3292 <span class="normal">221</span>
3293 <span class="normal">222</span>
3294 <span class="normal">223</span>
3295 <span class="normal">224</span>
3296 <span class="normal">225</span>
3297 <span class="normal">226</span>
3298 <span class="normal">227</span>
3299 <span class="normal">228</span>
3300 <span class="normal">229</span>
3301 <span class="normal">230</span>
3302 <span class="normal">231</span>
3303 <span class="normal">232</span>
3304 <span class="normal">233</span>
3305 <span class="normal">234</span>
3306 <span class="normal">235</span>
3307 <span class="normal">236</span>
3308 <span class="normal">237</span>
3309 <span class="normal">238</span>
3310 <span class="normal">239</span>
3311 <span class="normal">240</span>
3312 <span class="normal">241</span>
3313 <span class="normal">242</span>
3314 <span class="normal">243</span>
3315 <span class="normal">244</span>
3316 <span class="normal">245</span>
3317 <span class="normal">246</span>
3318 <span class="normal">247</span>
3319 <span class="normal">248</span>
3320 <span class="normal">249</span>
3321 <span class="normal">250</span>
3322 <span class="normal">251</span>
3323 <span class="normal">252</span>
3324 <span class="normal">253</span>
3325 <span class="normal">254</span>
3326 <span class="normal">255</span>
3327 <span class="normal">256</span>
3328 <span class="normal">257</span>
3329 <span class="normal">258</span>
3330 <span class="normal">259</span>
3331 <span class="normal">260</span>
3332 <span class="normal">261</span>
3333 <span class="normal">262</span>
3334 <span class="normal">263</span>
3335 <span class="normal">264</span>
3336 <span class="normal">265</span>
3337 <span class="normal">266</span>
3338 <span class="normal">267</span>
3339 <span class="normal">268</span>
3340 <span class="normal">269</span>
3341 <span class="normal">270</span>
3342 <span class="normal">271</span>
3343 <span class="normal">272</span>
3344 <span class="normal">273</span>
3345 <span class="normal">274</span>
3346 <span class="normal">275</span>
3347 <span class="normal">276</span>
3348 <span class="normal">277</span>
3349 <span class="normal">278</span>
3350 <span class="normal">279</span>
3351 <span class="normal">280</span>
3352 <span class="normal">281</span>
3353 <span class="normal">282</span>
3354 <span class="normal">283</span>
3355 <span class="normal">284</span>
3356 <span class="normal">285</span>
3357 <span class="normal">286</span>
3358 <span class="normal">287</span>
3359 <span class="normal">288</span>
3360 <span class="normal">289</span>
3361 <span class="normal">290</span>
3362 <span class="normal">291</span>
3363 <span class="normal">292</span>
3364 <span class="normal">293</span>
3365 <span class="normal">294</span>
3366 <span class="normal">295</span>
3367 <span class="normal">296</span>
3368 <span class="normal">297</span>
3369 <span class="normal">298</span>
3370 <span class="normal">299</span>
3371 <span class="normal">300</span>
3372 <span class="normal">301</span>
3373 <span class="normal">302</span>
3374 <span class="normal">303</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3375
3376 <span class="k">namespace</span> <span class="nx">wcf\data\person\information</span><span class="p">;</span>
3377
3378 <span class="k">use</span> <span class="nx">wcf\data\AbstractDatabaseObjectAction</span><span class="p">;</span>
3379 <span class="k">use</span> <span class="nx">wcf\data\person\PersonAction</span><span class="p">;</span>
3380 <span class="k">use</span> <span class="nx">wcf\data\person\PersonEditor</span><span class="p">;</span>
3381 <span class="k">use</span> <span class="nx">wcf\system\cache\runtime\PersonRuntimeCache</span><span class="p">;</span>
3382 <span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
3383 <span class="k">use</span> <span class="nx">wcf\system\exception\IllegalLinkException</span><span class="p">;</span>
3384 <span class="k">use</span> <span class="nx">wcf\system\exception\PermissionDeniedException</span><span class="p">;</span>
3385 <span class="k">use</span> <span class="nx">wcf\system\exception\UserInputException</span><span class="p">;</span>
3386 <span class="k">use</span> <span class="nx">wcf\system\form\builder\container\wysiwyg\WysiwygFormContainer</span><span class="p">;</span>
3387 <span class="k">use</span> <span class="nx">wcf\system\form\builder\DialogFormDocument</span><span class="p">;</span>
3388 <span class="k">use</span> <span class="nx">wcf\system\html\input\HtmlInputProcessor</span><span class="p">;</span>
3389 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
3390
3391 <span class="sd">/**</span>
3392 <span class="sd"> * Executes person information-related actions.</span>
3393 <span class="sd"> *</span>
3394 <span class="sd"> * @author  Matthias Schmidt</span>
3395 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3396 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3397 <span class="sd"> * @package WoltLabSuite\Core\Data\Person\Information</span>
3398 <span class="sd"> *</span>
3399 <span class="sd"> * @method  PersonInformationEditor[]   getObjects()</span>
3400 <span class="sd"> * @method  PersonInformationEditor     getSingleObject()</span>
3401 <span class="sd"> */</span>
3402 <span class="k">class</span> <span class="nc">PersonInformationAction</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseObjectAction</span>
3403 <span class="p">{</span>
3404     <span class="sd">/**</span>
3405 <span class="sd">     * @var DialogFormDocument</span>
3406 <span class="sd">     */</span>
3407     <span class="k">public</span> <span class="nv">$dialog</span><span class="p">;</span>
3408
3409     <span class="sd">/**</span>
3410 <span class="sd">     * @var PersonInformation</span>
3411 <span class="sd">     */</span>
3412     <span class="k">public</span> <span class="nv">$information</span><span class="p">;</span>
3413
3414     <span class="sd">/**</span>
3415 <span class="sd">     * @return  PersonInformation</span>
3416 <span class="sd">     */</span>
3417     <span class="k">public</span> <span class="k">function</span> <span class="nf">create</span><span class="p">()</span>
3418     <span class="p">{</span>
3419         <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;time&#39;</span><span class="p">]))</span> <span class="p">{</span>
3420             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;time&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nx">TIME_NOW</span><span class="p">;</span>
3421         <span class="p">}</span>
3422         <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;userID&#39;</span><span class="p">]))</span> <span class="p">{</span>
3423             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;userID&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">userID</span><span class="p">;</span>
3424             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;username&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getUser</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">username</span><span class="p">;</span>
3425         <span class="p">}</span>
3426
3427         <span class="k">if</span> <span class="p">(</span><span class="nx">LOG_IP_ADDRESS</span><span class="p">)</span> <span class="p">{</span>
3428             <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;ipAddress&#39;</span><span class="p">]))</span> <span class="p">{</span>
3429                 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;ipAddress&#39;</span><span class="p">]</span> <span class="o">=</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">ipAddress</span><span class="p">;</span>
3430             <span class="p">}</span>
3431         <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
3432             <span class="nb">unset</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;ipAddress&#39;</span><span class="p">]);</span>
3433         <span class="p">}</span>
3434
3435         <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;information_htmlInputProcessor&#39;</span><span class="p">]))</span> <span class="p">{</span>
3436             <span class="sd">/** @var HtmlInputProcessor $htmlInputProcessor */</span>
3437             <span class="nv">$htmlInputProcessor</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;information_htmlInputProcessor&#39;</span><span class="p">];</span>
3438             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;information&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nv">$htmlInputProcessor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
3439         <span class="p">}</span>
3440
3441         <span class="sd">/** @var PersonInformation $information */</span>
3442         <span class="nv">$information</span> <span class="o">=</span> <span class="k">parent</span><span class="o">::</span><span class="na">create</span><span class="p">();</span>
3443
3444         <span class="p">(</span><span class="k">new</span> <span class="nx">PersonAction</span><span class="p">([</span><span class="nv">$information</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">],</span> <span class="s1">&#39;update&#39;</span><span class="p">,</span> <span class="p">[</span>
3445             <span class="s1">&#39;counters&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
3446                 <span class="s1">&#39;informationCount&#39;</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">,</span>
3447             <span class="p">],</span>
3448         <span class="p">]))</span><span class="o">-&gt;</span><span class="na">executeAction</span><span class="p">();</span>
3449
3450         <span class="k">return</span> <span class="nv">$information</span><span class="p">;</span>
3451     <span class="p">}</span>
3452
3453     <span class="sd">/**</span>
3454 <span class="sd">     * @inheritDoc</span>
3455 <span class="sd">     */</span>
3456     <span class="k">public</span> <span class="k">function</span> <span class="nf">update</span><span class="p">()</span>
3457     <span class="p">{</span>
3458         <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;information_htmlInputProcessor&#39;</span><span class="p">]))</span> <span class="p">{</span>
3459             <span class="sd">/** @var HtmlInputProcessor $htmlInputProcessor */</span>
3460             <span class="nv">$htmlInputProcessor</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;information_htmlInputProcessor&#39;</span><span class="p">];</span>
3461             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;data&#39;</span><span class="p">][</span><span class="s1">&#39;information&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="nv">$htmlInputProcessor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
3462         <span class="p">}</span>
3463
3464         <span class="k">parent</span><span class="o">::</span><span class="na">update</span><span class="p">();</span>
3465     <span class="p">}</span>
3466
3467     <span class="sd">/**</span>
3468 <span class="sd">     * @inheritDoc</span>
3469 <span class="sd">     */</span>
3470     <span class="k">public</span> <span class="k">function</span> <span class="nf">validateDelete</span><span class="p">()</span>
3471     <span class="p">{</span>
3472         <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objects</span><span class="p">))</span> <span class="p">{</span>
3473             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">readObjects</span><span class="p">();</span>
3474
3475             <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objects</span><span class="p">))</span> <span class="p">{</span>
3476                 <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;objectIDs&#39;</span><span class="p">);</span>
3477             <span class="p">}</span>
3478         <span class="p">}</span>
3479
3480         <span class="k">foreach</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getObjects</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$informationEditor</span><span class="p">)</span> <span class="p">{</span>
3481             <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$informationEditor</span><span class="o">-&gt;</span><span class="na">canDelete</span><span class="p">())</span> <span class="p">{</span>
3482                 <span class="k">throw</span> <span class="k">new</span> <span class="nx">PermissionDeniedException</span><span class="p">();</span>
3483             <span class="p">}</span>
3484         <span class="p">}</span>
3485     <span class="p">}</span>
3486
3487     <span class="sd">/**</span>
3488 <span class="sd">     * @inheritDoc</span>
3489 <span class="sd">     */</span>
3490     <span class="k">public</span> <span class="k">function</span> <span class="nf">delete</span><span class="p">()</span>
3491     <span class="p">{</span>
3492         <span class="nv">$deleteCount</span> <span class="o">=</span> <span class="k">parent</span><span class="o">::</span><span class="na">delete</span><span class="p">();</span>
3493
3494         <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$deleteCount</span><span class="p">)</span> <span class="p">{</span>
3495             <span class="k">return</span> <span class="nv">$deleteCount</span><span class="p">;</span>
3496         <span class="p">}</span>
3497
3498         <span class="nv">$counterUpdates</span> <span class="o">=</span> <span class="p">[];</span>
3499         <span class="k">foreach</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getObjects</span><span class="p">()</span> <span class="k">as</span> <span class="nv">$informationEditor</span><span class="p">)</span> <span class="p">{</span>
3500             <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$counterUpdates</span><span class="p">[</span><span class="nv">$informationEditor</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">]))</span> <span class="p">{</span>
3501                 <span class="nv">$counterUpdates</span><span class="p">[</span><span class="nv">$informationEditor</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
3502             <span class="p">}</span>
3503
3504             <span class="nv">$counterUpdates</span><span class="p">[</span><span class="nv">$informationEditor</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">]</span><span class="o">--</span><span class="p">;</span>
3505         <span class="p">}</span>
3506
3507         <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">beginTransaction</span><span class="p">();</span>
3508         <span class="k">foreach</span> <span class="p">(</span><span class="nv">$counterUpdates</span> <span class="k">as</span> <span class="nv">$personID</span> <span class="o">=&gt;</span> <span class="nv">$counterUpdate</span><span class="p">)</span> <span class="p">{</span>
3509             <span class="p">(</span><span class="k">new</span> <span class="nx">PersonEditor</span><span class="p">(</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">$personID</span><span class="p">)))</span><span class="o">-&gt;</span><span class="na">updateCounters</span><span class="p">([</span>
3510                 <span class="s1">&#39;informationCount&#39;</span> <span class="o">=&gt;</span> <span class="nv">$counterUpdate</span><span class="p">,</span>
3511             <span class="p">]);</span>
3512         <span class="p">}</span>
3513         <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">commitTransaction</span><span class="p">();</span>
3514
3515         <span class="k">return</span> <span class="nv">$deleteCount</span><span class="p">;</span>
3516     <span class="p">}</span>
3517
3518     <span class="sd">/**</span>
3519 <span class="sd">     * Validates the `getAddDialog` action.</span>
3520 <span class="sd">     */</span>
3521     <span class="k">public</span> <span class="k">function</span> <span class="nf">validateGetAddDialog</span><span class="p">()</span><span class="o">:</span> <span class="nx">void</span>
3522     <span class="p">{</span>
3523         <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">checkPermissions</span><span class="p">([</span><span class="s1">&#39;user.person.canAddInformation&#39;</span><span class="p">]);</span>
3524
3525         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">readInteger</span><span class="p">(</span><span class="s1">&#39;personID&#39;</span><span class="p">);</span>
3526         <span class="k">if</span> <span class="p">(</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">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;personID&#39;</span><span class="p">])</span> <span class="o">===</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
3527             <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;personID&#39;</span><span class="p">);</span>
3528         <span class="p">}</span>
3529     <span class="p">}</span>
3530
3531     <span class="sd">/**</span>
3532 <span class="sd">     * Returns the data to show the dialog to add a new piece of information on a person.</span>
3533 <span class="sd">     *</span>
3534 <span class="sd">     * @return  string[]</span>
3535 <span class="sd">     */</span>
3536     <span class="k">public</span> <span class="k">function</span> <span class="nf">getAddDialog</span><span class="p">()</span><span class="o">:</span> <span class="k">array</span>
3537     <span class="p">{</span>
3538         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">buildDialog</span><span class="p">();</span>
3539
3540         <span class="k">return</span> <span class="p">[</span>
3541             <span class="s1">&#39;dialog&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">(),</span>
3542             <span class="s1">&#39;formId&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getId</span><span class="p">(),</span>
3543         <span class="p">];</span>
3544     <span class="p">}</span>
3545
3546     <span class="sd">/**</span>
3547 <span class="sd">     * Validates the `submitAddDialog` action.</span>
3548 <span class="sd">     */</span>
3549     <span class="k">public</span> <span class="k">function</span> <span class="nf">validateSubmitAddDialog</span><span class="p">()</span><span class="o">:</span> <span class="nx">void</span>
3550     <span class="p">{</span>
3551         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">validateGetAddDialog</span><span class="p">();</span>
3552
3553         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">buildDialog</span><span class="p">();</span>
3554         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">requestData</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;parameters&#39;</span><span class="p">][</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">??</span> <span class="p">[]);</span>
3555         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">readValues</span><span class="p">();</span>
3556         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">validate</span><span class="p">();</span>
3557     <span class="p">}</span>
3558
3559     <span class="sd">/**</span>
3560 <span class="sd">     * Creates a new piece of information on a person after submitting the dialog.</span>
3561 <span class="sd">     *</span>
3562 <span class="sd">     * @return  string[]</span>
3563 <span class="sd">     */</span>
3564     <span class="k">public</span> <span class="k">function</span> <span class="nf">submitAddDialog</span><span class="p">()</span><span class="o">:</span> <span class="k">array</span>
3565     <span class="p">{</span>
3566         <span class="c1">// If there are any validation errors, show the form again.</span>
3567         <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">hasValidationErrors</span><span class="p">())</span> <span class="p">{</span>
3568             <span class="k">return</span> <span class="p">[</span>
3569                 <span class="s1">&#39;dialog&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">(),</span>
3570                 <span class="s1">&#39;formId&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getId</span><span class="p">(),</span>
3571             <span class="p">];</span>
3572         <span class="p">}</span>
3573
3574         <span class="p">(</span><span class="k">new</span> <span class="k">static</span><span class="p">([],</span> <span class="s1">&#39;create&#39;</span><span class="p">,</span> <span class="nx">\array_merge</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getData</span><span class="p">(),</span> <span class="p">[</span>
3575             <span class="s1">&#39;data&#39;</span> <span class="o">=&gt;</span> <span class="p">[</span>
3576                 <span class="s1">&#39;personID&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;personID&#39;</span><span class="p">],</span>
3577             <span class="p">],</span>
3578         <span class="p">])))</span><span class="o">-&gt;</span><span class="na">executeAction</span><span class="p">();</span>
3579
3580         <span class="k">return</span> <span class="p">[];</span>
3581     <span class="p">}</span>
3582
3583     <span class="sd">/**</span>
3584 <span class="sd">     * Validates the `getEditDialog` action.</span>
3585 <span class="sd">     */</span>
3586     <span class="k">public</span> <span class="k">function</span> <span class="nf">validateGetEditDialog</span><span class="p">()</span><span class="o">:</span> <span class="nx">void</span>
3587     <span class="p">{</span>
3588         <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">checkPermissions</span><span class="p">([</span><span class="s1">&#39;user.person.canAddInformation&#39;</span><span class="p">]);</span>
3589
3590         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">readInteger</span><span class="p">(</span><span class="s1">&#39;informationID&#39;</span><span class="p">);</span>
3591         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PersonInformation</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">parameters</span><span class="p">[</span><span class="s1">&#39;informationID&#39;</span><span class="p">]);</span>
3592         <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">information</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="p">())</span> <span class="p">{</span>
3593             <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;informationID&#39;</span><span class="p">);</span>
3594         <span class="p">}</span>
3595         <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">information</span><span class="o">-&gt;</span><span class="na">canEdit</span><span class="p">())</span> <span class="p">{</span>
3596             <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
3597         <span class="p">}</span>
3598     <span class="p">}</span>
3599
3600     <span class="sd">/**</span>
3601 <span class="sd">     * Returns the data to show the dialog to edit a piece of information on a person.</span>
3602 <span class="sd">     *</span>
3603 <span class="sd">     * @return  string[]</span>
3604 <span class="sd">     */</span>
3605     <span class="k">public</span> <span class="k">function</span> <span class="nf">getEditDialog</span><span class="p">()</span><span class="o">:</span> <span class="k">array</span>
3606     <span class="p">{</span>
3607         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">buildDialog</span><span class="p">();</span>
3608         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">updatedObject</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="p">);</span>
3609
3610         <span class="k">return</span> <span class="p">[</span>
3611             <span class="s1">&#39;dialog&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">(),</span>
3612             <span class="s1">&#39;formId&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getId</span><span class="p">(),</span>
3613         <span class="p">];</span>
3614     <span class="p">}</span>
3615
3616     <span class="sd">/**</span>
3617 <span class="sd">     * Validates the `submitEditDialog` action.</span>
3618 <span class="sd">     */</span>
3619     <span class="k">public</span> <span class="k">function</span> <span class="nf">validateSubmitEditDialog</span><span class="p">()</span><span class="o">:</span> <span class="nx">void</span>
3620     <span class="p">{</span>
3621         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">validateGetEditDialog</span><span class="p">();</span>
3622
3623         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">buildDialog</span><span class="p">();</span>
3624         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">updatedObject</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="p">,</span> <span class="k">false</span><span class="p">);</span>
3625         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">requestData</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;parameters&#39;</span><span class="p">][</span><span class="s1">&#39;data&#39;</span><span class="p">]</span> <span class="o">??</span> <span class="p">[]);</span>
3626         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">readValues</span><span class="p">();</span>
3627         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">validate</span><span class="p">();</span>
3628     <span class="p">}</span>
3629
3630     <span class="sd">/**</span>
3631 <span class="sd">     * Updates a piece of information on a person after submitting the edit dialog.</span>
3632 <span class="sd">     *</span>
3633 <span class="sd">     * @return  string[]</span>
3634 <span class="sd">     */</span>
3635     <span class="k">public</span> <span class="k">function</span> <span class="nf">submitEditDialog</span><span class="p">()</span><span class="o">:</span> <span class="k">array</span>
3636     <span class="p">{</span>
3637         <span class="c1">// If there are any validation errors, show the form again.</span>
3638         <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">hasValidationErrors</span><span class="p">())</span> <span class="p">{</span>
3639             <span class="k">return</span> <span class="p">[</span>
3640                 <span class="s1">&#39;dialog&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">(),</span>
3641                 <span class="s1">&#39;formId&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getId</span><span class="p">(),</span>
3642             <span class="p">];</span>
3643         <span class="p">}</span>
3644
3645         <span class="p">(</span><span class="k">new</span> <span class="k">static</span><span class="p">([</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="p">],</span> <span class="s1">&#39;update&#39;</span><span class="p">,</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">getData</span><span class="p">()))</span><span class="o">-&gt;</span><span class="na">executeAction</span><span class="p">();</span>
3646
3647         <span class="c1">// Reload the information with the updated data.</span>
3648         <span class="nv">$information</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PersonInformation</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="p">());</span>
3649
3650         <span class="k">return</span> <span class="p">[</span>
3651             <span class="s1">&#39;formattedInformation&#39;</span> <span class="o">=&gt;</span> <span class="nv">$information</span><span class="o">-&gt;</span><span class="na">getFormattedInformation</span><span class="p">(),</span>
3652             <span class="s1">&#39;informationID&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">information</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="p">(),</span>
3653         <span class="p">];</span>
3654     <span class="p">}</span>
3655
3656     <span class="sd">/**</span>
3657 <span class="sd">     * Builds the dialog to create or edit person information.</span>
3658 <span class="sd">     */</span>
3659     <span class="k">protected</span> <span class="k">function</span> <span class="nf">buildDialog</span><span class="p">()</span><span class="o">:</span> <span class="nx">void</span>
3660     <span class="p">{</span>
3661         <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span> <span class="o">!==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
3662             <span class="k">return</span><span class="p">;</span>
3663         <span class="p">}</span>
3664
3665         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span> <span class="o">=</span> <span class="nx">DialogFormDocument</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;personInformationAddDialog&#39;</span><span class="p">)</span>
3666             <span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span>
3667                 <span class="nx">WysiwygFormContainer</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;information&#39;</span><span class="p">)</span>
3668                     <span class="o">-&gt;</span><span class="na">messageObjectType</span><span class="p">(</span><span class="s1">&#39;com.woltlab.wcf.people.information&#39;</span><span class="p">)</span>
3669                     <span class="o">-&gt;</span><span class="na">required</span><span class="p">()</span>
3670             <span class="p">);</span>
3671
3672         <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fireAction</span><span class="p">(</span><span class="nv">$this</span><span class="p">,</span> <span class="s1">&#39;buildDialog&#39;</span><span class="p">);</span>
3673
3674         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">dialog</span><span class="o">-&gt;</span><span class="na">build</span><span class="p">();</span>
3675     <span class="p">}</span>
3676 <span class="p">}</span>
3677 </code></pre></div>
3678 </td></tr></table>
3679 <p>When setting up the <code>WoltLabSuite/Core/Form/Builder/Dialog</code> object for adding new pieces of information, we specified <code>getAddDialog</code> and <code>submitAddDialog</code> as the names of the dialog getter and submit handler.
3680 In addition to these two methods, the matching validation methods <code>validateGetAddDialog()</code> and <code>validateGetAddDialog()</code> are also added.
3681 As the forms for adding and editing pieces of information have the same structure, this form is created in <code>buildDialog()</code> using a <code>DialogFormDocument</code> object, which is intended for forms in dialogs.
3682 We fire an event in <code>buildDialog()</code> so that plugins are able to easily extend the dialog with additional data.</p>
3683 <p><code>validateGetAddDialog()</code> checks if the user has the permission to create new pieces of information and if a valid id for the person, the information will belong to, is given.
3684 The method configured in the <code>WoltLabSuite/Core/Form/Builder/Dialog</code> object returning the dialog is expected to return two values:
3685 the id of the form (<code>formId</code>) and the contents of form shown in the dialog (<code>dialog</code>).
3686 This data is returned by <code>getAddDialog</code> using the dialog build previously by <code>buildDialog()</code>.</p>
3687 <p>After the form is submitted, <code>validateSubmitAddDialog()</code> has to do the same basic validation as <code>validateGetAddDialog()</code> so that <code>validateGetAddDialog()</code> is simply called.
3688 Additionally, the form data is read and validated.
3689 In <code>submitAddDialog()</code>, we first check if there have been any validation errors:
3690 If any error occured during validation, we return the same data as in <code>getAddDialog()</code> so that the dialog is shown again with the erroneous fields marked as such.
3691 Otherwise, if the validation succeeded, the form data is used to create the new piece of information.
3692 In addition to the form data, we manually add the id of the person to whom the information belongs to.
3693 Lastly, we could return some data that we could access in the JavaScript callback function after successfully submitting the dialog.
3694 As we will simply be reloading the page, no such data is returned.
3695 An alternative to reloading to the page would be dynamically inserting the new piece of information in the list so that we would have to return the rendered list item for the new piece of information.</p>
3696 <p>The process for getting and submitting the dialog to edit existing pieces of information is similar to the process for adding new pieces of information.
3697 Instead of the id of the person, however, we now pass the id of the edited piece of information and in <code>submitEditDialog()</code>, we update the edited information instead of creating a new one like in <code>submitAddDialog()</code>.
3698 After editing a piece of information, we do not reload the page but dynamically update the text of the information in the TypeScript code so that we return the updated rendered information text and id of the edited pieced of information in <code>submitAddDialog()</code>.</p>
3699 <h2 id="username-and-ip-address-event-listeners">Username and IP Address Event Listeners<a class="headerlink" href="#username-and-ip-address-event-listeners" title="Permanent link">#</a></h2>
3700 <p>As we store the name of the user who create a new piece of information and store their IP address, we have to add event listeners to properly handle the following scenarios:</p>
3701 <ol>
3702 <li>
3703 <p>If the user is renamed, the value of <code>username</code> stored with the person information has to be updated, which can be achieved by a simple event listener that only has to specify the name of relevant database table if <code>AbstractUserActionRenameListener</code> is extended:</p>
3704 <p><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3705 <span class="normal"> 2</span>
3706 <span class="normal"> 3</span>
3707 <span class="normal"> 4</span>
3708 <span class="normal"> 5</span>
3709 <span class="normal"> 6</span>
3710 <span class="normal"> 7</span>
3711 <span class="normal"> 8</span>
3712 <span class="normal"> 9</span>
3713 <span class="normal">10</span>
3714 <span class="normal">11</span>
3715 <span class="normal">12</span>
3716 <span class="normal">13</span>
3717 <span class="normal">14</span>
3718 <span class="normal">15</span>
3719 <span class="normal">16</span>
3720 <span class="normal">17</span>
3721 <span class="normal">18</span>
3722 <span class="normal">19</span>
3723 <span class="normal">20</span>
3724 <span class="normal">21</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3725
3726 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3727
3728 <span class="sd">/**</span>
3729 <span class="sd"> * Updates person information during user renaming.</span>
3730 <span class="sd"> *</span>
3731 <span class="sd"> * @author  Matthias Schmidt</span>
3732 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3733 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3734 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
3735 <span class="sd"> */</span>
3736 <span class="k">class</span> <span class="nc">PersonUserActionRenameListener</span> <span class="k">extends</span> <span class="nx">AbstractUserActionRenameListener</span>
3737 <span class="p">{</span>
3738     <span class="sd">/**</span>
3739 <span class="sd">     * @inheritDoc</span>
3740 <span class="sd">     */</span>
3741     <span class="k">protected</span> <span class="nv">$databaseTables</span> <span class="o">=</span> <span class="p">[</span>
3742         <span class="s1">&#39;wcf{WCF_N}_person_information&#39;</span><span class="p">,</span>
3743     <span class="p">];</span>
3744 <span class="p">}</span>
3745 </code></pre></div>
3746 </td></tr></table>
3747 2. If users are merged, all pieces of information need to be assigned to the target user of the merging.
3748   Again, we only have to specify the name of relevant database table if <code>AbstractUserMergeListener</code> is extended:</p>
3749 <p><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3750 <span class="normal"> 2</span>
3751 <span class="normal"> 3</span>
3752 <span class="normal"> 4</span>
3753 <span class="normal"> 5</span>
3754 <span class="normal"> 6</span>
3755 <span class="normal"> 7</span>
3756 <span class="normal"> 8</span>
3757 <span class="normal"> 9</span>
3758 <span class="normal">10</span>
3759 <span class="normal">11</span>
3760 <span class="normal">12</span>
3761 <span class="normal">13</span>
3762 <span class="normal">14</span>
3763 <span class="normal">15</span>
3764 <span class="normal">16</span>
3765 <span class="normal">17</span>
3766 <span class="normal">18</span>
3767 <span class="normal">19</span>
3768 <span class="normal">20</span>
3769 <span class="normal">21</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3770
3771 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3772
3773 <span class="sd">/**</span>
3774 <span class="sd"> * Updates person information during user merging.</span>
3775 <span class="sd"> *</span>
3776 <span class="sd"> * @author  Matthias Schmidt</span>
3777 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3778 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3779 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
3780 <span class="sd"> */</span>
3781 <span class="k">class</span> <span class="nc">PersonUserMergeListener</span> <span class="k">extends</span> <span class="nx">AbstractUserMergeListener</span>
3782 <span class="p">{</span>
3783     <span class="sd">/**</span>
3784 <span class="sd">     * @inheritDoc</span>
3785 <span class="sd">     */</span>
3786     <span class="k">protected</span> <span class="nv">$databaseTables</span> <span class="o">=</span> <span class="p">[</span>
3787         <span class="s1">&#39;wcf{WCF_N}_person_information&#39;</span><span class="p">,</span>
3788     <span class="p">];</span>
3789 <span class="p">}</span>
3790 </code></pre></div>
3791 </td></tr></table>
3792 3. If the option to prune stored ip addresses after a certain period of time is enabled, we also have to prune them in the person information database table.
3793   Here we also only have to specify the name of the relevant database table and provide the mapping from the <code>ipAddress</code> column to the <code>time</code> column:</p>
3794 <p><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3795 <span class="normal"> 2</span>
3796 <span class="normal"> 3</span>
3797 <span class="normal"> 4</span>
3798 <span class="normal"> 5</span>
3799 <span class="normal"> 6</span>
3800 <span class="normal"> 7</span>
3801 <span class="normal"> 8</span>
3802 <span class="normal"> 9</span>
3803 <span class="normal">10</span>
3804 <span class="normal">11</span>
3805 <span class="normal">12</span>
3806 <span class="normal">13</span>
3807 <span class="normal">14</span>
3808 <span class="normal">15</span>
3809 <span class="normal">16</span>
3810 <span class="normal">17</span>
3811 <span class="normal">18</span>
3812 <span class="normal">19</span>
3813 <span class="normal">20</span>
3814 <span class="normal">21</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3815
3816 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3817
3818 <span class="k">use</span> <span class="nx">wcf\system\cronjob\PruneIpAddressesCronjob</span><span class="p">;</span>
3819
3820 <span class="sd">/**</span>
3821 <span class="sd"> * Prunes old ip addresses.</span>
3822 <span class="sd"> *</span>
3823 <span class="sd"> * @author  Matthias Schmidt</span>
3824 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3825 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3826 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
3827 <span class="sd"> */</span>
3828 <span class="k">class</span> <span class="nc">PersonPruneIpAddressesCronjobListener</span> <span class="k">extends</span> <span class="nx">AbstractEventListener</span>
3829 <span class="p">{</span>
3830     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onExecute</span><span class="p">(</span><span class="nx">PruneIpAddressesCronjob</span> <span class="nv">$cronjob</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span>
3831     <span class="p">{</span>
3832         <span class="nv">$cronjob</span><span class="o">-&gt;</span><span class="na">columns</span><span class="p">[</span><span class="s1">&#39;wcf&#39;</span> <span class="o">.</span> <span class="nx">WCF_N</span> <span class="o">.</span> <span class="s1">&#39;_person_information&#39;</span><span class="p">][</span><span class="s1">&#39;ipAddress&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;time&#39;</span><span class="p">;</span>
3833     <span class="p">}</span>
3834 <span class="p">}</span>
3835 </code></pre></div>
3836 </td></tr></table>
3837 4. The ip addresses in the person information database table also have to be considered for the user data export which can also be done with minimal effort by providing the name of the relevant database table: </p>
3838 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3839 <span class="normal"> 2</span>
3840 <span class="normal"> 3</span>
3841 <span class="normal"> 4</span>
3842 <span class="normal"> 5</span>
3843 <span class="normal"> 6</span>
3844 <span class="normal"> 7</span>
3845 <span class="normal"> 8</span>
3846 <span class="normal"> 9</span>
3847 <span class="normal">10</span>
3848 <span class="normal">11</span>
3849 <span class="normal">12</span>
3850 <span class="normal">13</span>
3851 <span class="normal">14</span>
3852 <span class="normal">15</span>
3853 <span class="normal">16</span>
3854 <span class="normal">17</span>
3855 <span class="normal">18</span>
3856 <span class="normal">19</span>
3857 <span class="normal">20</span>
3858 <span class="normal">21</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3859
3860 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
3861
3862 <span class="k">use</span> <span class="nx">wcf\acp\action\UserExportGdprAction</span><span class="p">;</span>
3863
3864 <span class="sd">/**</span>
3865 <span class="sd"> * Adds the ip addresses stored with the person information during user data export.</span>
3866 <span class="sd"> *</span>
3867 <span class="sd"> * @author  Matthias Schmidt</span>
3868 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3869 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3870 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
3871 <span class="sd"> */</span>
3872 <span class="k">class</span> <span class="nc">PersonUserExportGdprListener</span> <span class="k">extends</span> <span class="nx">AbstractEventListener</span>
3873 <span class="p">{</span>
3874     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onExport</span><span class="p">(</span><span class="nx">UserExportGdprAction</span> <span class="nv">$action</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span>
3875     <span class="p">{</span>
3876         <span class="nv">$action</span><span class="o">-&gt;</span><span class="na">ipAddresses</span><span class="p">[</span><span class="s1">&#39;com.woltlab.wcf.people&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;wcf&#39;</span> <span class="o">.</span> <span class="nx">WCF_N</span> <span class="o">.</span> <span class="s1">&#39;_person_information&#39;</span><span class="p">];</span>
3877     <span class="p">}</span>
3878 <span class="p">}</span>
3879 </code></pre></div>
3880 </td></tr></table>
3881 </li>
3882 </ol>
3883 <p>Lastly, we present the updated <code>eventListener.xml</code> file with new entries for all of these event listeners:</p>
3884 <table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3885 <span class="normal"> 2</span>
3886 <span class="normal"> 3</span>
3887 <span class="normal"> 4</span>
3888 <span class="normal"> 5</span>
3889 <span class="normal"> 6</span>
3890 <span class="normal"> 7</span>
3891 <span class="normal"> 8</span>
3892 <span class="normal"> 9</span>
3893 <span class="normal">10</span>
3894 <span class="normal">11</span>
3895 <span class="normal">12</span>
3896 <span class="normal">13</span>
3897 <span class="normal">14</span>
3898 <span class="normal">15</span>
3899 <span class="normal">16</span>
3900 <span class="normal">17</span>
3901 <span class="normal">18</span>
3902 <span class="normal">19</span>
3903 <span class="normal">20</span>
3904 <span class="normal">21</span>
3905 <span class="normal">22</span>
3906 <span class="normal">23</span>
3907 <span class="normal">24</span>
3908 <span class="normal">25</span>
3909 <span class="normal">26</span>
3910 <span class="normal">27</span>
3911 <span class="normal">28</span>
3912 <span class="normal">29</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>
3913 <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/eventListener.xsd&quot;</span><span class="nt">&gt;</span>
3914     <span class="nt">&lt;import&gt;</span>
3915         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;rename@wcf\data\user\UserAction&quot;</span><span class="nt">&gt;</span>
3916             <span class="nt">&lt;eventclassname&gt;</span>wcf\data\user\UserAction<span class="nt">&lt;/eventclassname&gt;</span>
3917             <span class="nt">&lt;eventname&gt;</span>rename<span class="nt">&lt;/eventname&gt;</span>
3918             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\PersonUserActionRenameListener<span class="nt">&lt;/listenerclassname&gt;</span>
3919             <span class="nt">&lt;environment&gt;</span>all<span class="nt">&lt;/environment&gt;</span>
3920         <span class="nt">&lt;/eventlistener&gt;</span>
3921         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;save@wcf\acp\form\UserMergeForm&quot;</span><span class="nt">&gt;</span>
3922             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\form\UserMergeForm<span class="nt">&lt;/eventclassname&gt;</span>
3923             <span class="nt">&lt;eventname&gt;</span>save<span class="nt">&lt;/eventname&gt;</span>
3924             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\PersonUserMergeListener<span class="nt">&lt;/listenerclassname&gt;</span>
3925             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
3926         <span class="nt">&lt;/eventlistener&gt;</span>
3927         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;execute@wcf\system\cronjob\PruneIpAddressesCronjob&quot;</span><span class="nt">&gt;</span>
3928             <span class="nt">&lt;eventclassname&gt;</span>wcf\system\cronjob\PruneIpAddressesCronjob<span class="nt">&lt;/eventclassname&gt;</span>
3929             <span class="nt">&lt;eventname&gt;</span>execute<span class="nt">&lt;/eventname&gt;</span>
3930             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\PersonPruneIpAddressesCronjobListener<span class="nt">&lt;/listenerclassname&gt;</span>
3931             <span class="nt">&lt;environment&gt;</span>all<span class="nt">&lt;/environment&gt;</span>
3932         <span class="nt">&lt;/eventlistener&gt;</span>
3933         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;export@wcf\acp\action\UserExportGdprAction&quot;</span><span class="nt">&gt;</span>
3934             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\action\UserExportGdprAction<span class="nt">&lt;/eventclassname&gt;</span>
3935             <span class="nt">&lt;eventname&gt;</span>export<span class="nt">&lt;/eventname&gt;</span>
3936             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\PersonUserExportGdprListener<span class="nt">&lt;/listenerclassname&gt;</span>
3937             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
3938         <span class="nt">&lt;/eventlistener&gt;</span>
3939     <span class="nt">&lt;/import&gt;</span>
3940 <span class="nt">&lt;/data&gt;</span>
3941 </code></pre></div>
3942 </td></tr></table>
3943
3944
3945
3946
3947 <hr>
3948 <div class="md-source-date">
3949   <small>
3950
3951       Last update: 2021-04-22
3952
3953   </small>
3954 </div>
3955
3956
3957
3958
3959
3960
3961
3962
3963             </article>
3964           </div>
3965         </div>
3966
3967       </main>
3968
3969
3970 <footer class="md-footer">
3971
3972     <nav class="md-footer__inner md-grid" aria-label="Footer">
3973
3974         <a href="../part_4/" class="md-footer__link md-footer__link--prev" rel="prev">
3975           <div class="md-footer__button md-icon">
3976             <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>
3977           </div>
3978           <div class="md-footer__title">
3979             <div class="md-ellipsis">
3980               <span class="md-footer__direction">
3981                 Previous
3982               </span>
3983               Part 4
3984             </div>
3985           </div>
3986         </a>
3987
3988
3989     </nav>
3990
3991   <div class="md-footer-meta md-typeset">
3992     <div class="md-footer-meta__inner md-grid">
3993       <div class="md-footer-copyright">
3994
3995           <div class="md-footer-copyright__highlight">
3996             Copyright © 2020 WoltLab GmbH
3997           </div>
3998
3999         Made with
4000         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4001           Material for MkDocs
4002         </a>
4003
4004       </div>
4005       <div class="md-footer-copyright">
4006         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4007         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4008 </div>
4009     </div>
4010   </div>
4011 </footer>
4012
4013     </div>
4014     <div class="md-dialog" data-md-component="dialog">
4015       <div class="md-dialog__inner md-typeset"></div>
4016     </div>
4017     <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>
4018
4019
4020       <script src="../../../assets/javascripts/bundle.4ea5477f.min.js"></script>
4021
4022
4023   </body>
4024 </html>