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