5.4/tutorial/series/part_2/index.html

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