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