latest/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     <li class="md-nav__item">
 310       <a href="../../../php/api/caches/" class="md-nav__link">
 311         Caches
 312       </a>
 313     </li>
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item">
 322       <a href="../../../php/api/comments/" class="md-nav__link">
 323         Comments
 324       </a>
 325     </li>
 326
 327
 328
 329
 330
 331
 332
 333     <li class="md-nav__item">
 334       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 335         Cronjobs
 336       </a>
 337     </li>
 338
 339
 340
 341
 342
 343
 344
 345     <li class="md-nav__item">
 346       <a href="../../../php/api/events/" class="md-nav__link">
 347         Events
 348       </a>
 349     </li>
 350
 351
 352
 353
 354
 355
 356
 357
 358     <li class="md-nav__item md-nav__item--nested">
 359
 360
 361         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 362
 363       <label class="md-nav__link" for="__nav_2_5_5">
 364         Form Builder
 365         <span class="md-nav__icon md-icon"></span>
 366       </label>
 367       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 368         <label class="md-nav__title" for="__nav_2_5_5">
 369           <span class="md-nav__icon md-icon"></span>
 370           Form Builder
 371         </label>
 372         <ul class="md-nav__list" data-md-scrollfix>
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390     <li class="md-nav__item">
 391       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 392         Structure
 393       </a>
 394     </li>
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 404         Fields
 405       </a>
 406     </li>
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item">
 415       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 416         Validation and Data
 417       </a>
 418     </li>
 419
 420
 421
 422
 423
 424
 425
 426     <li class="md-nav__item">
 427       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 428         Dependencies
 429       </a>
 430     </li>
 431
 432
 433
 434         </ul>
 435       </nav>
 436     </li>
 437
 438
 439
 440
 441
 442
 443
 444     <li class="md-nav__item">
 445       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 446         Package Installation Plugins
 447       </a>
 448     </li>
 449
 450
 451
 452
 453
 454
 455
 456     <li class="md-nav__item">
 457       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 458         User Activity Points
 459       </a>
 460     </li>
 461
 462
 463
 464
 465
 466
 467
 468     <li class="md-nav__item">
 469       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 470         User Notifications
 471       </a>
 472     </li>
 473
 474
 475
 476
 477
 478
 479
 480     <li class="md-nav__item">
 481       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 482         Sitemaps
 483       </a>
 484     </li>
 485
 486
 487
 488         </ul>
 489       </nav>
 490     </li>
 491
 492
 493
 494
 495
 496
 497
 498     <li class="md-nav__item">
 499       <a href="../../../php/code-style/" class="md-nav__link">
 500         Code Style
 501       </a>
 502     </li>
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/apps/" class="md-nav__link">
 512         Apps
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item">
 523       <a href="../../../php/gdpr/" class="md-nav__link">
 524         GDPR
 525       </a>
 526     </li>
 527
 528
 529
 530         </ul>
 531       </nav>
 532     </li>
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544     <li class="md-nav__item md-nav__item--nested">
 545
 546
 547         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 548
 549       <label class="md-nav__link" for="__nav_3">
 550         Languages, Templates & CSS
 551         <span class="md-nav__icon md-icon"></span>
 552       </label>
 553       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 554         <label class="md-nav__title" for="__nav_3">
 555           <span class="md-nav__icon md-icon"></span>
 556           Languages, Templates & CSS
 557         </label>
 558         <ul class="md-nav__list" data-md-scrollfix>
 559
 560
 561
 562
 563
 564     <li class="md-nav__item">
 565       <a href="../../../view/languages/" class="md-nav__link">
 566         Languages
 567       </a>
 568     </li>
 569
 570
 571
 572
 573
 574
 575
 576     <li class="md-nav__item">
 577       <a href="../../../view/templates/" class="md-nav__link">
 578         Templates
 579       </a>
 580     </li>
 581
 582
 583
 584
 585
 586
 587
 588     <li class="md-nav__item">
 589       <a href="../../../view/css/" class="md-nav__link">
 590         CSS
 591       </a>
 592     </li>
 593
 594
 595
 596         </ul>
 597       </nav>
 598     </li>
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610     <li class="md-nav__item md-nav__item--nested">
 611
 612
 613         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 614
 615       <label class="md-nav__link" for="__nav_4">
 616         JavaScript API
 617         <span class="md-nav__icon md-icon"></span>
 618       </label>
 619       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 620         <label class="md-nav__title" for="__nav_4">
 621           <span class="md-nav__icon md-icon"></span>
 622           JavaScript API
 623         </label>
 624         <ul class="md-nav__list" data-md-scrollfix>
 625
 626
 627
 628
 629
 630     <li class="md-nav__item">
 631       <a href="../../../javascript/general-usage/" class="md-nav__link">
 632         General Usage
 633       </a>
 634     </li>
 635
 636
 637
 638
 639
 640
 641
 642
 643     <li class="md-nav__item md-nav__item--nested">
 644
 645
 646         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 647
 648       <label class="md-nav__link" for="__nav_4_2">
 649         New API
 650         <span class="md-nav__icon md-icon"></span>
 651       </label>
 652       <nav class="md-nav" aria-label="New API" data-md-level="2">
 653         <label class="md-nav__title" for="__nav_4_2">
 654           <span class="md-nav__icon md-icon"></span>
 655           New API
 656         </label>
 657         <ul class="md-nav__list" data-md-scrollfix>
 658
 659
 660
 661
 662
 663     <li class="md-nav__item">
 664       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 665         Writing a module
 666       </a>
 667     </li>
 668
 669
 670
 671
 672
 673
 674
 675     <li class="md-nav__item">
 676       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 677         Data Structures
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item">
 688       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 689         Core Functions
 690       </a>
 691     </li>
 692
 693
 694
 695
 696
 697
 698
 699     <li class="md-nav__item">
 700       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 701         DOM
 702       </a>
 703     </li>
 704
 705
 706
 707
 708
 709
 710
 711     <li class="md-nav__item">
 712       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 713         Event Handling
 714       </a>
 715     </li>
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 725         Ajax
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735     <li class="md-nav__item">
 736       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 737         Dialogs
 738       </a>
 739     </li>
 740
 741
 742
 743
 744
 745
 746
 747     <li class="md-nav__item">
 748       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 749         Browser and Screen Sizes
 750       </a>
 751     </li>
 752
 753
 754
 755
 756
 757
 758
 759     <li class="md-nav__item">
 760       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 761         User Interface
 762       </a>
 763     </li>
 764
 765
 766
 767         </ul>
 768       </nav>
 769     </li>
 770
 771
 772
 773
 774
 775
 776
 777     <li class="md-nav__item">
 778       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 779         Legacy API
 780       </a>
 781     </li>
 782
 783
 784
 785
 786
 787
 788
 789     <li class="md-nav__item">
 790       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 791         Helper Functions
 792       </a>
 793     </li>
 794
 795
 796
 797
 798
 799
 800
 801     <li class="md-nav__item">
 802       <a href="../../../javascript/code-snippets/" class="md-nav__link">
 803         Code Snippets
 804       </a>
 805     </li>
 806
 807
 808
 809         </ul>
 810       </nav>
 811     </li>
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823     <li class="md-nav__item md-nav__item--nested">
 824
 825
 826         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 827
 828       <label class="md-nav__link" for="__nav_5">
 829         Package Components
 830         <span class="md-nav__icon md-icon"></span>
 831       </label>
 832       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 833         <label class="md-nav__title" for="__nav_5">
 834           <span class="md-nav__icon md-icon"></span>
 835           Package Components
 836         </label>
 837         <ul class="md-nav__list" data-md-scrollfix>
 838
 839
 840
 841
 842
 843     <li class="md-nav__item">
 844       <a href="../../../package/package-xml/" class="md-nav__link">
 845         package.xml
 846       </a>
 847     </li>
 848
 849
 850
 851
 852
 853
 854
 855
 856     <li class="md-nav__item md-nav__item--nested">
 857
 858
 859         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 860
 861       <label class="md-nav__link" for="__nav_5_2">
 862         PIPs
 863         <span class="md-nav__icon md-icon"></span>
 864       </label>
 865       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 866         <label class="md-nav__title" for="__nav_5_2">
 867           <span class="md-nav__icon md-icon"></span>
 868           PIPs
 869         </label>
 870         <ul class="md-nav__list" data-md-scrollfix>
 871
 872
 873
 874
 875
 876     <li class="md-nav__item">
 877       <a href="../../../package/pip/" class="md-nav__link">
 878         Overview
 879       </a>
 880     </li>
 881
 882
 883
 884
 885
 886
 887
 888     <li class="md-nav__item">
 889       <a href="../../../package/pip/acl-option/" class="md-nav__link">
 890         aclOption
 891       </a>
 892     </li>
 893
 894
 895
 896
 897
 898
 899
 900     <li class="md-nav__item">
 901       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
 902         acpMenu
 903       </a>
 904     </li>
 905
 906
 907
 908
 909
 910
 911
 912     <li class="md-nav__item">
 913       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
 914         acpSearchProvider
 915       </a>
 916     </li>
 917
 918
 919
 920
 921
 922
 923
 924     <li class="md-nav__item">
 925       <a href="../../../package/pip/acp-template/" class="md-nav__link">
 926         acpTemplate
 927       </a>
 928     </li>
 929
 930
 931
 932
 933
 934
 935
 936     <li class="md-nav__item">
 937       <a href="../../../package/pip/bbcode/" class="md-nav__link">
 938         bbcode
 939       </a>
 940     </li>
 941
 942
 943
 944
 945
 946
 947
 948     <li class="md-nav__item">
 949       <a href="../../../package/pip/box/" class="md-nav__link">
 950         box
 951       </a>
 952     </li>
 953
 954
 955
 956
 957
 958
 959
 960     <li class="md-nav__item">
 961       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
 962         clipboardAction
 963       </a>
 964     </li>
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../../../package/pip/core-object/" class="md-nav__link">
 974         coreObject
 975       </a>
 976     </li>
 977
 978
 979
 980
 981
 982
 983
 984     <li class="md-nav__item">
 985       <a href="../../../package/pip/cronjob/" class="md-nav__link">
 986         cronjob
 987       </a>
 988     </li>
 989
 990
 991
 992
 993
 994
 995
 996     <li class="md-nav__item">
 997       <a href="../../../package/pip/event-listener/" class="md-nav__link">
 998         eventListener
 999       </a>
1000     </li>
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../../package/pip/file/" class="md-nav__link">
1010         file
1011       </a>
1012     </li>
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../../package/pip/language/" class="md-nav__link">
1022         language
1023       </a>
1024     </li>
1025
1026
1027
1028
1029
1030
1031
1032     <li class="md-nav__item">
1033       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1034         mediaProvider
1035       </a>
1036     </li>
1037
1038
1039
1040
1041
1042
1043
1044     <li class="md-nav__item">
1045       <a href="../../../package/pip/menu/" class="md-nav__link">
1046         menu
1047       </a>
1048     </li>
1049
1050
1051
1052
1053
1054
1055
1056     <li class="md-nav__item">
1057       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1058         menuItem
1059       </a>
1060     </li>
1061
1062
1063
1064
1065
1066
1067
1068     <li class="md-nav__item">
1069       <a href="../../../package/pip/object-type/" class="md-nav__link">
1070         objectType
1071       </a>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080     <li class="md-nav__item">
1081       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1082         objectTypeDefinition
1083       </a>
1084     </li>
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item">
1093       <a href="../../../package/pip/option/" class="md-nav__link">
1094         option
1095       </a>
1096     </li>
1097
1098
1099
1100
1101
1102
1103
1104     <li class="md-nav__item">
1105       <a href="../../../package/pip/page/" class="md-nav__link">
1106         page
1107       </a>
1108     </li>
1109
1110
1111
1112
1113
1114
1115
1116     <li class="md-nav__item">
1117       <a href="../../../package/pip/pip/" class="md-nav__link">
1118         pip
1119       </a>
1120     </li>
1121
1122
1123
1124
1125
1126
1127
1128     <li class="md-nav__item">
1129       <a href="../../../package/pip/script/" class="md-nav__link">
1130         script
1131       </a>
1132     </li>
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../../../package/pip/smiley/" class="md-nav__link">
1142         smiley
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152     <li class="md-nav__item">
1153       <a href="../../../package/pip/sql/" class="md-nav__link">
1154         sql
1155       </a>
1156     </li>
1157
1158
1159
1160
1161
1162
1163
1164     <li class="md-nav__item">
1165       <a href="../../../package/pip/style/" class="md-nav__link">
1166         style
1167       </a>
1168     </li>
1169
1170
1171
1172
1173
1174
1175
1176     <li class="md-nav__item">
1177       <a href="../../../package/pip/template/" class="md-nav__link">
1178         template
1179       </a>
1180     </li>
1181
1182
1183
1184
1185
1186
1187
1188     <li class="md-nav__item">
1189       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1190         templateListener
1191       </a>
1192     </li>
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1202         userGroupOption
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1214         userMenu
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1226         userNotificationEvent
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236     <li class="md-nav__item">
1237       <a href="../../../package/pip/user-option/" class="md-nav__link">
1238         userOption
1239       </a>
1240     </li>
1241
1242
1243
1244
1245
1246
1247
1248     <li class="md-nav__item">
1249       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1250         userProfileMenu
1251       </a>
1252     </li>
1253
1254
1255
1256         </ul>
1257       </nav>
1258     </li>
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../../../package/database-php-api/" class="md-nav__link">
1268         Database PHP API
1269       </a>
1270     </li>
1271
1272
1273
1274         </ul>
1275       </nav>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item md-nav__item--nested">
1289
1290
1291         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1292
1293       <label class="md-nav__link" for="__nav_6">
1294         Migration
1295         <span class="md-nav__icon md-icon"></span>
1296       </label>
1297       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1298         <label class="md-nav__title" for="__nav_6">
1299           <span class="md-nav__icon md-icon"></span>
1300           Migration
1301         </label>
1302         <ul class="md-nav__list" data-md-scrollfix>
1303
1304
1305
1306
1307
1308
1309     <li class="md-nav__item md-nav__item--nested">
1310
1311
1312         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1313
1314       <label class="md-nav__link" for="__nav_6_1">
1315         Migrating from WSC 5.3
1316         <span class="md-nav__icon md-icon"></span>
1317       </label>
1318       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1319         <label class="md-nav__title" for="__nav_6_1">
1320           <span class="md-nav__icon md-icon"></span>
1321           Migrating from WSC 5.3
1322         </label>
1323         <ul class="md-nav__list" data-md-scrollfix>
1324
1325
1326
1327
1328
1329     <li class="md-nav__item">
1330       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1331         PHP API
1332       </a>
1333     </li>
1334
1335
1336
1337
1338
1339
1340
1341     <li class="md-nav__item">
1342       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1343         Session Handling and Authentication
1344       </a>
1345     </li>
1346
1347
1348
1349
1350
1351
1352
1353     <li class="md-nav__item">
1354       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1355         JavaScript
1356       </a>
1357     </li>
1358
1359
1360
1361
1362
1363
1364
1365     <li class="md-nav__item">
1366       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1367         Templates
1368       </a>
1369     </li>
1370
1371
1372
1373
1374
1375
1376
1377     <li class="md-nav__item">
1378       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1379         Third Party Libraries
1380       </a>
1381     </li>
1382
1383
1384
1385         </ul>
1386       </nav>
1387     </li>
1388
1389
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_2" type="checkbox" id="__nav_6_2" >
1400
1401       <label class="md-nav__link" for="__nav_6_2">
1402         Migrating from WSC 5.2
1403         <span class="md-nav__icon md-icon"></span>
1404       </label>
1405       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1406         <label class="md-nav__title" for="__nav_6_2">
1407           <span class="md-nav__icon md-icon"></span>
1408           Migrating from WSC 5.2
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/wsc52/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/wsc52/templates/" class="md-nav__link">
1430         Templates and Languages
1431       </a>
1432     </li>
1433
1434
1435
1436
1437
1438
1439
1440     <li class="md-nav__item">
1441       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1442         Third Party Libraries
1443       </a>
1444     </li>
1445
1446
1447
1448         </ul>
1449       </nav>
1450     </li>
1451
1452
1453
1454
1455
1456
1457
1458
1459     <li class="md-nav__item md-nav__item--nested">
1460
1461
1462         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1463
1464       <label class="md-nav__link" for="__nav_6_3">
1465         Migrating from WSC 3.1
1466         <span class="md-nav__icon md-icon"></span>
1467       </label>
1468       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1469         <label class="md-nav__title" for="__nav_6_3">
1470           <span class="md-nav__icon md-icon"></span>
1471           Migrating from WSC 3.1
1472         </label>
1473         <ul class="md-nav__list" data-md-scrollfix>
1474
1475
1476
1477
1478
1479     <li class="md-nav__item">
1480       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1481         PHP API
1482       </a>
1483     </li>
1484
1485
1486
1487         </ul>
1488       </nav>
1489     </li>
1490
1491
1492
1493
1494
1495
1496
1497
1498     <li class="md-nav__item md-nav__item--nested">
1499
1500
1501         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1502
1503       <label class="md-nav__link" for="__nav_6_4">
1504         Migrating from WSC 3.0
1505         <span class="md-nav__icon md-icon"></span>
1506       </label>
1507       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1508         <label class="md-nav__title" for="__nav_6_4">
1509           <span class="md-nav__icon md-icon"></span>
1510           Migrating from WSC 3.0
1511         </label>
1512         <ul class="md-nav__list" data-md-scrollfix>
1513
1514
1515
1516
1517
1518     <li class="md-nav__item">
1519       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1520         PHP API
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530     <li class="md-nav__item">
1531       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1532         JavaScript API
1533       </a>
1534     </li>
1535
1536
1537
1538
1539
1540
1541
1542     <li class="md-nav__item">
1543       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1544         Templates
1545       </a>
1546     </li>
1547
1548
1549
1550
1551
1552
1553
1554     <li class="md-nav__item">
1555       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1556         CSS
1557       </a>
1558     </li>
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1568         Package Components
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_5" type="checkbox" id="__nav_6_5" >
1589
1590       <label class="md-nav__link" for="__nav_6_5">
1591         Migrating from WCF 2.1
1592         <span class="md-nav__icon md-icon"></span>
1593       </label>
1594       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1595         <label class="md-nav__title" for="__nav_6_5">
1596           <span class="md-nav__icon md-icon"></span>
1597           Migrating from WCF 2.1
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/wcf21/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/wcf21/templates/" class="md-nav__link">
1619         Templates
1620       </a>
1621     </li>
1622
1623
1624
1625
1626
1627
1628
1629     <li class="md-nav__item">
1630       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1631         CSS
1632       </a>
1633     </li>
1634
1635
1636
1637
1638
1639
1640
1641     <li class="md-nav__item">
1642       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1643         Package Components
1644       </a>
1645     </li>
1646
1647
1648
1649         </ul>
1650       </nav>
1651     </li>
1652
1653
1654
1655         </ul>
1656       </nav>
1657     </li>
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1672
1673
1674         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" checked>
1675
1676       <label class="md-nav__link" for="__nav_7">
1677         Tutorials
1678         <span class="md-nav__icon md-icon"></span>
1679       </label>
1680       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1681         <label class="md-nav__title" for="__nav_7">
1682           <span class="md-nav__icon md-icon"></span>
1683           Tutorials
1684         </label>
1685         <ul class="md-nav__list" data-md-scrollfix>
1686
1687
1688
1689
1690
1691
1692
1693
1694     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1695
1696
1697         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" checked>
1698
1699       <label class="md-nav__link" for="__nav_7_1">
1700         Tutorial Series
1701         <span class="md-nav__icon md-icon"></span>
1702       </label>
1703       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1704         <label class="md-nav__title" for="__nav_7_1">
1705           <span class="md-nav__icon md-icon"></span>
1706           Tutorial Series
1707         </label>
1708         <ul class="md-nav__list" data-md-scrollfix>
1709
1710
1711
1712
1713
1714     <li class="md-nav__item">
1715       <a href="../overview/" class="md-nav__link">
1716         Overview
1717       </a>
1718     </li>
1719
1720
1721
1722
1723
1724
1725
1726     <li class="md-nav__item">
1727       <a href="../part_1/" class="md-nav__link">
1728         Part 1
1729       </a>
1730     </li>
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740     <li class="md-nav__item md-nav__item--active">
1741
1742       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1743
1744
1745
1746
1747         <label class="md-nav__link md-nav__link--active" for="__toc">
1748           Part 2
1749           <span class="md-nav__icon md-icon"></span>
1750         </label>
1751
1752       <a href="./" class="md-nav__link md-nav__link--active">
1753         Part 2
1754       </a>
1755
1756
1757 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1758
1759
1760
1761
1762
1763     <label class="md-nav__title" for="__toc">
1764       <span class="md-nav__icon md-icon"></span>
1765       Table of contents
1766     </label>
1767     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1768
1769         <li class="md-nav__item">
1770   <a href="#package-functionality" class="md-nav__link">
1771     Package Functionality
1772   </a>
1773
1774 </li>
1775
1776         <li class="md-nav__item">
1777   <a href="#used-components" class="md-nav__link">
1778     Used Components
1779   </a>
1780
1781 </li>
1782
1783         <li class="md-nav__item">
1784   <a href="#package-structure" class="md-nav__link">
1785     Package Structure
1786   </a>
1787
1788 </li>
1789
1790         <li class="md-nav__item">
1791   <a href="#extending-person-model-installsql" class="md-nav__link">
1792     Extending Person Model (install.sql)
1793   </a>
1794
1795 </li>
1796
1797         <li class="md-nav__item">
1798   <a href="#setting-birthday-in-acp" class="md-nav__link">
1799     Setting Birthday in ACP
1800   </a>
1801
1802 </li>
1803
1804         <li class="md-nav__item">
1805   <a href="#adding-birthday-table-column-in-acp" class="md-nav__link">
1806     Adding Birthday Table Column in ACP
1807   </a>
1808
1809 </li>
1810
1811         <li class="md-nav__item">
1812   <a href="#adding-birthday-in-front-end" class="md-nav__link">
1813     Adding Birthday in Front End
1814   </a>
1815
1816 </li>
1817
1818         <li class="md-nav__item">
1819   <a href="#templatelistenerxml" class="md-nav__link">
1820     templateListener.xml
1821   </a>
1822
1823 </li>
1824
1825         <li class="md-nav__item">
1826   <a href="#eventlistenerxml" class="md-nav__link">
1827     eventListener.xml
1828   </a>
1829
1830 </li>
1831
1832         <li class="md-nav__item">
1833   <a href="#packagexml" class="md-nav__link">
1834     package.xml
1835   </a>
1836
1837 </li>
1838
1839     </ul>
1840
1841 </nav>
1842
1843     </li>
1844
1845
1846
1847
1848
1849
1850
1851     <li class="md-nav__item">
1852       <a href="../part_3/" class="md-nav__link">
1853         Part 3
1854       </a>
1855     </li>
1856
1857
1858
1859         </ul>
1860       </nav>
1861     </li>
1862
1863
1864
1865         </ul>
1866       </nav>
1867     </li>
1868
1869
1870
1871   </ul>
1872 </nav>
1873                   </div>
1874                 </div>
1875               </div>
1876
1877
1878
1879               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1880                 <div class="md-sidebar__scrollwrap">
1881                   <div class="md-sidebar__inner">
1882
1883 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1884
1885
1886
1887
1888
1889     <label class="md-nav__title" for="__toc">
1890       <span class="md-nav__icon md-icon"></span>
1891       Table of contents
1892     </label>
1893     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1894
1895         <li class="md-nav__item">
1896   <a href="#package-functionality" class="md-nav__link">
1897     Package Functionality
1898   </a>
1899
1900 </li>
1901
1902         <li class="md-nav__item">
1903   <a href="#used-components" class="md-nav__link">
1904     Used Components
1905   </a>
1906
1907 </li>
1908
1909         <li class="md-nav__item">
1910   <a href="#package-structure" class="md-nav__link">
1911     Package Structure
1912   </a>
1913
1914 </li>
1915
1916         <li class="md-nav__item">
1917   <a href="#extending-person-model-installsql" class="md-nav__link">
1918     Extending Person Model (install.sql)
1919   </a>
1920
1921 </li>
1922
1923         <li class="md-nav__item">
1924   <a href="#setting-birthday-in-acp" class="md-nav__link">
1925     Setting Birthday in ACP
1926   </a>
1927
1928 </li>
1929
1930         <li class="md-nav__item">
1931   <a href="#adding-birthday-table-column-in-acp" class="md-nav__link">
1932     Adding Birthday Table Column in ACP
1933   </a>
1934
1935 </li>
1936
1937         <li class="md-nav__item">
1938   <a href="#adding-birthday-in-front-end" class="md-nav__link">
1939     Adding Birthday in Front End
1940   </a>
1941
1942 </li>
1943
1944         <li class="md-nav__item">
1945   <a href="#templatelistenerxml" class="md-nav__link">
1946     templateListener.xml
1947   </a>
1948
1949 </li>
1950
1951         <li class="md-nav__item">
1952   <a href="#eventlistenerxml" class="md-nav__link">
1953     eventListener.xml
1954   </a>
1955
1956 </li>
1957
1958         <li class="md-nav__item">
1959   <a href="#packagexml" class="md-nav__link">
1960     package.xml
1961   </a>
1962
1963 </li>
1964
1965     </ul>
1966
1967 </nav>
1968                   </div>
1969                 </div>
1970               </div>
1971
1972
1973           <div class="md-content" data-md-component="content">
1974             <article class="md-content__inner md-typeset">
1975
1976
1977                   <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">
1978                     <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>
1979                   </a>
1980
1981
1982                 <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>
1983 <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.
1984 In further parts, we will use the package of the first part as a basis to directly add new features.
1985 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>
1986 <p>The goal of the small plugin that will be created in this part is to add the birthday of the managed people.
1987 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>
1988 <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
1989 <p>The package should provide the following possibilities/functions:</p>
1990 <ul>
1991 <li>List person’s birthday (if set) in people list in the ACP</li>
1992 <li>Sort people list by birthday in the ACP</li>
1993 <li>Add or remove birthday when adding or editing person</li>
1994 <li>List person’s birthday (if set) in people list in the front end</li>
1995 <li>Sort people list by birthday in the front end</li>
1996 </ul>
1997 <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2>
1998 <p>We will use the following package installation plugins:</p>
1999 <ul>
2000 <li><a href="../../../package/pip/acp-template/">acpTemplate package installation plugin</a>,</li>
2001 <li><a href="../../../package/pip/event-listener/">eventListener package installation plugin</a>,</li>
2002 <li><a href="../../../package/pip/file/">file package installation plugin</a>,</li>
2003 <li><a href="../../../package/pip/language/">language package installation plugin</a>,</li>
2004 <li><a href="../../../package/pip/sql/">sql package installation plugin</a>,</li>
2005 <li><a href="../../../package/pip/template/">template package installation plugin</a>,</li>
2006 <li><a href="../../../package/pip/template-listener/">templateListener package installation plugin</a>.</li>
2007 </ul>
2008 <p>For more information about the event system, please refer to the <a href="../../../php/api/events/">dedicated page on events</a>.</p>
2009 <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
2010 <p>The package will have the following file structure:</p>
2011 <div class="highlight"><pre><span></span><code>├── acptemplates
2012 │   └── __personAddBirthday.tpl
2013 ├── eventListener.xml
2014 ├── files
2015 │   └── lib
2016 │       └── system
2017 │           └── event
2018 │               └── listener
2019 │                   ├── BirthdayPersonAddFormListener.class.php
2020 │                   └── BirthdaySortFieldPersonListPageListener.class.php
2021 ├── install.sql
2022 ├── language
2023 │   ├── de.xml
2024 │   └── en.xml
2025 ├── package.xml
2026 ├── templateListener.xml
2027 └── templates
2028     ├── __personListBirthday.tpl
2029     └── __personListBirthdaySortField.tpl
2030 </code></pre></div>
2031 <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>
2032 <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).
2033 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>
2034 <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>
2035 </code></pre></div>
2036 <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>
2037 <h2 id="setting-birthday-in-acp">Setting Birthday in ACP<a class="headerlink" href="#setting-birthday-in-acp" title="Permanent link">#</a></h2>
2038 <p>To set the birthday of a person, we need to extend the <code>personAdd</code> template to add an additional birthday field.
2039 This can be achieved using the <code>dataFields</code> template event at whose position we inject the following template code:</p>
2040 <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>
2041     <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>
2042     <span class="o">&lt;</span><span class="n">dd</span><span class="o">&gt;</span>
2043         <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>
2044         <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>
2045             <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>
2046                 <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>
2047                     <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>
2048                 <span class="err">{</span><span class="k">else</span><span class="err">}</span>
2049                     <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>
2050                 <span class="err">{</span><span class="o">/</span><span class="k">if</span><span class="err">}</span>
2051             <span class="o">&lt;/</span><span class="n">small</span><span class="o">&gt;</span>
2052         <span class="err">{</span><span class="o">/</span><span class="k">if</span><span class="err">}</span>
2053     <span class="o">&lt;/</span><span class="n">dd</span><span class="o">&gt;</span>
2054 <span class="o">&lt;/</span><span class="n">dl</span><span class="o">&gt;</span>
2055 </code></pre></div>
2056 <p>which we store in a <code>__personAddBirthday.tpl</code> template file.
2057 The used language item <code>wcf.person.birthday</code> is actually the only new one for this package:</p>
2058 <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>
2059 <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>
2060     <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>
2061         <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>
2062     <span class="o">&lt;/</span><span class="n">category</span><span class="o">&gt;</span>
2063 <span class="o">&lt;/</span><span class="k">language</span><span class="o">&gt;</span>
2064 </code></pre></div>
2065 <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>
2066 <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>
2067     <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>
2068         <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>
2069     <span class="o">&lt;/</span><span class="n">category</span><span class="o">&gt;</span>
2070 <span class="o">&lt;/</span><span class="k">language</span><span class="o">&gt;</span>
2071 </code></pre></div>
2072 <p>The template listener needs to be registered using the <a href="../../../package/pip/template-listener/">templateListener package installation plugin</a>.
2073 The corresponding complete <code>templateListener.xml</code> file is included <a href="#templatelistenerxml">below</a>.</p>
2074 <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.
2075 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.
2076 Before we take a look at the event listener code, we need to identify exactly which additional steps we need to undertake:</p>
2077 <ol>
2078 <li>If a person is edited and the form has not been submitted, the existing birthday of that person needs to be read.</li>
2079 <li>If a person is added or edited and the form has been submitted, the new birthday value needs to be read.</li>
2080 <li>If a person is added or edited and the form has been submitted, the new birthday value needs to be validated.</li>
2081 <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>
2082 <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>
2083 <li>The internally stored birthday value needs to be assigned to the template.</li>
2084 </ol>
2085 <p>The following event listeners achieves these requirements:</p>
2086 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2087 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
2088 <span class="k">use</span> <span class="nx">wcf\acp\form\PersonAddForm</span><span class="p">;</span>
2089 <span class="k">use</span> <span class="nx">wcf\acp\form\PersonEditForm</span><span class="p">;</span>
2090 <span class="k">use</span> <span class="nx">wcf\form\IForm</span><span class="p">;</span>
2091 <span class="k">use</span> <span class="nx">wcf\page\IPage</span><span class="p">;</span>
2092 <span class="k">use</span> <span class="nx">wcf\system\exception\UserInputException</span><span class="p">;</span>
2093 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2094 <span class="k">use</span> <span class="nx">wcf\util\StringUtil</span><span class="p">;</span>
2095
2096 <span class="sd">/**</span>
2097 <span class="sd"> * Handles setting the birthday when adding and editing people.</span>
2098 <span class="sd"> *</span>
2099 <span class="sd"> * @author  Matthias Schmidt</span>
2100 <span class="sd"> * @copyright   2001-2020 WoltLab GmbH</span>
2101 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2102 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
2103 <span class="sd"> */</span>
2104 <span class="k">class</span> <span class="nc">BirthdayPersonAddFormListener</span> <span class="k">extends</span> <span class="nx">AbstractEventListener</span> <span class="p">{</span>
2105     <span class="sd">/**</span>
2106 <span class="sd">     * birthday of the created or edited person</span>
2107 <span class="sd">     * @var string</span>
2108 <span class="sd">     */</span>
2109     <span class="k">protected</span> <span class="nv">$birthday</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
2110
2111     <span class="sd">/**</span>
2112 <span class="sd">     * @see IPage::assignVariables()</span>
2113 <span class="sd">     */</span>
2114     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onAssignVariables</span><span class="p">()</span> <span class="p">{</span>
2115         <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>
2116     <span class="p">}</span>
2117
2118     <span class="sd">/**</span>
2119 <span class="sd">     * @see IPage::readData()</span>
2120 <span class="sd">     */</span>
2121     <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>
2122         <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>
2123             <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>
2124
2125             <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>
2126                 <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>
2127             <span class="p">}</span>
2128         <span class="p">}</span>
2129     <span class="p">}</span>
2130
2131     <span class="sd">/**</span>
2132 <span class="sd">     * @see IForm::readFormParameters()</span>
2133 <span class="sd">     */</span>
2134     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onReadFormParameters</span><span class="p">()</span> <span class="p">{</span>
2135         <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>
2136             <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>
2137         <span class="p">}</span>
2138     <span class="p">}</span>
2139
2140     <span class="sd">/**</span>
2141 <span class="sd">     * @see IForm::save()</span>
2142 <span class="sd">     */</span>
2143     <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>
2144         <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>
2145             <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>
2146         <span class="p">}</span>
2147         <span class="k">else</span> <span class="p">{</span>
2148             <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>
2149         <span class="p">}</span>
2150     <span class="p">}</span>
2151
2152     <span class="sd">/**</span>
2153 <span class="sd">     * @see IForm::saved()</span>
2154 <span class="sd">     */</span>
2155     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onSaved</span><span class="p">()</span> <span class="p">{</span>
2156         <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>
2157     <span class="p">}</span>
2158
2159     <span class="sd">/**</span>
2160 <span class="sd">     * @see IForm::validate()</span>
2161 <span class="sd">     */</span>
2162     <span class="k">protected</span> <span class="k">function</span> <span class="nf">onValidate</span><span class="p">()</span> <span class="p">{</span>
2163         <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>
2164             <span class="k">return</span><span class="p">;</span>
2165         <span class="p">}</span>
2166
2167         <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>
2168             <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>
2169         <span class="p">}</span>
2170
2171         <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>
2172             <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>
2173         <span class="p">}</span>
2174     <span class="p">}</span>
2175 <span class="p">}</span>
2176 </code></pre></div>
2177 <p>Some notes on the code:</p>
2178 <ul>
2179 <li>We are inheriting from <code>AbstractEventListener</code>, instead of just implementing the <code>IParameterizedEventListener</code> interface.
2180   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.
2181   This simple pattern results in the event <code>foo</code> being forwarded to the method <code>onFoo($eventObj, $parameters)</code>.</li>
2182 <li>The <code>birthday</code> column has a default value of <code>0000-00-00</code>, which we interpret as “birthday not set”.
2183   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>
2184 <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>
2185 <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.
2186   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>.
2187   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>
2188 </ul>
2189 <p>The event listeners are installed using the <code>eventListener.xml</code> file shown <a href="#eventlistenerxml">below</a>.</p>
2190 <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>
2191 <p>To add a birthday column to the person list page in the ACP, we need three parts:</p>
2192 <ol>
2193 <li>an event listener that makes the <code>birthday</code> database table column a valid sort field,</li>
2194 <li>a template listener that adds the birthday column to the table’s head, and</li>
2195 <li>a template listener that adds the birthday column to the table’s rows.</li>
2196 </ol>
2197 <p>The first part is a very simple class:</p>
2198 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2199 <span class="k">namespace</span> <span class="nx">wcf\system\event\listener</span><span class="p">;</span>
2200 <span class="k">use</span> <span class="nx">wcf\page\SortablePage</span><span class="p">;</span>
2201
2202 <span class="sd">/**</span>
2203 <span class="sd"> * Makes people&#39;s birthday a valid sort field in the ACP and the front end.</span>
2204 <span class="sd"> * </span>
2205 <span class="sd"> * @author  Matthias Schmidt</span>
2206 <span class="sd"> * @copyright   2001-2019 WoltLab GmbH</span>
2207 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2208 <span class="sd"> * @package WoltLabSuite\Core\System\Event\Listener</span>
2209 <span class="sd"> */</span>
2210 <span class="k">class</span> <span class="nc">BirthdaySortFieldPersonListPageListener</span> <span class="k">implements</span> <span class="nx">IParameterizedEventListener</span> <span class="p">{</span>
2211     <span class="sd">/**</span>
2212 <span class="sd">     * @inheritDoc</span>
2213 <span class="sd">     */</span>
2214     <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>
2215         <span class="sd">/** @var SortablePage $eventObj */</span>
2216
2217         <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>
2218     <span class="p">}</span>
2219 <span class="p">}</span>
2220 </code></pre></div>
2221 <div class="admonition info">
2222 <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>
2223 </div>
2224 <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>.
2225 The code for the table head is similar to the other <code>th</code> elements:</p>
2226 <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>
2227 </code></pre></div>
2228 <p>For the table body’s column, we need to make sure that the birthday is only show if it is actually set:</p>
2229 <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>
2230 </code></pre></div>
2231 <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>
2232 <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>
2233 <p>To add the birthday as a valid sort field, we use <code>BirthdaySortFieldPersonListPageListener</code> just as in the ACP.
2234 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>
2235 <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>
2236 </code></pre></div>
2237 <div class="admonition info">
2238 <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>
2239 </div>
2240 <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>
2241 <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>
2242 <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>
2243 <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>
2244 <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>
2245 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2246 </code></pre></div>
2247 <h2 id="templatelistenerxml"><code>templateListener.xml</code><a class="headerlink" href="#templatelistenerxml" title="Permanent link">#</a></h2>
2248 <p>The following code shows the <code>templateListener.xml</code> file used to install all mentioned template listeners:</p>
2249 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2250 <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>
2251     <span class="nt">&lt;import&gt;</span>
2252         <span class="c">&lt;!-- admin --&gt;</span>
2253         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;personListBirthdayColumnHead&quot;</span><span class="nt">&gt;</span>
2254             <span class="nt">&lt;eventname&gt;</span>columnHeads<span class="nt">&lt;/eventname&gt;</span>
2255             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2256             <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>
2257             <span class="nt">&lt;templatename&gt;</span>personList<span class="nt">&lt;/templatename&gt;</span>
2258         <span class="nt">&lt;/templatelistener&gt;</span>
2259         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;personListBirthdayColumn&quot;</span><span class="nt">&gt;</span>
2260             <span class="nt">&lt;eventname&gt;</span>columns<span class="nt">&lt;/eventname&gt;</span>
2261             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2262             <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>
2263             <span class="nt">&lt;templatename&gt;</span>personList<span class="nt">&lt;/templatename&gt;</span>
2264         <span class="nt">&lt;/templatelistener&gt;</span>
2265         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;personAddBirthday&quot;</span><span class="nt">&gt;</span>
2266             <span class="nt">&lt;eventname&gt;</span>dataFields<span class="nt">&lt;/eventname&gt;</span>
2267             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2268             <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>
2269             <span class="nt">&lt;templatename&gt;</span>personAdd<span class="nt">&lt;/templatename&gt;</span>
2270         <span class="nt">&lt;/templatelistener&gt;</span>
2271         <span class="c">&lt;!-- /admin --&gt;</span>
2272
2273         <span class="c">&lt;!-- user --&gt;</span>
2274         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;personListBirthday&quot;</span><span class="nt">&gt;</span>
2275             <span class="nt">&lt;eventname&gt;</span>personStatistics<span class="nt">&lt;/eventname&gt;</span>
2276             <span class="nt">&lt;environment&gt;</span>user<span class="nt">&lt;/environment&gt;</span>
2277             <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>
2278             <span class="nt">&lt;templatename&gt;</span>personList<span class="nt">&lt;/templatename&gt;</span>
2279         <span class="nt">&lt;/templatelistener&gt;</span>
2280         <span class="nt">&lt;templatelistener</span> <span class="na">name=</span><span class="s">&quot;personListBirthdaySortField&quot;</span><span class="nt">&gt;</span>
2281             <span class="nt">&lt;eventname&gt;</span>sortField<span class="nt">&lt;/eventname&gt;</span>
2282             <span class="nt">&lt;environment&gt;</span>user<span class="nt">&lt;/environment&gt;</span>
2283             <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>
2284             <span class="nt">&lt;templatename&gt;</span>personList<span class="nt">&lt;/templatename&gt;</span>
2285         <span class="nt">&lt;/templatelistener&gt;</span>
2286         <span class="c">&lt;!-- /user --&gt;</span>
2287     <span class="nt">&lt;/import&gt;</span>
2288 <span class="nt">&lt;/data&gt;</span>
2289 </code></pre></div>
2290 <p>In cases where a template is used, we simply use the <code>include</code> syntax to load the template.</p>
2291 <h2 id="eventlistenerxml"><code>eventListener.xml</code><a class="headerlink" href="#eventlistenerxml" title="Permanent link">#</a></h2>
2292 <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.
2293 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.
2294 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>
2295 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2296 <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>
2297     <span class="nt">&lt;import&gt;</span>
2298         <span class="c">&lt;!-- admin --&gt;</span>
2299         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;birthdaySortFieldAdminPersonList&quot;</span><span class="nt">&gt;</span>
2300             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2301             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\page\PersonListPage<span class="nt">&lt;/eventclassname&gt;</span>
2302             <span class="nt">&lt;eventname&gt;</span>validateSortField<span class="nt">&lt;/eventname&gt;</span>
2303             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener<span class="nt">&lt;/listenerclassname&gt;</span>
2304         <span class="nt">&lt;/eventlistener&gt;</span>
2305         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;birthdayPersonAddForm&quot;</span><span class="nt">&gt;</span>
2306             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2307             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\form\PersonAddForm<span class="nt">&lt;/eventclassname&gt;</span>
2308             <span class="nt">&lt;eventname&gt;</span>saved<span class="nt">&lt;/eventname&gt;</span>
2309             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\BirthdayPersonAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2310         <span class="nt">&lt;/eventlistener&gt;</span>
2311         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;birthdayPersonAddFormInherited&quot;</span><span class="nt">&gt;</span>
2312             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2313             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\form\PersonAddForm<span class="nt">&lt;/eventclassname&gt;</span>
2314             <span class="nt">&lt;eventname&gt;</span>assignVariables,readFormParameters,save,validate<span class="nt">&lt;/eventname&gt;</span>
2315             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\BirthdayPersonAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2316             <span class="nt">&lt;inherit&gt;</span>1<span class="nt">&lt;/inherit&gt;</span>
2317         <span class="nt">&lt;/eventlistener&gt;</span>
2318         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;birthdayPersonEditForm&quot;</span><span class="nt">&gt;</span>
2319             <span class="nt">&lt;environment&gt;</span>admin<span class="nt">&lt;/environment&gt;</span>
2320             <span class="nt">&lt;eventclassname&gt;</span>wcf\acp\form\PersonEditForm<span class="nt">&lt;/eventclassname&gt;</span>
2321             <span class="nt">&lt;eventname&gt;</span>readData<span class="nt">&lt;/eventname&gt;</span>
2322             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\BirthdayPersonAddFormListener<span class="nt">&lt;/listenerclassname&gt;</span>
2323         <span class="nt">&lt;/eventlistener&gt;</span>
2324         <span class="c">&lt;!-- /admin --&gt;</span>
2325
2326         <span class="c">&lt;!-- user --&gt;</span>
2327         <span class="nt">&lt;eventlistener</span> <span class="na">name=</span><span class="s">&quot;birthdaySortFieldPersonList&quot;</span><span class="nt">&gt;</span>
2328             <span class="nt">&lt;environment&gt;</span>user<span class="nt">&lt;/environment&gt;</span>
2329             <span class="nt">&lt;eventclassname&gt;</span>wcf\page\PersonListPage<span class="nt">&lt;/eventclassname&gt;</span>
2330             <span class="nt">&lt;eventname&gt;</span>validateSortField<span class="nt">&lt;/eventname&gt;</span>
2331             <span class="nt">&lt;listenerclassname&gt;</span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener<span class="nt">&lt;/listenerclassname&gt;</span>
2332         <span class="nt">&lt;/eventlistener&gt;</span>
2333         <span class="c">&lt;!-- /user --&gt;</span>
2334     <span class="nt">&lt;/import&gt;</span>
2335 <span class="nt">&lt;/data&gt;</span>
2336 </code></pre></div>
2337 <h2 id="packagexml"><code>package.xml</code><a class="headerlink" href="#packagexml" title="Permanent link">#</a></h2>
2338 <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>
2339 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
2340 <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>
2341     <span class="nt">&lt;packageinformation&gt;</span>
2342         <span class="nt">&lt;packagename&gt;</span>WoltLab Suite Core Tutorial: People (Birthday)<span class="nt">&lt;/packagename&gt;</span>
2343         <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>
2344         <span class="nt">&lt;version&gt;</span>3.1.0<span class="nt">&lt;/version&gt;</span>
2345         <span class="nt">&lt;date&gt;</span>2018-03-30<span class="nt">&lt;/date&gt;</span>
2346     <span class="nt">&lt;/packageinformation&gt;</span>
2347
2348     <span class="nt">&lt;authorinformation&gt;</span>
2349         <span class="nt">&lt;author&gt;</span>WoltLab GmbH<span class="nt">&lt;/author&gt;</span>
2350         <span class="nt">&lt;authorurl&gt;</span>http://www.woltlab.com<span class="nt">&lt;/authorurl&gt;</span>
2351     <span class="nt">&lt;/authorinformation&gt;</span>
2352
2353     <span class="nt">&lt;requiredpackages&gt;</span>
2354         <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>
2355         <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>
2356     <span class="nt">&lt;/requiredpackages&gt;</span>
2357
2358     <span class="nt">&lt;excludedpackages&gt;</span>
2359         <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>
2360     <span class="nt">&lt;/excludedpackages&gt;</span>
2361
2362     <span class="nt">&lt;compatibility&gt;</span>
2363         <span class="nt">&lt;api</span> <span class="na">version=</span><span class="s">&quot;2018&quot;</span> <span class="nt">/&gt;</span>
2364     <span class="nt">&lt;/compatibility&gt;</span>
2365
2366     <span class="nt">&lt;instructions</span> <span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
2367         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;acpTemplate&quot;</span> <span class="nt">/&gt;</span>
2368         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;file&quot;</span> <span class="nt">/&gt;</span>
2369         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;sql&quot;</span> <span class="nt">/&gt;</span>
2370         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;template&quot;</span> <span class="nt">/&gt;</span>
2371         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;language&quot;</span> <span class="nt">/&gt;</span>
2372
2373         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;eventListener&quot;</span> <span class="nt">/&gt;</span>
2374         <span class="nt">&lt;instruction</span> <span class="na">type=</span><span class="s">&quot;templateListener&quot;</span> <span class="nt">/&gt;</span>
2375     <span class="nt">&lt;/instructions&gt;</span>
2376 <span class="nt">&lt;/package&gt;</span>
2377 </code></pre></div>
2378 <hr />
2379 <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>
2380 <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>
2381
2382
2383
2384
2385 <hr>
2386 <div class="md-source-date">
2387   <small>
2388
2389       Last update: 2021-04-07
2390
2391   </small>
2392 </div>
2393
2394
2395
2396
2397
2398
2399
2400
2401             </article>
2402           </div>
2403         </div>
2404
2405       </main>
2406
2407
2408 <footer class="md-footer">
2409
2410     <nav class="md-footer__inner md-grid" aria-label="Footer">
2411
2412         <a href="../part_1/" class="md-footer__link md-footer__link--prev" rel="prev">
2413           <div class="md-footer__button md-icon">
2414             <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>
2415           </div>
2416           <div class="md-footer__title">
2417             <div class="md-ellipsis">
2418               <span class="md-footer__direction">
2419                 Previous
2420               </span>
2421               Part 1
2422             </div>
2423           </div>
2424         </a>
2425
2426
2427         <a href="../part_3/" class="md-footer__link md-footer__link--next" rel="next">
2428           <div class="md-footer__title">
2429             <div class="md-ellipsis">
2430               <span class="md-footer__direction">
2431                 Next
2432               </span>
2433               Part 3
2434             </div>
2435           </div>
2436           <div class="md-footer__button md-icon">
2437             <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>
2438           </div>
2439         </a>
2440
2441     </nav>
2442
2443   <div class="md-footer-meta md-typeset">
2444     <div class="md-footer-meta__inner md-grid">
2445       <div class="md-footer-copyright">
2446
2447           <div class="md-footer-copyright__highlight">
2448             Copyright © 2020 WoltLab GmbH
2449           </div>
2450
2451         Made with
2452         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2453           Material for MkDocs
2454         </a>
2455
2456       </div>
2457       <div class="md-footer-copyright">
2458         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2459         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2460 </div>
2461     </div>
2462   </div>
2463 </footer>
2464
2465     </div>
2466     <div class="md-dialog" data-md-component="dialog">
2467       <div class="md-dialog__inner md-typeset"></div>
2468     </div>
2469     <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>
2470
2471
2472       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2473
2474
2475   </body>
2476 </html>