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