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