6.0/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         <link rel="canonical" href="https://docs.woltlab.com/6.0/tutorial/series/part_1/">
  12
  13
  14         <link rel="prev" href="../overview/">
  15
  16
  17         <link rel="next" href="../part_2/">
  18
  19       <link rel="icon" href="../../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
  21
  22
  23
  24         <title>Part 1 - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../../assets/stylesheets/main.26e3688c.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../../assets/stylesheets/palette.ecc896b0.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#tutorial-series-part-1-base-structure" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94
  95
  96 <header class="md-header md-header--shadow" data-md-component="header">
  97   <nav class="md-header__inner md-grid" aria-label="Header">
  98     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  99
 100   <img src="../../../assets/logo.png" alt="logo">
 101
 102     </a>
 103     <label class="md-header__button md-icon" for="__drawer">
 104       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 105     </label>
 106     <div class="md-header__title" data-md-component="header-title">
 107       <div class="md-header__ellipsis">
 108         <div class="md-header__topic">
 109           <span class="md-ellipsis">
 110             WoltLab Suite Documentation
 111           </span>
 112         </div>
 113         <div class="md-header__topic" data-md-component="header-topic">
 114           <span class="md-ellipsis">
 115
 116               Part 1
 117
 118           </span>
 119         </div>
 120       </div>
 121     </div>
 122
 123
 124
 125
 126
 127       <label class="md-header__button md-icon" for="__search">
 128         <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>
 129       </label>
 130       <div class="md-search" data-md-component="search" role="dialog">
 131   <label class="md-search__overlay" for="__search"></label>
 132   <div class="md-search__inner" role="search">
 133     <form class="md-search__form" name="search">
 134       <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" required>
 135       <label class="md-search__icon md-icon" for="__search">
 136         <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>
 137         <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>
 138       </label>
 139       <nav class="md-search__options" aria-label="Search">
 140
 141         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 142           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
 143         </button>
 144       </nav>
 145
 146     </form>
 147     <div class="md-search__output">
 148       <div class="md-search__scrollwrap" data-md-scrollfix>
 149         <div class="md-search-result" data-md-component="search-result">
 150           <div class="md-search-result__meta">
 151             Initializing search
 152           </div>
 153           <ol class="md-search-result__list" role="presentation"></ol>
 154         </div>
 155       </div>
 156     </div>
 157   </div>
 158 </div>
 159
 160
 161       <div class="md-header__source">
 162         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 163   <div class="md-source__icon md-icon">
 164
 165     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 166   </div>
 167   <div class="md-source__repository">
 168     GitHub
 169   </div>
 170 </a>
 171       </div>
 172
 173   </nav>
 174
 175 </header>
 176
 177     <div class="md-container" data-md-component="container">
 178
 179
 180
 181
 182
 183
 184       <main class="md-main" data-md-component="main">
 185         <div class="md-main__inner md-grid">
 186
 187
 188
 189               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 190                 <div class="md-sidebar__scrollwrap">
 191                   <div class="md-sidebar__inner">
 192
 193
 194
 195 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 196   <label class="md-nav__title" for="__drawer">
 197     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 198
 199   <img src="../../../assets/logo.png" alt="logo">
 200
 201     </a>
 202     WoltLab Suite Documentation
 203   </label>
 204
 205     <div class="md-nav__source">
 206       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 207   <div class="md-source__icon md-icon">
 208
 209     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 210   </div>
 211   <div class="md-source__repository">
 212     GitHub
 213   </div>
 214 </a>
 215     </div>
 216
 217   <ul class="md-nav__list" data-md-scrollfix>
 218
 219
 220
 221
 222
 223
 224
 225
 226     <li class="md-nav__item">
 227       <a href="../../../getting-started/" class="md-nav__link">
 228         Getting Started
 229       </a>
 230     </li>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242     <li class="md-nav__item md-nav__item--nested">
 243
 244
 245
 246
 247       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 248
 249
 250
 251         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 252           PHP API
 253           <span class="md-nav__icon md-icon"></span>
 254         </label>
 255
 256       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 257         <label class="md-nav__title" for="__nav_2">
 258           <span class="md-nav__icon md-icon"></span>
 259           PHP API
 260         </label>
 261         <ul class="md-nav__list" data-md-scrollfix>
 262
 263
 264
 265
 266
 267
 268     <li class="md-nav__item">
 269       <a href="../../../php/pages/" class="md-nav__link">
 270         Pages
 271       </a>
 272     </li>
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282     <li class="md-nav__item">
 283       <a href="../../../php/database-objects/" class="md-nav__link">
 284         Database Objects
 285       </a>
 286     </li>
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296     <li class="md-nav__item">
 297       <a href="../../../php/database-access/" class="md-nav__link">
 298         Database Access
 299       </a>
 300     </li>
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../../php/exceptions/" class="md-nav__link">
 312         Exceptions
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item md-nav__item--nested">
 326
 327
 328
 329
 330       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 331
 332
 333
 334         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 335           API
 336           <span class="md-nav__icon md-icon"></span>
 337         </label>
 338
 339       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 340         <label class="md-nav__title" for="__nav_2_5">
 341           <span class="md-nav__icon md-icon"></span>
 342           API
 343         </label>
 344         <ul class="md-nav__list" data-md-scrollfix>
 345
 346
 347
 348
 349
 350
 351
 352     <li class="md-nav__item md-nav__item--nested">
 353
 354
 355
 356
 357       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 358
 359
 360
 361         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 362           Caches
 363           <span class="md-nav__icon md-icon"></span>
 364         </label>
 365
 366       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 367         <label class="md-nav__title" for="__nav_2_5_1">
 368           <span class="md-nav__icon md-icon"></span>
 369           Caches
 370         </label>
 371         <ul class="md-nav__list" data-md-scrollfix>
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item">
 379       <a href="../../../php/api/caches/" class="md-nav__link">
 380         Overview
 381       </a>
 382     </li>
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392     <li class="md-nav__item">
 393       <a href="../../../php/api/caches_persistent-caches/" class="md-nav__link">
 394         Persistent Caches
 395       </a>
 396     </li>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../../../php/api/caches_runtime-caches/" class="md-nav__link">
 408         Runtime Caches
 409       </a>
 410     </li>
 411
 412
 413
 414
 415         </ul>
 416       </nav>
 417     </li>
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427     <li class="md-nav__item">
 428       <a href="../../../php/api/comments/" class="md-nav__link">
 429         Comments
 430       </a>
 431     </li>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <li class="md-nav__item">
 442       <a href="../../../php/api/cronjobs/" class="md-nav__link">
 443         Cronjobs
 444       </a>
 445     </li>
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455     <li class="md-nav__item">
 456       <a href="../../../php/api/events/" class="md-nav__link">
 457         Events
 458       </a>
 459     </li>
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470     <li class="md-nav__item md-nav__item--nested">
 471
 472
 473
 474
 475       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 476
 477
 478
 479         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 480           Form Builder
 481           <span class="md-nav__icon md-icon"></span>
 482         </label>
 483
 484       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 485         <label class="md-nav__title" for="__nav_2_5_5">
 486           <span class="md-nav__icon md-icon"></span>
 487           Form Builder
 488         </label>
 489         <ul class="md-nav__list" data-md-scrollfix>
 490
 491
 492
 493
 494
 495
 496     <li class="md-nav__item">
 497       <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
 498         Overview
 499       </a>
 500     </li>
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510     <li class="md-nav__item">
 511       <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
 512         Structure
 513       </a>
 514     </li>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524     <li class="md-nav__item">
 525       <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
 526         Fields
 527       </a>
 528     </li>
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538     <li class="md-nav__item">
 539       <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
 540         Validation and Data
 541       </a>
 542     </li>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552     <li class="md-nav__item">
 553       <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
 554         Dependencies
 555       </a>
 556     </li>
 557
 558
 559
 560
 561         </ul>
 562       </nav>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573     <li class="md-nav__item">
 574       <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
 575         Package Installation Plugins
 576       </a>
 577     </li>
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item">
 588       <a href="../../../php/api/user_activity_points/" class="md-nav__link">
 589         User Activity Points
 590       </a>
 591     </li>
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601     <li class="md-nav__item">
 602       <a href="../../../php/api/user_notifications/" class="md-nav__link">
 603         User Notifications
 604       </a>
 605     </li>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615     <li class="md-nav__item">
 616       <a href="../../../php/api/sitemaps/" class="md-nav__link">
 617         Sitemaps
 618       </a>
 619     </li>
 620
 621
 622
 623
 624         </ul>
 625       </nav>
 626     </li>
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636     <li class="md-nav__item">
 637       <a href="../../../php/code-style/" class="md-nav__link">
 638         Code Style
 639       </a>
 640     </li>
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650     <li class="md-nav__item">
 651       <a href="../../../php/apps/" class="md-nav__link">
 652         Apps
 653       </a>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../../php/gdpr/" class="md-nav__link">
 666         GDPR
 667       </a>
 668     </li>
 669
 670
 671
 672
 673         </ul>
 674       </nav>
 675     </li>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687     <li class="md-nav__item md-nav__item--nested">
 688
 689
 690
 691
 692       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 693
 694
 695
 696         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 697           Languages, Templates & CSS
 698           <span class="md-nav__icon md-icon"></span>
 699         </label>
 700
 701       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 702         <label class="md-nav__title" for="__nav_3">
 703           <span class="md-nav__icon md-icon"></span>
 704           Languages, Templates & CSS
 705         </label>
 706         <ul class="md-nav__list" data-md-scrollfix>
 707
 708
 709
 710
 711
 712
 713     <li class="md-nav__item">
 714       <a href="../../../view/languages/" class="md-nav__link">
 715         Languages
 716       </a>
 717     </li>
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727     <li class="md-nav__item">
 728       <a href="../../../view/templates/" class="md-nav__link">
 729         Templates
 730       </a>
 731     </li>
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741     <li class="md-nav__item">
 742       <a href="../../../view/template-modifiers/" class="md-nav__link">
 743         Template Modifiers
 744       </a>
 745     </li>
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755     <li class="md-nav__item">
 756       <a href="../../../view/template-plugins/" class="md-nav__link">
 757         Template Plugins
 758       </a>
 759     </li>
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769     <li class="md-nav__item">
 770       <a href="../../../view/css/" class="md-nav__link">
 771         CSS
 772       </a>
 773     </li>
 774
 775
 776
 777
 778         </ul>
 779       </nav>
 780     </li>
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792     <li class="md-nav__item md-nav__item--nested">
 793
 794
 795
 796
 797       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 798
 799
 800
 801         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 802           TypeScript and JavaScript API
 803           <span class="md-nav__icon md-icon"></span>
 804         </label>
 805
 806       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 807         <label class="md-nav__title" for="__nav_4">
 808           <span class="md-nav__icon md-icon"></span>
 809           TypeScript and JavaScript API
 810         </label>
 811         <ul class="md-nav__list" data-md-scrollfix>
 812
 813
 814
 815
 816
 817
 818     <li class="md-nav__item">
 819       <a href="../../../javascript/general-usage/" class="md-nav__link">
 820         General Usage
 821       </a>
 822     </li>
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847     <li class="md-nav__item md-nav__item--nested">
 848
 849
 850
 851
 852       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 853
 854
 855
 856         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 857           Components
 858           <span class="md-nav__icon md-icon"></span>
 859         </label>
 860
 861       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 862         <label class="md-nav__title" for="__nav_4_3">
 863           <span class="md-nav__icon md-icon"></span>
 864           Components
 865         </label>
 866         <ul class="md-nav__list" data-md-scrollfix>
 867
 868
 869
 870
 871
 872
 873     <li class="md-nav__item">
 874       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
 875         Confirmation
 876       </a>
 877     </li>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../../javascript/components_dialog/" class="md-nav__link">
 889         Dialog
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
 903         Google Maps
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915     <li class="md-nav__item">
 916       <a href="../../../javascript/components_pagination/" class="md-nav__link">
 917         Pagination
 918       </a>
 919     </li>
 920
 921
 922
 923
 924         </ul>
 925       </nav>
 926     </li>
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item md-nav__item--nested">
 938
 939
 940
 941
 942       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 943
 944
 945
 946         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 947           New API
 948           <span class="md-nav__icon md-icon"></span>
 949         </label>
 950
 951       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 952         <label class="md-nav__title" for="__nav_4_4">
 953           <span class="md-nav__icon md-icon"></span>
 954           New API
 955         </label>
 956         <ul class="md-nav__list" data-md-scrollfix>
 957
 958
 959
 960
 961
 962
 963     <li class="md-nav__item">
 964       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 965         Writing a module
 966       </a>
 967     </li>
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977     <li class="md-nav__item">
 978       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 979         Core Functions
 980       </a>
 981     </li>
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 993         DOM
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005     <li class="md-nav__item">
1006       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1007         Event Handling
1008       </a>
1009     </li>
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019     <li class="md-nav__item">
1020       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1021         Ajax
1022       </a>
1023     </li>
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1035         Dialogs
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047     <li class="md-nav__item">
1048       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1049         Browser and Screen Sizes
1050       </a>
1051     </li>
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061     <li class="md-nav__item">
1062       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1063         User Interface
1064       </a>
1065     </li>
1066
1067
1068
1069
1070         </ul>
1071       </nav>
1072     </li>
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082     <li class="md-nav__item">
1083       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1084         Legacy API
1085       </a>
1086     </li>
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096     <li class="md-nav__item">
1097       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1098         Code Snippets
1099       </a>
1100     </li>
1101
1102
1103
1104
1105         </ul>
1106       </nav>
1107     </li>
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119     <li class="md-nav__item md-nav__item--nested">
1120
1121
1122
1123
1124       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1125
1126
1127
1128         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1129           Package Components
1130           <span class="md-nav__icon md-icon"></span>
1131         </label>
1132
1133       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1134         <label class="md-nav__title" for="__nav_5">
1135           <span class="md-nav__icon md-icon"></span>
1136           Package Components
1137         </label>
1138         <ul class="md-nav__list" data-md-scrollfix>
1139
1140
1141
1142
1143
1144
1145     <li class="md-nav__item">
1146       <a href="../../../package/package-xml/" class="md-nav__link">
1147         package.xml
1148       </a>
1149     </li>
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160     <li class="md-nav__item md-nav__item--nested">
1161
1162
1163
1164
1165       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1166
1167
1168
1169         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1170           PIPs
1171           <span class="md-nav__icon md-icon"></span>
1172         </label>
1173
1174       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1175         <label class="md-nav__title" for="__nav_5_2">
1176           <span class="md-nav__icon md-icon"></span>
1177           PIPs
1178         </label>
1179         <ul class="md-nav__list" data-md-scrollfix>
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../../../package/pip/" class="md-nav__link">
1188         Overview
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200     <li class="md-nav__item">
1201       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1202         aclOption
1203       </a>
1204     </li>
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214     <li class="md-nav__item">
1215       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1216         acpMenu
1217       </a>
1218     </li>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228     <li class="md-nav__item">
1229       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1230         acpSearchProvider
1231       </a>
1232     </li>
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242     <li class="md-nav__item">
1243       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1244         acpTemplate
1245       </a>
1246     </li>
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item">
1257       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1258         acpTemplateDelete
1259       </a>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1272         bbcode
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284     <li class="md-nav__item">
1285       <a href="../../../package/pip/box/" class="md-nav__link">
1286         box
1287       </a>
1288     </li>
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298     <li class="md-nav__item">
1299       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1300         clipboardAction
1301       </a>
1302     </li>
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312     <li class="md-nav__item">
1313       <a href="../../../package/pip/core-object/" class="md-nav__link">
1314         coreObject
1315       </a>
1316     </li>
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326     <li class="md-nav__item">
1327       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1328         cronjob
1329       </a>
1330     </li>
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../../../package/pip/database/" class="md-nav__link">
1342         database
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1356         eventListener
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368     <li class="md-nav__item">
1369       <a href="../../../package/pip/file/" class="md-nav__link">
1370         file
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../../package/pip/file-delete/" class="md-nav__link">
1384         fileDelete
1385       </a>
1386     </li>
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396     <li class="md-nav__item">
1397       <a href="../../../package/pip/language/" class="md-nav__link">
1398         language
1399       </a>
1400     </li>
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410     <li class="md-nav__item">
1411       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1412         mediaProvider
1413       </a>
1414     </li>
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424     <li class="md-nav__item">
1425       <a href="../../../package/pip/menu/" class="md-nav__link">
1426         menu
1427       </a>
1428     </li>
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1440         menuItem
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item">
1453       <a href="../../../package/pip/object-type/" class="md-nav__link">
1454         objectType
1455       </a>
1456     </li>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466     <li class="md-nav__item">
1467       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1468         objectTypeDefinition
1469       </a>
1470     </li>
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480     <li class="md-nav__item">
1481       <a href="../../../package/pip/option/" class="md-nav__link">
1482         option
1483       </a>
1484     </li>
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494     <li class="md-nav__item">
1495       <a href="../../../package/pip/page/" class="md-nav__link">
1496         page
1497       </a>
1498     </li>
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508     <li class="md-nav__item">
1509       <a href="../../../package/pip/pip/" class="md-nav__link">
1510         pip
1511       </a>
1512     </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522     <li class="md-nav__item">
1523       <a href="../../../package/pip/script/" class="md-nav__link">
1524         script
1525       </a>
1526     </li>
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536     <li class="md-nav__item">
1537       <a href="../../../package/pip/smiley/" class="md-nav__link">
1538         smiley
1539       </a>
1540     </li>
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550     <li class="md-nav__item">
1551       <a href="../../../package/pip/sql/" class="md-nav__link">
1552         sql
1553       </a>
1554     </li>
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564     <li class="md-nav__item">
1565       <a href="../../../package/pip/style/" class="md-nav__link">
1566         style
1567       </a>
1568     </li>
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578     <li class="md-nav__item">
1579       <a href="../../../package/pip/template/" class="md-nav__link">
1580         template
1581       </a>
1582     </li>
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../../package/pip/template-delete/" class="md-nav__link">
1594         templateDelete
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1608         templateListener
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620     <li class="md-nav__item">
1621       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1622         userGroupOption
1623       </a>
1624     </li>
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634     <li class="md-nav__item">
1635       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1636         userMenu
1637       </a>
1638     </li>
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648     <li class="md-nav__item">
1649       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1650         userNotificationEvent
1651       </a>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item">
1663       <a href="../../../package/pip/user-option/" class="md-nav__link">
1664         userOption
1665       </a>
1666     </li>
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676     <li class="md-nav__item">
1677       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1678         userProfileMenu
1679       </a>
1680     </li>
1681
1682
1683
1684
1685         </ul>
1686       </nav>
1687     </li>
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697     <li class="md-nav__item">
1698       <a href="../../../package/database-php-api/" class="md-nav__link">
1699         Database PHP API
1700       </a>
1701     </li>
1702
1703
1704
1705
1706         </ul>
1707       </nav>
1708     </li>
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item md-nav__item--nested">
1721
1722
1723
1724
1725       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1726
1727
1728
1729         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1730           Migration
1731           <span class="md-nav__icon md-icon"></span>
1732         </label>
1733
1734       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1735         <label class="md-nav__title" for="__nav_6">
1736           <span class="md-nav__icon md-icon"></span>
1737           Migration
1738         </label>
1739         <ul class="md-nav__list" data-md-scrollfix>
1740
1741
1742
1743
1744
1745
1746
1747     <li class="md-nav__item md-nav__item--nested">
1748
1749
1750
1751
1752       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1753
1754
1755
1756         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1757           From WoltLab Suite 5.5
1758           <span class="md-nav__icon md-icon"></span>
1759         </label>
1760
1761       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1762         <label class="md-nav__title" for="__nav_6_1">
1763           <span class="md-nav__icon md-icon"></span>
1764           From WoltLab Suite 5.5
1765         </label>
1766         <ul class="md-nav__list" data-md-scrollfix>
1767
1768
1769
1770
1771
1772
1773     <li class="md-nav__item">
1774       <a href="../../../migration/wsc55/php/" class="md-nav__link">
1775         PHP API
1776       </a>
1777     </li>
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787     <li class="md-nav__item">
1788       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
1789         TypeScript and JavaScript
1790       </a>
1791     </li>
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801     <li class="md-nav__item">
1802       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
1803         Templates
1804       </a>
1805     </li>
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815     <li class="md-nav__item">
1816       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
1817         Icons
1818       </a>
1819     </li>
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829     <li class="md-nav__item">
1830       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
1831         Dialogs
1832       </a>
1833     </li>
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843     <li class="md-nav__item">
1844       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
1845         Third Party Libraries
1846       </a>
1847     </li>
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857     <li class="md-nav__item">
1858       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1859         Deprecations and Removals
1860       </a>
1861     </li>
1862
1863
1864
1865
1866         </ul>
1867       </nav>
1868     </li>
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879     <li class="md-nav__item md-nav__item--nested">
1880
1881
1882
1883
1884       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1885
1886
1887
1888         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1889           From WoltLab Suite 5.4
1890           <span class="md-nav__icon md-icon"></span>
1891         </label>
1892
1893       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1894         <label class="md-nav__title" for="__nav_6_2">
1895           <span class="md-nav__icon md-icon"></span>
1896           From WoltLab Suite 5.4
1897         </label>
1898         <ul class="md-nav__list" data-md-scrollfix>
1899
1900
1901
1902
1903
1904
1905     <li class="md-nav__item">
1906       <a href="../../../migration/wsc54/php/" class="md-nav__link">
1907         PHP API
1908       </a>
1909     </li>
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919     <li class="md-nav__item">
1920       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
1921         TypeScript and JavaScript
1922       </a>
1923     </li>
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933     <li class="md-nav__item">
1934       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
1935         Templates
1936       </a>
1937     </li>
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947     <li class="md-nav__item">
1948       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
1949         Third Party Libraries
1950       </a>
1951     </li>
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961     <li class="md-nav__item">
1962       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
1963         Deprecations and Removals
1964       </a>
1965     </li>
1966
1967
1968
1969
1970         </ul>
1971       </nav>
1972     </li>
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983     <li class="md-nav__item md-nav__item--nested">
1984
1985
1986
1987
1988       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
1989
1990
1991
1992         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
1993           From WoltLab Suite 5.3
1994           <span class="md-nav__icon md-icon"></span>
1995         </label>
1996
1997       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
1998         <label class="md-nav__title" for="__nav_6_3">
1999           <span class="md-nav__icon md-icon"></span>
2000           From WoltLab Suite 5.3
2001         </label>
2002         <ul class="md-nav__list" data-md-scrollfix>
2003
2004
2005
2006
2007
2008
2009     <li class="md-nav__item">
2010       <a href="../../../migration/wsc53/php/" class="md-nav__link">
2011         PHP API
2012       </a>
2013     </li>
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023     <li class="md-nav__item">
2024       <a href="../../../migration/wsc53/session/" class="md-nav__link">
2025         Session Handling and Authentication
2026       </a>
2027     </li>
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037     <li class="md-nav__item">
2038       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
2039         TypeScript and JavaScript
2040       </a>
2041     </li>
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051     <li class="md-nav__item">
2052       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
2053         Templates
2054       </a>
2055     </li>
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065     <li class="md-nav__item">
2066       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
2067         Third Party Libraries
2068       </a>
2069     </li>
2070
2071
2072
2073
2074         </ul>
2075       </nav>
2076     </li>
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087     <li class="md-nav__item md-nav__item--nested">
2088
2089
2090
2091
2092       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2093
2094
2095
2096         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2097           From WoltLab Suite 5.2
2098           <span class="md-nav__icon md-icon"></span>
2099         </label>
2100
2101       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2102         <label class="md-nav__title" for="__nav_6_4">
2103           <span class="md-nav__icon md-icon"></span>
2104           From WoltLab Suite 5.2
2105         </label>
2106         <ul class="md-nav__list" data-md-scrollfix>
2107
2108
2109
2110
2111
2112
2113     <li class="md-nav__item">
2114       <a href="../../../migration/wsc52/php/" class="md-nav__link">
2115         PHP API
2116       </a>
2117     </li>
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127     <li class="md-nav__item">
2128       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
2129         Templates and Languages
2130       </a>
2131     </li>
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141     <li class="md-nav__item">
2142       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
2143         Third Party Libraries
2144       </a>
2145     </li>
2146
2147
2148
2149
2150         </ul>
2151       </nav>
2152     </li>
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163     <li class="md-nav__item md-nav__item--nested">
2164
2165
2166
2167
2168       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2169
2170
2171
2172         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2173           From WoltLab Suite 3.1
2174           <span class="md-nav__icon md-icon"></span>
2175         </label>
2176
2177       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2178         <label class="md-nav__title" for="__nav_6_5">
2179           <span class="md-nav__icon md-icon"></span>
2180           From WoltLab Suite 3.1
2181         </label>
2182         <ul class="md-nav__list" data-md-scrollfix>
2183
2184
2185
2186
2187
2188
2189     <li class="md-nav__item">
2190       <a href="../../../migration/wsc31/php/" class="md-nav__link">
2191         PHP API
2192       </a>
2193     </li>
2194
2195
2196
2197
2198         </ul>
2199       </nav>
2200     </li>
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211     <li class="md-nav__item md-nav__item--nested">
2212
2213
2214
2215
2216       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2217
2218
2219
2220         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2221           From WoltLab Suite 3.0
2222           <span class="md-nav__icon md-icon"></span>
2223         </label>
2224
2225       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2226         <label class="md-nav__title" for="__nav_6_6">
2227           <span class="md-nav__icon md-icon"></span>
2228           From WoltLab Suite 3.0
2229         </label>
2230         <ul class="md-nav__list" data-md-scrollfix>
2231
2232
2233
2234
2235
2236
2237     <li class="md-nav__item">
2238       <a href="../../../migration/wsc30/php/" class="md-nav__link">
2239         PHP API
2240       </a>
2241     </li>
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251     <li class="md-nav__item">
2252       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
2253         JavaScript API
2254       </a>
2255     </li>
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265     <li class="md-nav__item">
2266       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
2267         Templates
2268       </a>
2269     </li>
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279     <li class="md-nav__item">
2280       <a href="../../../migration/wsc30/css/" class="md-nav__link">
2281         CSS
2282       </a>
2283     </li>
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293     <li class="md-nav__item">
2294       <a href="../../../migration/wsc30/package/" class="md-nav__link">
2295         Package Components
2296       </a>
2297     </li>
2298
2299
2300
2301
2302         </ul>
2303       </nav>
2304     </li>
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315     <li class="md-nav__item md-nav__item--nested">
2316
2317
2318
2319
2320       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2321
2322
2323
2324         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2325           From WCF 2.1
2326           <span class="md-nav__icon md-icon"></span>
2327         </label>
2328
2329       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2330         <label class="md-nav__title" for="__nav_6_7">
2331           <span class="md-nav__icon md-icon"></span>
2332           From WCF 2.1
2333         </label>
2334         <ul class="md-nav__list" data-md-scrollfix>
2335
2336
2337
2338
2339
2340
2341     <li class="md-nav__item">
2342       <a href="../../../migration/wcf21/php/" class="md-nav__link">
2343         PHP API
2344       </a>
2345     </li>
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355     <li class="md-nav__item">
2356       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
2357         Templates
2358       </a>
2359     </li>
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369     <li class="md-nav__item">
2370       <a href="../../../migration/wcf21/css/" class="md-nav__link">
2371         CSS
2372       </a>
2373     </li>
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383     <li class="md-nav__item">
2384       <a href="../../../migration/wcf21/package/" class="md-nav__link">
2385         Package Components
2386       </a>
2387     </li>
2388
2389
2390
2391
2392         </ul>
2393       </nav>
2394     </li>
2395
2396
2397
2398
2399         </ul>
2400       </nav>
2401     </li>
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2416
2417
2418
2419
2420       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
2421
2422
2423
2424         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2425           Tutorials
2426           <span class="md-nav__icon md-icon"></span>
2427         </label>
2428
2429       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
2430         <label class="md-nav__title" for="__nav_7">
2431           <span class="md-nav__icon md-icon"></span>
2432           Tutorials
2433         </label>
2434         <ul class="md-nav__list" data-md-scrollfix>
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
2445
2446
2447
2448
2449       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" checked>
2450
2451
2452
2453         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2454           Tutorial Series
2455           <span class="md-nav__icon md-icon"></span>
2456         </label>
2457
2458       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="true">
2459         <label class="md-nav__title" for="__nav_7_1">
2460           <span class="md-nav__icon md-icon"></span>
2461           Tutorial Series
2462         </label>
2463         <ul class="md-nav__list" data-md-scrollfix>
2464
2465
2466
2467
2468
2469
2470     <li class="md-nav__item">
2471       <a href="../overview/" class="md-nav__link">
2472         Overview
2473       </a>
2474     </li>
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486     <li class="md-nav__item md-nav__item--active">
2487
2488       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2489
2490
2491
2492
2493
2494         <label class="md-nav__link md-nav__link--active" for="__toc">
2495           Part 1
2496           <span class="md-nav__icon md-icon"></span>
2497         </label>
2498
2499       <a href="./" class="md-nav__link md-nav__link--active">
2500         Part 1
2501       </a>
2502
2503
2504
2505 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2506
2507
2508
2509
2510
2511
2512     <label class="md-nav__title" for="__toc">
2513       <span class="md-nav__icon md-icon"></span>
2514       Table of contents
2515     </label>
2516     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2517
2518         <li class="md-nav__item">
2519   <a href="#package-functionality" class="md-nav__link">
2520     Package Functionality
2521   </a>
2522
2523 </li>
2524
2525         <li class="md-nav__item">
2526   <a href="#used-components" class="md-nav__link">
2527     Used Components
2528   </a>
2529
2530 </li>
2531
2532         <li class="md-nav__item">
2533   <a href="#package-structure" class="md-nav__link">
2534     Package Structure
2535   </a>
2536
2537 </li>
2538
2539         <li class="md-nav__item">
2540   <a href="#person-modeling" class="md-nav__link">
2541     Person Modeling
2542   </a>
2543
2544     <nav class="md-nav" aria-label="Person Modeling">
2545       <ul class="md-nav__list">
2546
2547           <li class="md-nav__item">
2548   <a href="#database-table" class="md-nav__link">
2549     Database Table
2550   </a>
2551
2552 </li>
2553
2554           <li class="md-nav__item">
2555   <a href="#database-object" class="md-nav__link">
2556     Database Object
2557   </a>
2558
2559     <nav class="md-nav" aria-label="Database Object">
2560       <ul class="md-nav__list">
2561
2562           <li class="md-nav__item">
2563   <a href="#person" class="md-nav__link">
2564     Person
2565   </a>
2566
2567 </li>
2568
2569           <li class="md-nav__item">
2570   <a href="#personaction" class="md-nav__link">
2571     PersonAction
2572   </a>
2573
2574 </li>
2575
2576           <li class="md-nav__item">
2577   <a href="#personeditor" class="md-nav__link">
2578     PersonEditor
2579   </a>
2580
2581 </li>
2582
2583           <li class="md-nav__item">
2584   <a href="#personlist" class="md-nav__link">
2585     PersonList
2586   </a>
2587
2588 </li>
2589
2590       </ul>
2591     </nav>
2592
2593 </li>
2594
2595       </ul>
2596     </nav>
2597
2598 </li>
2599
2600         <li class="md-nav__item">
2601   <a href="#acp" class="md-nav__link">
2602     ACP
2603   </a>
2604
2605     <nav class="md-nav" aria-label="ACP">
2606       <ul class="md-nav__list">
2607
2608           <li class="md-nav__item">
2609   <a href="#acp-menu" class="md-nav__link">
2610     ACP Menu
2611   </a>
2612
2613 </li>
2614
2615           <li class="md-nav__item">
2616   <a href="#people-list" class="md-nav__link">
2617     People List
2618   </a>
2619
2620     <nav class="md-nav" aria-label="People List">
2621       <ul class="md-nav__list">
2622
2623           <li class="md-nav__item">
2624   <a href="#personlistpage" class="md-nav__link">
2625     PersonListPage
2626   </a>
2627
2628 </li>
2629
2630           <li class="md-nav__item">
2631   <a href="#personlisttpl" class="md-nav__link">
2632     personList.tpl
2633   </a>
2634
2635 </li>
2636
2637       </ul>
2638     </nav>
2639
2640 </li>
2641
2642           <li class="md-nav__item">
2643   <a href="#person-add-form" class="md-nav__link">
2644     Person Add Form
2645   </a>
2646
2647     <nav class="md-nav" aria-label="Person Add Form">
2648       <ul class="md-nav__list">
2649
2650           <li class="md-nav__item">
2651   <a href="#personaddform" class="md-nav__link">
2652     PersonAddForm
2653   </a>
2654
2655 </li>
2656
2657           <li class="md-nav__item">
2658   <a href="#personaddtpl" class="md-nav__link">
2659     personAdd.tpl
2660   </a>
2661
2662 </li>
2663
2664       </ul>
2665     </nav>
2666
2667 </li>
2668
2669           <li class="md-nav__item">
2670   <a href="#person-edit-form" class="md-nav__link">
2671     Person Edit Form
2672   </a>
2673
2674     <nav class="md-nav" aria-label="Person Edit Form">
2675       <ul class="md-nav__list">
2676
2677           <li class="md-nav__item">
2678   <a href="#personeditform" class="md-nav__link">
2679     PersonEditForm
2680   </a>
2681
2682 </li>
2683
2684       </ul>
2685     </nav>
2686
2687 </li>
2688
2689       </ul>
2690     </nav>
2691
2692 </li>
2693
2694         <li class="md-nav__item">
2695   <a href="#frontend" class="md-nav__link">
2696     Frontend
2697   </a>
2698
2699     <nav class="md-nav" aria-label="Frontend">
2700       <ul class="md-nav__list">
2701
2702           <li class="md-nav__item">
2703   <a href="#pagexml" class="md-nav__link">
2704     page.xml
2705   </a>
2706
2707 </li>
2708
2709           <li class="md-nav__item">
2710   <a href="#menuitemxml" class="md-nav__link">
2711     menuItem.xml
2712   </a>
2713
2714 </li>
2715
2716           <li class="md-nav__item">
2717   <a href="#people-list_1" class="md-nav__link">
2718     People List
2719   </a>
2720
2721     <nav class="md-nav" aria-label="People List">
2722       <ul class="md-nav__list">
2723
2724           <li class="md-nav__item">
2725   <a href="#personlistpage_1" class="md-nav__link">
2726     PersonListPage
2727   </a>
2728
2729 </li>
2730
2731           <li class="md-nav__item">
2732   <a href="#personlisttpl_1" class="md-nav__link">
2733     personList.tpl
2734   </a>
2735
2736 </li>
2737
2738       </ul>
2739     </nav>
2740
2741 </li>
2742
2743       </ul>
2744     </nav>
2745
2746 </li>
2747
2748         <li class="md-nav__item">
2749   <a href="#usergroupoptionxml" class="md-nav__link">
2750     userGroupOption.xml
2751   </a>
2752
2753 </li>
2754
2755         <li class="md-nav__item">
2756   <a href="#packagexml" class="md-nav__link">
2757     package.xml
2758   </a>
2759
2760 </li>
2761
2762     </ul>
2763
2764 </nav>
2765
2766     </li>
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776     <li class="md-nav__item">
2777       <a href="../part_2/" class="md-nav__link">
2778         Part 2
2779       </a>
2780     </li>
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790     <li class="md-nav__item">
2791       <a href="../part_3/" class="md-nav__link">
2792         Part 3
2793       </a>
2794     </li>
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804     <li class="md-nav__item">
2805       <a href="../part_4/" class="md-nav__link">
2806         Part 4
2807       </a>
2808     </li>
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818     <li class="md-nav__item">
2819       <a href="../part_5/" class="md-nav__link">
2820         Part 5
2821       </a>
2822     </li>
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832     <li class="md-nav__item">
2833       <a href="../part_6/" class="md-nav__link">
2834         Part 6
2835       </a>
2836     </li>
2837
2838
2839
2840
2841         </ul>
2842       </nav>
2843     </li>
2844
2845
2846
2847
2848         </ul>
2849       </nav>
2850     </li>
2851
2852
2853
2854   </ul>
2855 </nav>
2856                   </div>
2857                 </div>
2858               </div>
2859
2860
2861
2862               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2863                 <div class="md-sidebar__scrollwrap">
2864                   <div class="md-sidebar__inner">
2865
2866
2867 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2868
2869
2870
2871
2872
2873
2874     <label class="md-nav__title" for="__toc">
2875       <span class="md-nav__icon md-icon"></span>
2876       Table of contents
2877     </label>
2878     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2879
2880         <li class="md-nav__item">
2881   <a href="#package-functionality" class="md-nav__link">
2882     Package Functionality
2883   </a>
2884
2885 </li>
2886
2887         <li class="md-nav__item">
2888   <a href="#used-components" class="md-nav__link">
2889     Used Components
2890   </a>
2891
2892 </li>
2893
2894         <li class="md-nav__item">
2895   <a href="#package-structure" class="md-nav__link">
2896     Package Structure
2897   </a>
2898
2899 </li>
2900
2901         <li class="md-nav__item">
2902   <a href="#person-modeling" class="md-nav__link">
2903     Person Modeling
2904   </a>
2905
2906     <nav class="md-nav" aria-label="Person Modeling">
2907       <ul class="md-nav__list">
2908
2909           <li class="md-nav__item">
2910   <a href="#database-table" class="md-nav__link">
2911     Database Table
2912   </a>
2913
2914 </li>
2915
2916           <li class="md-nav__item">
2917   <a href="#database-object" class="md-nav__link">
2918     Database Object
2919   </a>
2920
2921     <nav class="md-nav" aria-label="Database Object">
2922       <ul class="md-nav__list">
2923
2924           <li class="md-nav__item">
2925   <a href="#person" class="md-nav__link">
2926     Person
2927   </a>
2928
2929 </li>
2930
2931           <li class="md-nav__item">
2932   <a href="#personaction" class="md-nav__link">
2933     PersonAction
2934   </a>
2935
2936 </li>
2937
2938           <li class="md-nav__item">
2939   <a href="#personeditor" class="md-nav__link">
2940     PersonEditor
2941   </a>
2942
2943 </li>
2944
2945           <li class="md-nav__item">
2946   <a href="#personlist" class="md-nav__link">
2947     PersonList
2948   </a>
2949
2950 </li>
2951
2952       </ul>
2953     </nav>
2954
2955 </li>
2956
2957       </ul>
2958     </nav>
2959
2960 </li>
2961
2962         <li class="md-nav__item">
2963   <a href="#acp" class="md-nav__link">
2964     ACP
2965   </a>
2966
2967     <nav class="md-nav" aria-label="ACP">
2968       <ul class="md-nav__list">
2969
2970           <li class="md-nav__item">
2971   <a href="#acp-menu" class="md-nav__link">
2972     ACP Menu
2973   </a>
2974
2975 </li>
2976
2977           <li class="md-nav__item">
2978   <a href="#people-list" class="md-nav__link">
2979     People List
2980   </a>
2981
2982     <nav class="md-nav" aria-label="People List">
2983       <ul class="md-nav__list">
2984
2985           <li class="md-nav__item">
2986   <a href="#personlistpage" class="md-nav__link">
2987     PersonListPage
2988   </a>
2989
2990 </li>
2991
2992           <li class="md-nav__item">
2993   <a href="#personlisttpl" class="md-nav__link">
2994     personList.tpl
2995   </a>
2996
2997 </li>
2998
2999       </ul>
3000     </nav>
3001
3002 </li>
3003
3004           <li class="md-nav__item">
3005   <a href="#person-add-form" class="md-nav__link">
3006     Person Add Form
3007   </a>
3008
3009     <nav class="md-nav" aria-label="Person Add Form">
3010       <ul class="md-nav__list">
3011
3012           <li class="md-nav__item">
3013   <a href="#personaddform" class="md-nav__link">
3014     PersonAddForm
3015   </a>
3016
3017 </li>
3018
3019           <li class="md-nav__item">
3020   <a href="#personaddtpl" class="md-nav__link">
3021     personAdd.tpl
3022   </a>
3023
3024 </li>
3025
3026       </ul>
3027     </nav>
3028
3029 </li>
3030
3031           <li class="md-nav__item">
3032   <a href="#person-edit-form" class="md-nav__link">
3033     Person Edit Form
3034   </a>
3035
3036     <nav class="md-nav" aria-label="Person Edit Form">
3037       <ul class="md-nav__list">
3038
3039           <li class="md-nav__item">
3040   <a href="#personeditform" class="md-nav__link">
3041     PersonEditForm
3042   </a>
3043
3044 </li>
3045
3046       </ul>
3047     </nav>
3048
3049 </li>
3050
3051       </ul>
3052     </nav>
3053
3054 </li>
3055
3056         <li class="md-nav__item">
3057   <a href="#frontend" class="md-nav__link">
3058     Frontend
3059   </a>
3060
3061     <nav class="md-nav" aria-label="Frontend">
3062       <ul class="md-nav__list">
3063
3064           <li class="md-nav__item">
3065   <a href="#pagexml" class="md-nav__link">
3066     page.xml
3067   </a>
3068
3069 </li>
3070
3071           <li class="md-nav__item">
3072   <a href="#menuitemxml" class="md-nav__link">
3073     menuItem.xml
3074   </a>
3075
3076 </li>
3077
3078           <li class="md-nav__item">
3079   <a href="#people-list_1" class="md-nav__link">
3080     People List
3081   </a>
3082
3083     <nav class="md-nav" aria-label="People List">
3084       <ul class="md-nav__list">
3085
3086           <li class="md-nav__item">
3087   <a href="#personlistpage_1" class="md-nav__link">
3088     PersonListPage
3089   </a>
3090
3091 </li>
3092
3093           <li class="md-nav__item">
3094   <a href="#personlisttpl_1" class="md-nav__link">
3095     personList.tpl
3096   </a>
3097
3098 </li>
3099
3100       </ul>
3101     </nav>
3102
3103 </li>
3104
3105       </ul>
3106     </nav>
3107
3108 </li>
3109
3110         <li class="md-nav__item">
3111   <a href="#usergroupoptionxml" class="md-nav__link">
3112     userGroupOption.xml
3113   </a>
3114
3115 </li>
3116
3117         <li class="md-nav__item">
3118   <a href="#packagexml" class="md-nav__link">
3119     package.xml
3120   </a>
3121
3122 </li>
3123
3124     </ul>
3125
3126 </nav>
3127                   </div>
3128                 </div>
3129               </div>
3130
3131
3132
3133             <div class="md-content" data-md-component="content">
3134               <article class="md-content__inner md-typeset">
3135
3136
3137
3138
3139
3140
3141
3142 <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>
3143 <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>
3144 <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
3145 <p>The package should provide the following possibilities/functions:</p>
3146 <ul>
3147 <li>Sortable list of all people in the ACP</li>
3148 <li>Ability to add, edit and delete people in the ACP</li>
3149 <li>Restrict the ability to add, edit and delete people (in short: manage people) in the ACP</li>
3150 <li>Sortable list of all people in the front end</li>
3151 </ul>
3152 <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2>
3153 <p>We will use the following package installation plugins:</p>
3154 <ul>
3155 <li><a href="../../../package/pip/acp-template/">acpTemplate package installation plugin</a>,</li>
3156 <li><a href="../../../package/pip/acp-menu/">acpMenu package installation plugin</a>,</li>
3157 <li><a href="../../../package/pip/database/">database package installation plugin</a>,</li>
3158 <li><a href="../../../package/pip/file/">file package installation plugin</a>,</li>
3159 <li><a href="../../../package/pip/language/">language package installation plugin</a>,</li>
3160 <li><a href="../../../package/pip/menu-item/">menuItem package installation plugin</a>,</li>
3161 <li><a href="../../../package/pip/page/">page package installation plugin</a>,</li>
3162 <li><a href="../../../package/pip/template/">template package installation plugin</a>,</li>
3163 <li><a href="../../../package/pip/user-group-option/">userGroupOption package installation plugin</a>,</li>
3164 </ul>
3165 <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>
3166 <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
3167 <p>The package will have the following file structure:</p>
3168 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3169 <span class="normal"> 2</span>
3170 <span class="normal"> 3</span>
3171 <span class="normal"> 4</span>
3172 <span class="normal"> 5</span>
3173 <span class="normal"> 6</span>
3174 <span class="normal"> 7</span>
3175 <span class="normal"> 8</span>
3176 <span class="normal"> 9</span>
3177 <span class="normal">10</span>
3178 <span class="normal">11</span>
3179 <span class="normal">12</span>
3180 <span class="normal">13</span>
3181 <span class="normal">14</span>
3182 <span class="normal">15</span>
3183 <span class="normal">16</span>
3184 <span class="normal">17</span>
3185 <span class="normal">18</span>
3186 <span class="normal">19</span>
3187 <span class="normal">20</span>
3188 <span class="normal">21</span>
3189 <span class="normal">22</span>
3190 <span class="normal">23</span>
3191 <span class="normal">24</span>
3192 <span class="normal">25</span>
3193 <span class="normal">26</span>
3194 <span class="normal">27</span>
3195 <span class="normal">28</span>
3196 <span class="normal">29</span>
3197 <span class="normal">30</span>
3198 <span class="normal">31</span>
3199 <span class="normal">32</span></pre></div></td><td class="code"><div><pre><span></span><code>├── acpMenu.xml
3200 ├── acptemplates
3201 │   ├── personAdd.tpl
3202 │   └── personList.tpl
3203 ├── files
3204 │   ├── acp
3205 │   │   └── database
3206 │   │       └── install_com.woltlab.wcf.people.php
3207 │   └── lib
3208 │       ├── acp
3209 │       │   ├── form
3210 │       │   │   ├── PersonAddForm.class.php
3211 │       │   │   └── PersonEditForm.class.php
3212 │       │   └── page
3213 │       │       └── PersonListPage.class.php
3214 │       ├── data
3215 │       │   └── person
3216 │       │       ├── Person.class.php
3217 │       │       ├── PersonAction.class.php
3218 │       │       ├── PersonEditor.class.php
3219 │       │       └── PersonList.class.php
3220 │       └── page
3221 │           └── PersonListPage.class.php
3222 ├── language
3223 │   ├── de.xml
3224 │   └── en.xml
3225 ├── menuItem.xml
3226 ├── package.xml
3227 ├── page.xml
3228 ├── templates
3229 │   └── personList.tpl
3230 └── userGroupOption.xml
3231 </code></pre></div></td></tr></table></div>
3232 <h2 id="person-modeling">Person Modeling<a class="headerlink" href="#person-modeling" title="Permanent link">#</a></h2>
3233 <h3 id="database-table">Database Table<a class="headerlink" href="#database-table" title="Permanent link">#</a></h3>
3234 <p>As the first step, we have to model the people we want to manage with this package.
3235 As this is only an introductory tutorial, we will keep things simple and only consider the first and last name of a person.
3236 Thus, the database table we will store the people in only contains three columns:</p>
3237 <ol>
3238 <li><code>personID</code> is the unique numeric identifier of each person created,</li>
3239 <li><code>firstName</code> contains the first name of the person,</li>
3240 <li><code>lastName</code> contains the last name of the person.</li>
3241 </ol>
3242 <p>The first file for our package is the <code>install_com.woltlab.wcf.people.php</code> file used to create such a database table during package installation:</p>
3243 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/acp/database/install_com.woltlab.wcf.people.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/acp/database/install_com.woltlab.wcf.people.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3244 <span class="normal"> 2</span>
3245 <span class="normal"> 3</span>
3246 <span class="normal"> 4</span>
3247 <span class="normal"> 5</span>
3248 <span class="normal"> 6</span>
3249 <span class="normal"> 7</span>
3250 <span class="normal"> 8</span>
3251 <span class="normal"> 9</span>
3252 <span class="normal">10</span>
3253 <span class="normal">11</span>
3254 <span class="normal">12</span>
3255 <span class="normal">13</span>
3256 <span class="normal">14</span>
3257 <span class="normal">15</span>
3258 <span class="normal">16</span>
3259 <span class="normal">17</span>
3260 <span class="normal">18</span>
3261 <span class="normal">19</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3262
3263 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\NotNullVarchar255DatabaseTableColumn</span><span class="p">;</span>
3264 <span class="k">use</span> <span class="nx">wcf\system\database\table\column\ObjectIdDatabaseTableColumn</span><span class="p">;</span>
3265 <span class="k">use</span> <span class="nx">wcf\system\database\table\DatabaseTable</span><span class="p">;</span>
3266 <span class="k">use</span> <span class="nx">wcf\system\database\table\index\DatabaseTablePrimaryIndex</span><span class="p">;</span>
3267
3268 <span class="k">return</span> <span class="p">[</span>
3269     <span class="nx">DatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;wcf1_person&#39;</span><span class="p">)</span>
3270         <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
3271             <span class="nx">ObjectIdDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;personID&#39;</span><span class="p">),</span>
3272             <span class="nx">NotNullVarchar255DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">),</span>
3273             <span class="nx">NotNullVarchar255DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">),</span>
3274         <span class="p">])</span>
3275         <span class="o">-&gt;</span><span class="na">indices</span><span class="p">([</span>
3276             <span class="nx">DatabaseTablePrimaryIndex</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
3277                 <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;personID&#39;</span><span class="p">]),</span>
3278         <span class="p">]),</span>
3279 <span class="p">];</span>
3280 </code></pre></div></td></tr></table></div>
3281 <h3 id="database-object">Database Object<a class="headerlink" href="#database-object" title="Permanent link">#</a></h3>
3282 <h4 id="person"><code>Person</code><a class="headerlink" href="#person" title="Permanent link">#</a></h4>
3283 <p>In our PHP code, each person will be represented by an object of the following class:</p>
3284 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/person/Person.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/Person.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3285 <span class="normal"> 2</span>
3286 <span class="normal"> 3</span>
3287 <span class="normal"> 4</span>
3288 <span class="normal"> 5</span>
3289 <span class="normal"> 6</span>
3290 <span class="normal"> 7</span>
3291 <span class="normal"> 8</span>
3292 <span class="normal"> 9</span>
3293 <span class="normal">10</span>
3294 <span class="normal">11</span>
3295 <span class="normal">12</span>
3296 <span class="normal">13</span>
3297 <span class="normal">14</span>
3298 <span class="normal">15</span>
3299 <span class="normal">16</span>
3300 <span class="normal">17</span>
3301 <span class="normal">18</span>
3302 <span class="normal">19</span>
3303 <span class="normal">20</span>
3304 <span class="normal">21</span>
3305 <span class="normal">22</span>
3306 <span class="normal">23</span>
3307 <span class="normal">24</span>
3308 <span class="normal">25</span>
3309 <span class="normal">26</span>
3310 <span class="normal">27</span>
3311 <span class="normal">28</span>
3312 <span class="normal">29</span>
3313 <span class="normal">30</span>
3314 <span class="normal">31</span>
3315 <span class="normal">32</span>
3316 <span class="normal">33</span>
3317 <span class="normal">34</span>
3318 <span class="normal">35</span>
3319 <span class="normal">36</span>
3320 <span class="normal">37</span>
3321 <span class="normal">38</span>
3322 <span class="normal">39</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3323
3324 <span class="k">namespace</span> <span class="nx">wcf\data\person</span><span class="p">;</span>
3325
3326 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObject</span><span class="p">;</span>
3327 <span class="k">use</span> <span class="nx">wcf\system\request\IRouteController</span><span class="p">;</span>
3328
3329 <span class="sd">/**</span>
3330 <span class="sd"> * Represents a person.</span>
3331 <span class="sd"> *</span>
3332 <span class="sd"> * @author  Matthias Schmidt</span>
3333 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3334 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3335 <span class="sd"> * @package WoltLabSuite\Core\Data\Person</span>
3336 <span class="sd"> *</span>
3337 <span class="sd"> * @property-read   int     $personID   unique id of the person</span>
3338 <span class="sd"> * @property-read   string  $firstName  first name of the person</span>
3339 <span class="sd"> * @property-read   string  $lastName   last name of the person</span>
3340 <span class="sd"> */</span>
3341 <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>
3342 <span class="p">{</span>
3343     <span class="sd">/**</span>
3344 <span class="sd">     * Returns the first and last name of the person if a person object is treated as a string.</span>
3345 <span class="sd">     *</span>
3346 <span class="sd">     * @return  string</span>
3347 <span class="sd">     */</span>
3348     <span class="k">public</span> <span class="k">function</span> <span class="fm">__toString</span><span class="p">()</span>
3349     <span class="p">{</span>
3350         <span class="k">return</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="p">();</span>
3351     <span class="p">}</span>
3352
3353     <span class="sd">/**</span>
3354 <span class="sd">     * @inheritDoc</span>
3355 <span class="sd">     */</span>
3356     <span class="k">public</span> <span class="k">function</span> <span class="nf">getTitle</span><span class="p">()</span>
3357     <span class="p">{</span>
3358         <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>
3359     <span class="p">}</span>
3360 <span class="p">}</span>
3361 </code></pre></div></td></tr></table></div>
3362 <p>The important thing here is that <code>Person</code> extends <code>DatabaseObject</code>.
3363 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>
3364 <p>For every database object, you need to implement three additional classes:
3365 an action class, an editor class and a list class.</p>
3366 <h4 id="personaction"><code>PersonAction</code><a class="headerlink" href="#personaction" title="Permanent link">#</a></h4>
3367 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/person/PersonAction.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/PersonAction.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3368 <span class="normal"> 2</span>
3369 <span class="normal"> 3</span>
3370 <span class="normal"> 4</span>
3371 <span class="normal"> 5</span>
3372 <span class="normal"> 6</span>
3373 <span class="normal"> 7</span>
3374 <span class="normal"> 8</span>
3375 <span class="normal"> 9</span>
3376 <span class="normal">10</span>
3377 <span class="normal">11</span>
3378 <span class="normal">12</span>
3379 <span class="normal">13</span>
3380 <span class="normal">14</span>
3381 <span class="normal">15</span>
3382 <span class="normal">16</span>
3383 <span class="normal">17</span>
3384 <span class="normal">18</span>
3385 <span class="normal">19</span>
3386 <span class="normal">20</span>
3387 <span class="normal">21</span>
3388 <span class="normal">22</span>
3389 <span class="normal">23</span>
3390 <span class="normal">24</span>
3391 <span class="normal">25</span>
3392 <span class="normal">26</span>
3393 <span class="normal">27</span>
3394 <span class="normal">28</span>
3395 <span class="normal">29</span>
3396 <span class="normal">30</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3397
3398 <span class="k">namespace</span> <span class="nx">wcf\data\person</span><span class="p">;</span>
3399
3400 <span class="k">use</span> <span class="nx">wcf\data\AbstractDatabaseObjectAction</span><span class="p">;</span>
3401
3402 <span class="sd">/**</span>
3403 <span class="sd"> * Executes person-related actions.</span>
3404 <span class="sd"> *</span>
3405 <span class="sd"> * @author  Matthias Schmidt</span>
3406 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3407 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3408 <span class="sd"> * @package WoltLabSuite\Core\Data\Person</span>
3409 <span class="sd"> *</span>
3410 <span class="sd"> * @method  Person      create()</span>
3411 <span class="sd"> * @method  PersonEditor[]  getObjects()</span>
3412 <span class="sd"> * @method  PersonEditor    getSingleObject()</span>
3413 <span class="sd"> */</span>
3414 <span class="k">class</span> <span class="nc">PersonAction</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseObjectAction</span>
3415 <span class="p">{</span>
3416     <span class="sd">/**</span>
3417 <span class="sd">     * @inheritDoc</span>
3418 <span class="sd">     */</span>
3419     <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>
3420
3421     <span class="sd">/**</span>
3422 <span class="sd">     * @inheritDoc</span>
3423 <span class="sd">     */</span>
3424     <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>
3425 <span class="p">}</span>
3426 </code></pre></div></td></tr></table></div>
3427 <p>This implementation of <code>AbstractDatabaseObjectAction</code> is very basic and only sets the <code>$permissionsDelete</code> and <code>$requireACP</code> properties.
3428 This is done so that later on, when implementing the people list for the ACP, we can delete people simply via AJAX.
3429 <code>$permissionsDelete</code> has to be set to the permission needed in order to delete a person.
3430 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.
3431 <code>$requireACP</code> restricts deletion of people to the ACP.</p>
3432 <h4 id="personeditor"><code>PersonEditor</code><a class="headerlink" href="#personeditor" title="Permanent link">#</a></h4>
3433 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/person/PersonEditor.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/PersonEditor.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3434 <span class="normal"> 2</span>
3435 <span class="normal"> 3</span>
3436 <span class="normal"> 4</span>
3437 <span class="normal"> 5</span>
3438 <span class="normal"> 6</span>
3439 <span class="normal"> 7</span>
3440 <span class="normal"> 8</span>
3441 <span class="normal"> 9</span>
3442 <span class="normal">10</span>
3443 <span class="normal">11</span>
3444 <span class="normal">12</span>
3445 <span class="normal">13</span>
3446 <span class="normal">14</span>
3447 <span class="normal">15</span>
3448 <span class="normal">16</span>
3449 <span class="normal">17</span>
3450 <span class="normal">18</span>
3451 <span class="normal">19</span>
3452 <span class="normal">20</span>
3453 <span class="normal">21</span>
3454 <span class="normal">22</span>
3455 <span class="normal">23</span>
3456 <span class="normal">24</span>
3457 <span class="normal">25</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3458
3459 <span class="k">namespace</span> <span class="nx">wcf\data\person</span><span class="p">;</span>
3460
3461 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObjectEditor</span><span class="p">;</span>
3462
3463 <span class="sd">/**</span>
3464 <span class="sd"> * Provides functions to edit people.</span>
3465 <span class="sd"> *</span>
3466 <span class="sd"> * @author  Matthias Schmidt</span>
3467 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3468 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3469 <span class="sd"> * @package WoltLabSuite\Core\Data\Person</span>
3470 <span class="sd"> *</span>
3471 <span class="sd"> * @method static   Person  create(array $parameters = [])</span>
3472 <span class="sd"> * @method      Person  getDecoratedObject()</span>
3473 <span class="sd"> * @mixin       Person</span>
3474 <span class="sd"> */</span>
3475 <span class="k">class</span> <span class="nc">PersonEditor</span> <span class="k">extends</span> <span class="nx">DatabaseObjectEditor</span>
3476 <span class="p">{</span>
3477     <span class="sd">/**</span>
3478 <span class="sd">     * @inheritDoc</span>
3479 <span class="sd">     */</span>
3480     <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>
3481 <span class="p">}</span>
3482 </code></pre></div></td></tr></table></div>
3483 <p>This implementation of <code>DatabaseObjectEditor</code> fulfills the minimum requirement for a database object editor:
3484 setting the static <code>$baseClass</code> property to the database object class name.</p>
3485 <h4 id="personlist"><code>PersonList</code><a class="headerlink" href="#personlist" title="Permanent link">#</a></h4>
3486 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/data/person/PersonList.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/data/person/PersonList.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3487 <span class="normal"> 2</span>
3488 <span class="normal"> 3</span>
3489 <span class="normal"> 4</span>
3490 <span class="normal"> 5</span>
3491 <span class="normal"> 6</span>
3492 <span class="normal"> 7</span>
3493 <span class="normal"> 8</span>
3494 <span class="normal"> 9</span>
3495 <span class="normal">10</span>
3496 <span class="normal">11</span>
3497 <span class="normal">12</span>
3498 <span class="normal">13</span>
3499 <span class="normal">14</span>
3500 <span class="normal">15</span>
3501 <span class="normal">16</span>
3502 <span class="normal">17</span>
3503 <span class="normal">18</span>
3504 <span class="normal">19</span>
3505 <span class="normal">20</span>
3506 <span class="normal">21</span>
3507 <span class="normal">22</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3508
3509 <span class="k">namespace</span> <span class="nx">wcf\data\person</span><span class="p">;</span>
3510
3511 <span class="k">use</span> <span class="nx">wcf\data\DatabaseObjectList</span><span class="p">;</span>
3512
3513 <span class="sd">/**</span>
3514 <span class="sd"> * Represents a list of people.</span>
3515 <span class="sd"> *</span>
3516 <span class="sd"> * @author  Matthias Schmidt</span>
3517 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3518 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3519 <span class="sd"> * @package WoltLabSuite\Core\Data\Person</span>
3520 <span class="sd"> *</span>
3521 <span class="sd"> * @method  Person      current()</span>
3522 <span class="sd"> * @method  Person[]    getObjects()</span>
3523 <span class="sd"> * @method  Person|null search($objectID)</span>
3524 <span class="sd"> * @property    Person[]    $objects</span>
3525 <span class="sd"> */</span>
3526 <span class="k">class</span> <span class="nc">PersonList</span> <span class="k">extends</span> <span class="nx">DatabaseObjectList</span>
3527 <span class="p">{</span>
3528 <span class="p">}</span>
3529 </code></pre></div></td></tr></table></div>
3530 <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>
3531 <h2 id="acp">ACP<a class="headerlink" href="#acp" title="Permanent link">#</a></h2>
3532 <p>Next, we will take care of the controllers and views for the ACP.
3533 In total, we need three each:</p>
3534 <ol>
3535 <li>page to list people,</li>
3536 <li>form to add people, and</li>
3537 <li>form to edit people.</li>
3538 </ol>
3539 <p>Before we create the controllers and views, let us first create the menu items for the pages in the ACP menu.</p>
3540 <h3 id="acp-menu">ACP Menu<a class="headerlink" href="#acp-menu" title="Permanent link">#</a></h3>
3541 <p>We need to create three menu items:</p>
3542 <ol>
3543 <li>a “parent” menu item on the second level of the ACP menu item tree,</li>
3544 <li>a third level menu item for the people list page, and</li>
3545 <li>a fourth level menu item for the form to add new people.</li>
3546 </ol>
3547 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">acpMenu.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/acpMenu.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3548 <span class="normal"> 2</span>
3549 <span class="normal"> 3</span>
3550 <span class="normal"> 4</span>
3551 <span class="normal"> 5</span>
3552 <span class="normal"> 6</span>
3553 <span class="normal"> 7</span>
3554 <span class="normal"> 8</span>
3555 <span class="normal"> 9</span>
3556 <span class="normal">10</span>
3557 <span class="normal">11</span>
3558 <span class="normal">12</span>
3559 <span class="normal">13</span>
3560 <span class="normal">14</span>
3561 <span class="normal">15</span>
3562 <span class="normal">16</span>
3563 <span class="normal">17</span>
3564 <span class="normal">18</span>
3565 <span class="normal">19</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
3566 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/acpMenu.xsd&quot;</span><span class="nt">&gt;</span>
3567 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
3568 <span class="w">        </span><span class="nt">&lt;acpmenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.person&quot;</span><span class="nt">&gt;</span>
3569 <span class="w">            </span><span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.content<span class="nt">&lt;/parent&gt;</span>
3570 <span class="w">        </span><span class="nt">&lt;/acpmenuitem&gt;</span>
3571 <span class="w">        </span><span class="nt">&lt;acpmenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.person.list&quot;</span><span class="nt">&gt;</span>
3572 <span class="w">            </span><span class="nt">&lt;controller&gt;</span>wcf\acp\page\PersonListPage<span class="nt">&lt;/controller&gt;</span>
3573 <span class="w">            </span><span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.person<span class="nt">&lt;/parent&gt;</span>
3574 <span class="w">            </span><span class="nt">&lt;permissions&gt;</span>admin.content.canManagePeople<span class="nt">&lt;/permissions&gt;</span>
3575 <span class="w">        </span><span class="nt">&lt;/acpmenuitem&gt;</span>
3576 <span class="w">        </span><span class="nt">&lt;acpmenuitem</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;wcf.acp.menu.link.person.add&quot;</span><span class="nt">&gt;</span>
3577 <span class="w">            </span><span class="nt">&lt;controller&gt;</span>wcf\acp\form\PersonAddForm<span class="nt">&lt;/controller&gt;</span>
3578 <span class="w">            </span><span class="nt">&lt;parent&gt;</span>wcf.acp.menu.link.person.list<span class="nt">&lt;/parent&gt;</span>
3579 <span class="w">            </span><span class="nt">&lt;permissions&gt;</span>admin.content.canManagePeople<span class="nt">&lt;/permissions&gt;</span>
3580 <span class="w">            </span><span class="nt">&lt;icon&gt;</span>fa-plus<span class="nt">&lt;/icon&gt;</span>
3581 <span class="w">        </span><span class="nt">&lt;/acpmenuitem&gt;</span>
3582 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
3583 <span class="nt">&lt;/data&gt;</span>
3584 </code></pre></div></td></tr></table></div>
3585 <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.
3586 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>
3587 <h3 id="people-list">People List<a class="headerlink" href="#people-list" title="Permanent link">#</a></h3>
3588 <p>To list the people in the ACP, we need a <code>PersonListPage</code> class and a <code>personList</code> template.</p>
3589 <h4 id="personlistpage"><code>PersonListPage</code><a class="headerlink" href="#personlistpage" title="Permanent link">#</a></h4>
3590 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/acp/page/PersonListPage.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/acp/page/PersonListPage.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3591 <span class="normal"> 2</span>
3592 <span class="normal"> 3</span>
3593 <span class="normal"> 4</span>
3594 <span class="normal"> 5</span>
3595 <span class="normal"> 6</span>
3596 <span class="normal"> 7</span>
3597 <span class="normal"> 8</span>
3598 <span class="normal"> 9</span>
3599 <span class="normal">10</span>
3600 <span class="normal">11</span>
3601 <span class="normal">12</span>
3602 <span class="normal">13</span>
3603 <span class="normal">14</span>
3604 <span class="normal">15</span>
3605 <span class="normal">16</span>
3606 <span class="normal">17</span>
3607 <span class="normal">18</span>
3608 <span class="normal">19</span>
3609 <span class="normal">20</span>
3610 <span class="normal">21</span>
3611 <span class="normal">22</span>
3612 <span class="normal">23</span>
3613 <span class="normal">24</span>
3614 <span class="normal">25</span>
3615 <span class="normal">26</span>
3616 <span class="normal">27</span>
3617 <span class="normal">28</span>
3618 <span class="normal">29</span>
3619 <span class="normal">30</span>
3620 <span class="normal">31</span>
3621 <span class="normal">32</span>
3622 <span class="normal">33</span>
3623 <span class="normal">34</span>
3624 <span class="normal">35</span>
3625 <span class="normal">36</span>
3626 <span class="normal">37</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3627
3628 <span class="k">namespace</span> <span class="nx">wcf\acp\page</span><span class="p">;</span>
3629
3630 <span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
3631 <span class="k">use</span> <span class="nx">wcf\page\SortablePage</span><span class="p">;</span>
3632
3633 <span class="sd">/**</span>
3634 <span class="sd"> * Shows the list of people.</span>
3635 <span class="sd"> *</span>
3636 <span class="sd"> * @author  Matthias Schmidt</span>
3637 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3638 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3639 <span class="sd"> * @package WoltLabSuite\Core\Acp\Page</span>
3640 <span class="sd"> */</span>
3641 <span class="k">class</span> <span class="nc">PersonListPage</span> <span class="k">extends</span> <span class="nx">SortablePage</span>
3642 <span class="p">{</span>
3643     <span class="sd">/**</span>
3644 <span class="sd">     * @inheritDoc</span>
3645 <span class="sd">     */</span>
3646     <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>
3647
3648     <span class="sd">/**</span>
3649 <span class="sd">     * @inheritDoc</span>
3650 <span class="sd">     */</span>
3651     <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>
3652
3653     <span class="sd">/**</span>
3654 <span class="sd">     * @inheritDoc</span>
3655 <span class="sd">     */</span>
3656     <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>
3657
3658     <span class="sd">/**</span>
3659 <span class="sd">     * @inheritDoc</span>
3660 <span class="sd">     */</span>
3661     <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>
3662 <span class="p">}</span>
3663 </code></pre></div></td></tr></table></div>
3664 <p>As WoltLab Suite Core already provides a powerful default implementation of a sortable page, our work here is minimal:</p>
3665 <ol>
3666 <li>We need to set the active ACP menu item via the <code>$activeMenuItem</code>.</li>
3667 <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.
3668    We use the same permission for both the menu item and the page.</li>
3669 <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>
3670 <li>To validate the sort field passed with the request, we set <code>$validSortFields</code> to the available database table columns.</li>
3671 </ol>
3672 <h4 id="personlisttpl"><code>personList.tpl</code><a class="headerlink" href="#personlisttpl" title="Permanent link">#</a></h4>
3673 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">acptemplates/personList.tpl <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/acptemplates/personList.tpl" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3674 <span class="normal"> 2</span>
3675 <span class="normal"> 3</span>
3676 <span class="normal"> 4</span>
3677 <span class="normal"> 5</span>
3678 <span class="normal"> 6</span>
3679 <span class="normal"> 7</span>
3680 <span class="normal"> 8</span>
3681 <span class="normal"> 9</span>
3682 <span class="normal">10</span>
3683 <span class="normal">11</span>
3684 <span class="normal">12</span>
3685 <span class="normal">13</span>
3686 <span class="normal">14</span>
3687 <span class="normal">15</span>
3688 <span class="normal">16</span>
3689 <span class="normal">17</span>
3690 <span class="normal">18</span>
3691 <span class="normal">19</span>
3692 <span class="normal">20</span>
3693 <span class="normal">21</span>
3694 <span class="normal">22</span>
3695 <span class="normal">23</span>
3696 <span class="normal">24</span>
3697 <span class="normal">25</span>
3698 <span class="normal">26</span>
3699 <span class="normal">27</span>
3700 <span class="normal">28</span>
3701 <span class="normal">29</span>
3702 <span class="normal">30</span>
3703 <span class="normal">31</span>
3704 <span class="normal">32</span>
3705 <span class="normal">33</span>
3706 <span class="normal">34</span>
3707 <span class="normal">35</span>
3708 <span class="normal">36</span>
3709 <span class="normal">37</span>
3710 <span class="normal">38</span>
3711 <span class="normal">39</span>
3712 <span class="normal">40</span>
3713 <span class="normal">41</span>
3714 <span class="normal">42</span>
3715 <span class="normal">43</span>
3716 <span class="normal">44</span>
3717 <span class="normal">45</span>
3718 <span class="normal">46</span>
3719 <span class="normal">47</span>
3720 <span class="normal">48</span>
3721 <span class="normal">49</span>
3722 <span class="normal">50</span>
3723 <span class="normal">51</span>
3724 <span class="normal">52</span>
3725 <span class="normal">53</span>
3726 <span class="normal">54</span>
3727 <span class="normal">55</span>
3728 <span class="normal">56</span>
3729 <span class="normal">57</span>
3730 <span class="normal">58</span>
3731 <span class="normal">59</span>
3732 <span class="normal">60</span>
3733 <span class="normal">61</span>
3734 <span class="normal">62</span>
3735 <span class="normal">63</span>
3736 <span class="normal">64</span>
3737 <span class="normal">65</span>
3738 <span class="normal">66</span>
3739 <span class="normal">67</span>
3740 <span class="normal">68</span>
3741 <span class="normal">69</span>
3742 <span class="normal">70</span>
3743 <span class="normal">71</span>
3744 <span class="normal">72</span>
3745 <span class="normal">73</span>
3746 <span class="normal">74</span>
3747 <span class="normal">75</span></pre></div></td><td class="code"><div><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>
3748
3749 <span class="x">&lt;header class=&quot;contentHeader&quot;&gt;</span>
3750 <span class="x">    &lt;div class=&quot;contentHeaderTitle&quot;&gt;</span>
3751 <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>
3752 <span class="x">    &lt;/div&gt;</span>
3753
3754 <span class="x">    &lt;nav class=&quot;contentHeaderNavigation&quot;&gt;</span>
3755 <span class="x">        &lt;ul&gt;</span>
3756 <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>
3757
3758 <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>
3759 <span class="x">        &lt;/ul&gt;</span>
3760 <span class="x">    &lt;/nav&gt;</span>
3761 <span class="x">&lt;/header&gt;</span>
3762
3763 <span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
3764 <span class="x">    &lt;div class=&quot;paginationTop&quot;&gt;</span>
3765 <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>
3766 <span class="x">    &lt;/div&gt;</span>
3767 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
3768
3769 <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>
3770 <span class="x">    &lt;div class=&quot;section tabularBox&quot;&gt;</span>
3771 <span class="x">        &lt;table class=&quot;table jsObjectActionContainer&quot; data-object-action-class-name=&quot;wcf\data\person\PersonAction&quot;&gt;</span>
3772 <span class="x">            &lt;thead&gt;</span>
3773 <span class="x">                &lt;tr&gt;</span>
3774 <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>
3775 <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>
3776 <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>
3777
3778 <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>
3779 <span class="x">                &lt;/tr&gt;</span>
3780 <span class="x">            &lt;/thead&gt;</span>
3781
3782 <span class="x">            &lt;tbody class=&quot;jsReloadPageWhenEmpty&quot;&gt;</span>
3783 <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>
3784 <span class="x">                    &lt;tr class=&quot;jsObjectActionObject&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">getObjectID</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span>
3785 <span class="x">                        &lt;td class=&quot;columnIcon&quot;&gt;</span>
3786 <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>
3787 <span class="x">                            </span><span class="cp">{</span><span class="nf">objectAction</span> <span class="na">action</span><span class="o">=</span><span class="s2">&quot;delete&quot;</span> <span class="na">objectTitle</span><span class="o">=</span><span class="nv">$person</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span>
3788
3789 <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>
3790 <span class="x">                        &lt;/td&gt;</span>
3791 <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>
3792 <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>
3793 <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>
3794
3795 <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>
3796 <span class="x">                    &lt;/tr&gt;</span>
3797 <span class="x">                </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
3798 <span class="x">            &lt;/tbody&gt;</span>
3799 <span class="x">        &lt;/table&gt;</span>
3800 <span class="x">    &lt;/div&gt;</span>
3801
3802 <span class="x">    &lt;footer class=&quot;contentFooter&quot;&gt;</span>
3803 <span class="x">        </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
3804 <span class="x">            &lt;div class=&quot;paginationBottom&quot;&gt;</span>
3805 <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>
3806 <span class="x">            &lt;/div&gt;</span>
3807 <span class="x">        </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
3808
3809 <span class="x">        &lt;nav class=&quot;contentFooterNavigation&quot;&gt;</span>
3810 <span class="x">            &lt;ul&gt;</span>
3811 <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>
3812
3813 <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>
3814 <span class="x">            &lt;/ul&gt;</span>
3815 <span class="x">        &lt;/nav&gt;</span>
3816 <span class="x">    &lt;/footer&gt;</span>
3817 <span class="cp">{</span><span class="nf">else</span><span class="cp">}</span>
3818 <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>
3819 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
3820
3821 <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>
3822 </code></pre></div></td></tr></table></div>
3823 <p>We will go piece by piece through the template code:</p>
3824 <ol>
3825 <li>We include the <code>header</code> template and set the page title <code>wcf.acp.person.list</code>.
3826    You have to include this template for every page!</li>
3827 <li>We set the content header and additional provide a button to create a new person in the content header navigation.</li>
3828 <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.
3829    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>
3830 <li>Now comes the main part of the page, the list of the people, which will only be displayed if any people exist.
3831    Otherwise, an info box is displayed using the generic <code>wcf.global.noItems</code> language item.
3832    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.
3833    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>.
3834    In general, every table should provide these events.
3835    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.
3836    The table can be sorted by clicking on the head of each column.
3837    The used variables <code>$sortField</code> and <code>$sortOrder</code> are automatically assigned to the template by <code>SortablePage</code>.</li>
3838 <li>The <code>.contentFooter</code> element is only shown if people exist as it basically repeats the <code>.contentHeaderNavigation</code> and <code>.paginationTop</code> element.</li>
3839 <li>The delete button for each person shown in the <code>.columnIcon</code> element relies on the global <a href="../../../migration/wsc53/javascript/#wcfactiondelete-and-wcfactiontoggle"><code>WoltLabSuite/Core/Ui/Object/Action</code></a> module which only requires the <code>jsObjectActionContainer</code> CSS class in combination with the <code>data-object-action-class-name</code> attribute for the <code>table</code> element, the <code>jsObjectActionObject</code> CSS class for each person's <code>tr</code> element in combination with the <code>data-object-id</code> attribute, and lastly the delete button itself, which is created with the <a href="../../../view/template-plugins/#view/template-plugins/#54-objectaction"><code>objectAction</code> template plugin</a>.</li>
3840 <li>The <a href="../../../migration/wsc53/javascript/#wcftableemptytablehandler"><code>.jsReloadPageWhenEmpty</code> CSS class</a> on the <code>tbody</code> element ensures that once all persons on the page have been deleted, the page is reloaded.</li>
3841 <li>Lastly, the <code>footer</code> template is included that terminates the page.
3842    You also have to include this template for every page!</li>
3843 </ol>
3844 <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>
3845 <h3 id="person-add-form">Person Add Form<a class="headerlink" href="#person-add-form" title="Permanent link">#</a></h3>
3846 <p>Like the person list, the form to add new people requires a controller class and a template.</p>
3847 <h4 id="personaddform"><code>PersonAddForm</code><a class="headerlink" href="#personaddform" title="Permanent link">#</a></h4>
3848 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/acp/form/PersonAddForm.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/acp/form/PersonAddForm.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3849 <span class="normal"> 2</span>
3850 <span class="normal"> 3</span>
3851 <span class="normal"> 4</span>
3852 <span class="normal"> 5</span>
3853 <span class="normal"> 6</span>
3854 <span class="normal"> 7</span>
3855 <span class="normal"> 8</span>
3856 <span class="normal"> 9</span>
3857 <span class="normal">10</span>
3858 <span class="normal">11</span>
3859 <span class="normal">12</span>
3860 <span class="normal">13</span>
3861 <span class="normal">14</span>
3862 <span class="normal">15</span>
3863 <span class="normal">16</span>
3864 <span class="normal">17</span>
3865 <span class="normal">18</span>
3866 <span class="normal">19</span>
3867 <span class="normal">20</span>
3868 <span class="normal">21</span>
3869 <span class="normal">22</span>
3870 <span class="normal">23</span>
3871 <span class="normal">24</span>
3872 <span class="normal">25</span>
3873 <span class="normal">26</span>
3874 <span class="normal">27</span>
3875 <span class="normal">28</span>
3876 <span class="normal">29</span>
3877 <span class="normal">30</span>
3878 <span class="normal">31</span>
3879 <span class="normal">32</span>
3880 <span class="normal">33</span>
3881 <span class="normal">34</span>
3882 <span class="normal">35</span>
3883 <span class="normal">36</span>
3884 <span class="normal">37</span>
3885 <span class="normal">38</span>
3886 <span class="normal">39</span>
3887 <span class="normal">40</span>
3888 <span class="normal">41</span>
3889 <span class="normal">42</span>
3890 <span class="normal">43</span>
3891 <span class="normal">44</span>
3892 <span class="normal">45</span>
3893 <span class="normal">46</span>
3894 <span class="normal">47</span>
3895 <span class="normal">48</span>
3896 <span class="normal">49</span>
3897 <span class="normal">50</span>
3898 <span class="normal">51</span>
3899 <span class="normal">52</span>
3900 <span class="normal">53</span>
3901 <span class="normal">54</span>
3902 <span class="normal">55</span>
3903 <span class="normal">56</span>
3904 <span class="normal">57</span>
3905 <span class="normal">58</span>
3906 <span class="normal">59</span>
3907 <span class="normal">60</span>
3908 <span class="normal">61</span>
3909 <span class="normal">62</span>
3910 <span class="normal">63</span>
3911 <span class="normal">64</span>
3912 <span class="normal">65</span>
3913 <span class="normal">66</span>
3914 <span class="normal">67</span>
3915 <span class="normal">68</span>
3916 <span class="normal">69</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3917
3918 <span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
3919
3920 <span class="k">use</span> <span class="nx">wcf\data\person\PersonAction</span><span class="p">;</span>
3921 <span class="k">use</span> <span class="nx">wcf\form\AbstractFormBuilderForm</span><span class="p">;</span>
3922 <span class="k">use</span> <span class="nx">wcf\system\form\builder\container\FormContainer</span><span class="p">;</span>
3923 <span class="k">use</span> <span class="nx">wcf\system\form\builder\field\TextFormField</span><span class="p">;</span>
3924
3925 <span class="sd">/**</span>
3926 <span class="sd"> * Shows the form to create a new person.</span>
3927 <span class="sd"> *</span>
3928 <span class="sd"> * @author  Matthias Schmidt</span>
3929 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
3930 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
3931 <span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
3932 <span class="sd"> */</span>
3933 <span class="k">class</span> <span class="nc">PersonAddForm</span> <span class="k">extends</span> <span class="nx">AbstractFormBuilderForm</span>
3934 <span class="p">{</span>
3935     <span class="sd">/**</span>
3936 <span class="sd">     * @inheritDoc</span>
3937 <span class="sd">     */</span>
3938     <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>
3939
3940     <span class="sd">/**</span>
3941 <span class="sd">     * @inheritDoc</span>
3942 <span class="sd">     */</span>
3943     <span class="k">public</span> <span class="nv">$formAction</span> <span class="o">=</span> <span class="s1">&#39;create&#39;</span><span class="p">;</span>
3944
3945     <span class="sd">/**</span>
3946 <span class="sd">     * @inheritDoc</span>
3947 <span class="sd">     */</span>
3948     <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>
3949
3950     <span class="sd">/**</span>
3951 <span class="sd">     * @inheritDoc</span>
3952 <span class="sd">     */</span>
3953     <span class="k">public</span> <span class="nv">$objectActionClass</span> <span class="o">=</span> <span class="nx">PersonAction</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
3954
3955     <span class="sd">/**</span>
3956 <span class="sd">     * @inheritDoc</span>
3957 <span class="sd">     */</span>
3958     <span class="k">public</span> <span class="nv">$objectEditLinkController</span> <span class="o">=</span> <span class="nx">PersonEditForm</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
3959
3960     <span class="sd">/**</span>
3961 <span class="sd">     * @inheritDoc</span>
3962 <span class="sd">     */</span>
3963     <span class="k">protected</span> <span class="k">function</span> <span class="nf">createForm</span><span class="p">()</span>
3964     <span class="p">{</span>
3965         <span class="k">parent</span><span class="o">::</span><span class="na">createForm</span><span class="p">();</span>
3966
3967         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">form</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span>
3968             <span class="nx">FormContainer</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;data&#39;</span><span class="p">)</span>
3969                 <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;wcf.global.form.data&#39;</span><span class="p">)</span>
3970                 <span class="o">-&gt;</span><span class="na">appendChildren</span><span class="p">([</span>
3971                     <span class="nx">TextFormField</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">)</span>
3972                         <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;wcf.person.firstName&#39;</span><span class="p">)</span>
3973                         <span class="o">-&gt;</span><span class="na">required</span><span class="p">()</span>
3974                         <span class="o">-&gt;</span><span class="na">autoFocus</span><span class="p">()</span>
3975                         <span class="o">-&gt;</span><span class="na">maximumLength</span><span class="p">(</span><span class="mi">255</span><span class="p">),</span>
3976
3977                     <span class="nx">TextFormField</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">)</span>
3978                         <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;wcf.person.lastName&#39;</span><span class="p">)</span>
3979                         <span class="o">-&gt;</span><span class="na">required</span><span class="p">()</span>
3980                         <span class="o">-&gt;</span><span class="na">maximumLength</span><span class="p">(</span><span class="mi">255</span><span class="p">),</span>
3981                 <span class="p">])</span>
3982         <span class="p">);</span>
3983     <span class="p">}</span>
3984 <span class="p">}</span>
3985 </code></pre></div></td></tr></table></div>
3986 <p>The properties here consist of three types:
3987 the “housekeeping” properties <code>$activeMenuItem</code> and <code>$neededPermissions</code>, which fulfill the same roles as for <code>PersonListPage</code>, and the <a href="../../../migration/wsc52/php/#addform"><code>$objectEditLinkController</code> property</a>, which is used to generate a link to edit the newly created person after submitting the form, and finally <code>$formAction</code> and <code>$objectActionClass</code> required by the <a href="../../../php/api/form_builder/overview/">PHP form builder API</a> used to generate the form.</p>
3988 <p>Because of using form builder, we only have to set up the two form fields for entering the first and last name, respectively:</p>
3989 <ol>
3990 <li>Each field is a simple single-line text field, thus we use <a href="../../../php/api/form_builder/form_fields/#textformfield"><code>TextFormField</code></a>.</li>
3991 <li>The parameter of the <code>create()</code> method expects the id of the field/name of the database object property, which is <code>firstName</code> and <code>lastName</code>, respectively, here.</li>
3992 <li>The language item of the label shown in the ouput above the input field is set via the <code>label()</code> method.</li>
3993 <li>As both fields have to be filled out, <code>required()</code> is called, and the maximum length is set via <code>maximumLength()</code>.</li>
3994 <li>Lastly, to make it easier to fill out the form more quickly, the first field is auto-focused by calling <code>autoFocus()</code>.</li>
3995 </ol>
3996 <h4 id="personaddtpl"><code>personAdd.tpl</code><a class="headerlink" href="#personaddtpl" title="Permanent link">#</a></h4>
3997 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">acptemplates/personAdd.tpl <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/acptemplates/personAdd.tpl" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3998 <span class="normal"> 2</span>
3999 <span class="normal"> 3</span>
4000 <span class="normal"> 4</span>
4001 <span class="normal"> 5</span>
4002 <span class="normal"> 6</span>
4003 <span class="normal"> 7</span>
4004 <span class="normal"> 8</span>
4005 <span class="normal"> 9</span>
4006 <span class="normal">10</span>
4007 <span class="normal">11</span>
4008 <span class="normal">12</span>
4009 <span class="normal">13</span>
4010 <span class="normal">14</span>
4011 <span class="normal">15</span>
4012 <span class="normal">16</span>
4013 <span class="normal">17</span>
4014 <span class="normal">18</span>
4015 <span class="normal">19</span></pre></div></td><td class="code"><div><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>
4016
4017 <span class="x">&lt;header class=&quot;contentHeader&quot;&gt;</span>
4018 <span class="x">    &lt;div class=&quot;contentHeaderTitle&quot;&gt;</span>
4019 <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>
4020 <span class="x">    &lt;/div&gt;</span>
4021
4022 <span class="x">    &lt;nav class=&quot;contentHeaderNavigation&quot;&gt;</span>
4023 <span class="x">        &lt;ul&gt;</span>
4024 <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>
4025
4026 <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>
4027 <span class="x">        &lt;/ul&gt;</span>
4028 <span class="x">    &lt;/nav&gt;</span>
4029 <span class="x">&lt;/header&gt;</span>
4030
4031 <span class="cp">{</span><span class="o">@</span><span class="nv">$form</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="o">()</span><span class="cp">}</span>
4032
4033 <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>
4034 </code></pre></div></td></tr></table></div>
4035 <p>We will now only concentrate on the new parts compared to <code>personList.tpl</code>:</p>
4036 <ol>
4037 <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>
4038 <li>Because of form builder, we only have to call <code>{@$form-&gt;getHtml()}</code> to generate all relevant output for the form.</li>
4039 </ol>
4040 <h3 id="person-edit-form">Person Edit Form<a class="headerlink" href="#person-edit-form" title="Permanent link">#</a></h3>
4041 <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>
4042 <h4 id="personeditform"><code>PersonEditForm</code><a class="headerlink" href="#personeditform" title="Permanent link">#</a></h4>
4043 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/acp/form/PersonEditForm.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/acp/form/PersonEditForm.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4044 <span class="normal"> 2</span>
4045 <span class="normal"> 3</span>
4046 <span class="normal"> 4</span>
4047 <span class="normal"> 5</span>
4048 <span class="normal"> 6</span>
4049 <span class="normal"> 7</span>
4050 <span class="normal"> 8</span>
4051 <span class="normal"> 9</span>
4052 <span class="normal">10</span>
4053 <span class="normal">11</span>
4054 <span class="normal">12</span>
4055 <span class="normal">13</span>
4056 <span class="normal">14</span>
4057 <span class="normal">15</span>
4058 <span class="normal">16</span>
4059 <span class="normal">17</span>
4060 <span class="normal">18</span>
4061 <span class="normal">19</span>
4062 <span class="normal">20</span>
4063 <span class="normal">21</span>
4064 <span class="normal">22</span>
4065 <span class="normal">23</span>
4066 <span class="normal">24</span>
4067 <span class="normal">25</span>
4068 <span class="normal">26</span>
4069 <span class="normal">27</span>
4070 <span class="normal">28</span>
4071 <span class="normal">29</span>
4072 <span class="normal">30</span>
4073 <span class="normal">31</span>
4074 <span class="normal">32</span>
4075 <span class="normal">33</span>
4076 <span class="normal">34</span>
4077 <span class="normal">35</span>
4078 <span class="normal">36</span>
4079 <span class="normal">37</span>
4080 <span class="normal">38</span>
4081 <span class="normal">39</span>
4082 <span class="normal">40</span>
4083 <span class="normal">41</span>
4084 <span class="normal">42</span>
4085 <span class="normal">43</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
4086
4087 <span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
4088
4089 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
4090 <span class="k">use</span> <span class="nx">wcf\system\exception\IllegalLinkException</span><span class="p">;</span>
4091
4092 <span class="sd">/**</span>
4093 <span class="sd"> * Shows the form to edit an existing person.</span>
4094 <span class="sd"> *</span>
4095 <span class="sd"> * @author  Matthias Schmidt</span>
4096 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
4097 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
4098 <span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
4099 <span class="sd"> */</span>
4100 <span class="k">class</span> <span class="nc">PersonEditForm</span> <span class="k">extends</span> <span class="nx">PersonAddForm</span>
4101 <span class="p">{</span>
4102     <span class="sd">/**</span>
4103 <span class="sd">     * @inheritDoc</span>
4104 <span class="sd">     */</span>
4105     <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>
4106
4107     <span class="sd">/**</span>
4108 <span class="sd">     * @inheritDoc</span>
4109 <span class="sd">     */</span>
4110     <span class="k">public</span> <span class="nv">$formAction</span> <span class="o">=</span> <span class="s1">&#39;update&#39;</span><span class="p">;</span>
4111
4112     <span class="sd">/**</span>
4113 <span class="sd">     * @inheritDoc</span>
4114 <span class="sd">     */</span>
4115     <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span>
4116     <span class="p">{</span>
4117         <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
4118
4119         <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="p">{</span>
4120             <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">formObject</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Person</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>
4121
4122             <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">formObject</span><span class="o">-&gt;</span><span class="na">getObjectID</span><span class="p">())</span> <span class="p">{</span>
4123                 <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
4124             <span class="p">}</span>
4125         <span class="p">}</span>
4126     <span class="p">}</span>
4127 <span class="p">}</span>
4128 </code></pre></div></td></tr></table></div>
4129 <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>
4130 <p>After setting a different active menu item, we have to change the value of <code>$formAction</code> because this form, in contrast to <code>PersonAddForm</code>, does not create but update existing persons.</p>
4131 <p>As we rely on form builder, the only thing necessary in this controller is to read and validate the edit object, i.e. the edited person, which is done in <code>readParameters()</code>.</p>
4132 <h2 id="frontend">Frontend<a class="headerlink" href="#frontend" title="Permanent link">#</a></h2>
4133 <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.
4134 This page should also be directly linked in the main menu.</p>
4135 <h3 id="pagexml"><code>page.xml</code><a class="headerlink" href="#pagexml" title="Permanent link">#</a></h3>
4136 <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>
4137 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">page.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/page.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4138 <span class="normal"> 2</span>
4139 <span class="normal"> 3</span>
4140 <span class="normal"> 4</span>
4141 <span class="normal"> 5</span>
4142 <span class="normal"> 6</span>
4143 <span class="normal"> 7</span>
4144 <span class="normal"> 8</span>
4145 <span class="normal"> 9</span>
4146 <span class="normal">10</span>
4147 <span class="normal">11</span>
4148 <span class="normal">12</span>
4149 <span class="normal">13</span>
4150 <span class="normal">14</span>
4151 <span class="normal">15</span>
4152 <span class="normal">16</span>
4153 <span class="normal">17</span>
4154 <span class="normal">18</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
4155 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/page.xsd&quot;</span><span class="nt">&gt;</span>
4156 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
4157 <span class="w">        </span><span class="nt">&lt;page</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.people.PersonList&quot;</span><span class="nt">&gt;</span>
4158 <span class="w">            </span><span class="nt">&lt;pageType&gt;</span>system<span class="nt">&lt;/pageType&gt;</span>
4159 <span class="w">            </span><span class="nt">&lt;controller&gt;</span>wcf\page\PersonListPage<span class="nt">&lt;/controller&gt;</span>
4160 <span class="w">            </span><span class="nt">&lt;name</span><span class="w"> </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>
4161 <span class="w">            </span><span class="nt">&lt;name</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>Person<span class="w"> </span>List<span class="nt">&lt;/name&gt;</span>
4162
4163 <span class="w">            </span><span class="nt">&lt;content</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;de&quot;</span><span class="nt">&gt;</span>
4164 <span class="w">                </span><span class="nt">&lt;title&gt;</span>Personen<span class="nt">&lt;/title&gt;</span>
4165 <span class="w">            </span><span class="nt">&lt;/content&gt;</span>
4166 <span class="w">            </span><span class="nt">&lt;content</span><span class="w"> </span><span class="na">language=</span><span class="s">&quot;en&quot;</span><span class="nt">&gt;</span>
4167 <span class="w">                </span><span class="nt">&lt;title&gt;</span>People<span class="nt">&lt;/title&gt;</span>
4168 <span class="w">            </span><span class="nt">&lt;/content&gt;</span>
4169 <span class="w">        </span><span class="nt">&lt;/page&gt;</span>
4170 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
4171 <span class="nt">&lt;/data&gt;</span>
4172 </code></pre></div></td></tr></table></div>
4173 <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>
4174 <h3 id="menuitemxml"><code>menuItem.xml</code><a class="headerlink" href="#menuitemxml" title="Permanent link">#</a></h3>
4175 <p>Next, we register the menu item using the <a href="../../../package/pip/menu-item/">menuItem package installation plugin</a>:</p>
4176 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">menuItem.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/menuItem.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4177 <span class="normal"> 2</span>
4178 <span class="normal"> 3</span>
4179 <span class="normal"> 4</span>
4180 <span class="normal"> 5</span>
4181 <span class="normal"> 6</span>
4182 <span class="normal"> 7</span>
4183 <span class="normal"> 8</span>
4184 <span class="normal"> 9</span>
4185 <span class="normal">10</span>
4186 <span class="normal">11</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
4187 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/menuItem.xsd&quot;</span><span class="nt">&gt;</span>
4188 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
4189 <span class="w">        </span><span class="nt">&lt;item</span><span class="w"> </span><span class="na">identifier=</span><span class="s">&quot;com.woltlab.wcf.people.PersonList&quot;</span><span class="nt">&gt;</span>
4190 <span class="w">            </span><span class="nt">&lt;menu&gt;</span>com.woltlab.wcf.MainMenu<span class="nt">&lt;/menu&gt;</span>
4191 <span class="w">            </span><span class="nt">&lt;title</span><span class="w"> </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>
4192 <span class="w">            </span><span class="nt">&lt;title</span><span class="w"> </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>
4193 <span class="w">            </span><span class="nt">&lt;page&gt;</span>com.woltlab.wcf.people.PersonList<span class="nt">&lt;/page&gt;</span>
4194 <span class="w">        </span><span class="nt">&lt;/item&gt;</span>
4195 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
4196 <span class="nt">&lt;/data&gt;</span>
4197 </code></pre></div></td></tr></table></div>
4198 <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>
4199 <h3 id="people-list_1">People List<a class="headerlink" href="#people-list_1" title="Permanent link">#</a></h3>
4200 <p>As in the ACP, we need a controller and a template.
4201 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.
4202 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>
4203 <h4 id="personlistpage_1"><code>PersonListPage</code><a class="headerlink" href="#personlistpage_1" title="Permanent link">#</a></h4>
4204 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/page/PersonListPage.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/files/lib/page/PersonListPage.class.php" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4205 <span class="normal"> 2</span>
4206 <span class="normal"> 3</span>
4207 <span class="normal"> 4</span>
4208 <span class="normal"> 5</span>
4209 <span class="normal"> 6</span>
4210 <span class="normal"> 7</span>
4211 <span class="normal"> 8</span>
4212 <span class="normal"> 9</span>
4213 <span class="normal">10</span>
4214 <span class="normal">11</span>
4215 <span class="normal">12</span>
4216 <span class="normal">13</span>
4217 <span class="normal">14</span>
4218 <span class="normal">15</span>
4219 <span class="normal">16</span>
4220 <span class="normal">17</span>
4221 <span class="normal">18</span>
4222 <span class="normal">19</span>
4223 <span class="normal">20</span>
4224 <span class="normal">21</span>
4225 <span class="normal">22</span>
4226 <span class="normal">23</span>
4227 <span class="normal">24</span>
4228 <span class="normal">25</span>
4229 <span class="normal">26</span>
4230 <span class="normal">27</span>
4231 <span class="normal">28</span>
4232 <span class="normal">29</span>
4233 <span class="normal">30</span>
4234 <span class="normal">31</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
4235
4236 <span class="k">namespace</span> <span class="nx">wcf\page</span><span class="p">;</span>
4237
4238 <span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
4239
4240 <span class="sd">/**</span>
4241 <span class="sd"> * Shows the list of people.</span>
4242 <span class="sd"> *</span>
4243 <span class="sd"> * @author  Matthias Schmidt</span>
4244 <span class="sd"> * @copyright   2001-2021 WoltLab GmbH</span>
4245 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
4246 <span class="sd"> * @package WoltLabSuite\Core\Page</span>
4247 <span class="sd"> */</span>
4248 <span class="k">class</span> <span class="nc">PersonListPage</span> <span class="k">extends</span> <span class="nx">SortablePage</span>
4249 <span class="p">{</span>
4250     <span class="sd">/**</span>
4251 <span class="sd">     * @inheritDoc</span>
4252 <span class="sd">     */</span>
4253     <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>
4254
4255     <span class="sd">/**</span>
4256 <span class="sd">     * @inheritDoc</span>
4257 <span class="sd">     */</span>
4258     <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>
4259
4260     <span class="sd">/**</span>
4261 <span class="sd">     * @inheritDoc</span>
4262 <span class="sd">     */</span>
4263     <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>
4264 <span class="p">}</span>
4265 </code></pre></div></td></tr></table></div>
4266 <p>This class is almost identical to the ACP version.
4267 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.
4268 Furthermore, <code>$neededPermissions</code> has not been set because in the front end, users do not need any special permission to access the page.
4269 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>
4270 <h4 id="personlisttpl_1"><code>personList.tpl</code><a class="headerlink" href="#personlisttpl_1" title="Permanent link">#</a></h4>
4271 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">templates/personList.tpl <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/templates/personList.tpl" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">  1</span>
4272 <span class="normal">  2</span>
4273 <span class="normal">  3</span>
4274 <span class="normal">  4</span>
4275 <span class="normal">  5</span>
4276 <span class="normal">  6</span>
4277 <span class="normal">  7</span>
4278 <span class="normal">  8</span>
4279 <span class="normal">  9</span>
4280 <span class="normal"> 10</span>
4281 <span class="normal"> 11</span>
4282 <span class="normal"> 12</span>
4283 <span class="normal"> 13</span>
4284 <span class="normal"> 14</span>
4285 <span class="normal"> 15</span>
4286 <span class="normal"> 16</span>
4287 <span class="normal"> 17</span>
4288 <span class="normal"> 18</span>
4289 <span class="normal"> 19</span>
4290 <span class="normal"> 20</span>
4291 <span class="normal"> 21</span>
4292 <span class="normal"> 22</span>
4293 <span class="normal"> 23</span>
4294 <span class="normal"> 24</span>
4295 <span class="normal"> 25</span>
4296 <span class="normal"> 26</span>
4297 <span class="normal"> 27</span>
4298 <span class="normal"> 28</span>
4299 <span class="normal"> 29</span>
4300 <span class="normal"> 30</span>
4301 <span class="normal"> 31</span>
4302 <span class="normal"> 32</span>
4303 <span class="normal"> 33</span>
4304 <span class="normal"> 34</span>
4305 <span class="normal"> 35</span>
4306 <span class="normal"> 36</span>
4307 <span class="normal"> 37</span>
4308 <span class="normal"> 38</span>
4309 <span class="normal"> 39</span>
4310 <span class="normal"> 40</span>
4311 <span class="normal"> 41</span>
4312 <span class="normal"> 42</span>
4313 <span class="normal"> 43</span>
4314 <span class="normal"> 44</span>
4315 <span class="normal"> 45</span>
4316 <span class="normal"> 46</span>
4317 <span class="normal"> 47</span>
4318 <span class="normal"> 48</span>
4319 <span class="normal"> 49</span>
4320 <span class="normal"> 50</span>
4321 <span class="normal"> 51</span>
4322 <span class="normal"> 52</span>
4323 <span class="normal"> 53</span>
4324 <span class="normal"> 54</span>
4325 <span class="normal"> 55</span>
4326 <span class="normal"> 56</span>
4327 <span class="normal"> 57</span>
4328 <span class="normal"> 58</span>
4329 <span class="normal"> 59</span>
4330 <span class="normal"> 60</span>
4331 <span class="normal"> 61</span>
4332 <span class="normal"> 62</span>
4333 <span class="normal"> 63</span>
4334 <span class="normal"> 64</span>
4335 <span class="normal"> 65</span>
4336 <span class="normal"> 66</span>
4337 <span class="normal"> 67</span>
4338 <span class="normal"> 68</span>
4339 <span class="normal"> 69</span>
4340 <span class="normal"> 70</span>
4341 <span class="normal"> 71</span>
4342 <span class="normal"> 72</span>
4343 <span class="normal"> 73</span>
4344 <span class="normal"> 74</span>
4345 <span class="normal"> 75</span>
4346 <span class="normal"> 76</span>
4347 <span class="normal"> 77</span>
4348 <span class="normal"> 78</span>
4349 <span class="normal"> 79</span>
4350 <span class="normal"> 80</span>
4351 <span class="normal"> 81</span>
4352 <span class="normal"> 82</span>
4353 <span class="normal"> 83</span>
4354 <span class="normal"> 84</span>
4355 <span class="normal"> 85</span>
4356 <span class="normal"> 86</span>
4357 <span class="normal"> 87</span>
4358 <span class="normal"> 88</span>
4359 <span class="normal"> 89</span>
4360 <span class="normal"> 90</span>
4361 <span class="normal"> 91</span>
4362 <span class="normal"> 92</span>
4363 <span class="normal"> 93</span>
4364 <span class="normal"> 94</span>
4365 <span class="normal"> 95</span>
4366 <span class="normal"> 96</span>
4367 <span class="normal"> 97</span>
4368 <span class="normal"> 98</span>
4369 <span class="normal"> 99</span>
4370 <span class="normal">100</span>
4371 <span class="normal">101</span>
4372 <span class="normal">102</span></pre></div></td><td class="code"><div><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>
4373
4374 <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>
4375 <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>
4376 <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>
4377 <span class="x">    </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4378 <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>
4379 <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>
4380 <span class="x">    </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4381 <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>
4382 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span>
4383
4384 <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>
4385 <span class="x">    &lt;section class=&quot;box&quot;&gt;</span>
4386 <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>
4387 <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>
4388
4389 <span class="x">            &lt;div class=&quot;boxContent&quot;&gt;</span>
4390 <span class="x">                &lt;dl&gt;</span>
4391 <span class="x">                    &lt;dt&gt;&lt;/dt&gt;</span>
4392 <span class="x">                    &lt;dd&gt;</span>
4393 <span class="x">                        &lt;select id=&quot;sortField&quot; name=&quot;sortField&quot;&gt;</span>
4394 <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>
4395 <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>
4396 <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>
4397 <span class="x">                        &lt;/select&gt;</span>
4398 <span class="x">                        &lt;select name=&quot;sortOrder&quot;&gt;</span>
4399 <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>
4400 <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>
4401 <span class="x">                        &lt;/select&gt;</span>
4402 <span class="x">                    &lt;/dd&gt;</span>
4403 <span class="x">                &lt;/dl&gt;</span>
4404
4405 <span class="x">                &lt;div class=&quot;formSubmit&quot;&gt;</span>
4406 <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>
4407 <span class="x">                &lt;/div&gt;</span>
4408 <span class="x">            &lt;/div&gt;</span>
4409 <span class="x">        &lt;/form&gt;</span>
4410 <span class="x">    &lt;/section&gt;</span>
4411 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span>
4412
4413 <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>
4414
4415 <span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
4416 <span class="x">    &lt;div class=&quot;paginationTop&quot;&gt;</span>
4417 <span class="x">        </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span>
4418 <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>
4419 <span class="x">        </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span>
4420 <span class="x">    &lt;/div&gt;</span>
4421 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
4422
4423 <span class="cp">{</span><span class="nf">if</span> <span class="nv">$items</span><span class="cp">}</span>
4424 <span class="x">    &lt;div class=&quot;section sectionContainerList&quot;&gt;</span>
4425 <span class="x">        &lt;ol class=&quot;containerList personList&quot;&gt;</span>
4426 <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>
4427 <span class="x">                &lt;li&gt;</span>
4428 <span class="x">                    &lt;div class=&quot;box48&quot;&gt;</span>
4429 <span class="x">                        &lt;span class=&quot;icon icon48 fa-user&quot;&gt;&lt;/span&gt;</span>
4430
4431 <span class="x">                        &lt;div class=&quot;details personInformation&quot;&gt;</span>
4432 <span class="x">                            &lt;div class=&quot;containerHeadline&quot;&gt;</span>
4433 <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>
4434 <span class="x">                            &lt;/div&gt;</span>
4435
4436 <span class="x">                            </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
4437 <span class="x">                                &lt;ul class=&quot;inlineList commaSeparated&quot;&gt;</span>
4438 <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>
4439 <span class="x">                                &lt;/ul&gt;</span>
4440 <span class="x">                            </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
4441
4442 <span class="x">                            </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
4443 <span class="x">                                &lt;dl class=&quot;plain inlineDataList small&quot;&gt;</span>
4444 <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>
4445 <span class="x">                                &lt;/dl&gt;</span>
4446 <span class="x">                            </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
4447 <span class="x">                        &lt;/div&gt;</span>
4448 <span class="x">                    &lt;/div&gt;</span>
4449 <span class="x">                &lt;/li&gt;</span>
4450 <span class="x">            </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
4451 <span class="x">        &lt;/ol&gt;</span>
4452 <span class="x">    &lt;/div&gt;</span>
4453 <span class="cp">{</span><span class="nf">else</span><span class="cp">}</span>
4454 <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>
4455 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
4456
4457 <span class="x">&lt;footer class=&quot;contentFooter&quot;&gt;</span>
4458 <span class="x">    </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
4459 <span class="x">        &lt;div class=&quot;paginationBottom&quot;&gt;</span>
4460 <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>
4461 <span class="x">        &lt;/div&gt;</span>
4462 <span class="x">    </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
4463
4464 <span class="x">    </span><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span>
4465 <span class="x">        &lt;nav class=&quot;contentFooterNavigation&quot;&gt;</span>
4466 <span class="x">            &lt;ul&gt;</span>
4467 <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>
4468 <span class="x">            &lt;/ul&gt;</span>
4469 <span class="x">        &lt;/nav&gt;</span>
4470 <span class="x">    </span><span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span>
4471 <span class="x">&lt;/footer&gt;</span>
4472
4473 <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>
4474 </code></pre></div></td></tr></table></div>
4475 <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.
4476 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>
4477 <p>Now, let us take a closer look at the differences:</p>
4478 <ul>
4479 <li>We do not explicitly create a <code>.contentHeader</code> element but simply assign the title to the <code>contentTitle</code> variable.
4480   The value of the assignment is simply the title of the page and a badge showing the number of listed people.
4481   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>
4482 <li>Next, we create additional element for the HTML document’s <code>&lt;head&gt;</code> element.
4483   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>
4484 <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.
4485   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>
4486 <li>The main part of the page is the listing of the people.
4487   We use a structure similar to the one used for displaying registered users.
4488   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>.
4489   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>
4490 </ul>
4491 <h2 id="usergroupoptionxml"><code>userGroupOption.xml</code><a class="headerlink" href="#usergroupoptionxml" title="Permanent link">#</a></h2>
4492 <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>
4493 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">userGroupOption.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/userGroupOption.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4494 <span class="normal"> 2</span>
4495 <span class="normal"> 3</span>
4496 <span class="normal"> 4</span>
4497 <span class="normal"> 5</span>
4498 <span class="normal"> 6</span>
4499 <span class="normal"> 7</span>
4500 <span class="normal"> 8</span>
4501 <span class="normal"> 9</span>
4502 <span class="normal">10</span>
4503 <span class="normal">11</span>
4504 <span class="normal">12</span>
4505 <span class="normal">13</span>
4506 <span class="normal">14</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
4507 <span class="nt">&lt;data</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/userGroupOption.xsd&quot;</span><span class="nt">&gt;</span>
4508 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
4509 <span class="w">        </span><span class="nt">&lt;options&gt;</span>
4510 <span class="w">            </span><span class="nt">&lt;option</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;admin.content.canManagePeople&quot;</span><span class="nt">&gt;</span>
4511 <span class="w">                </span><span class="nt">&lt;categoryname&gt;</span>admin.content<span class="nt">&lt;/categoryname&gt;</span>
4512 <span class="w">                </span><span class="nt">&lt;optiontype&gt;</span>boolean<span class="nt">&lt;/optiontype&gt;</span>
4513 <span class="w">                </span><span class="nt">&lt;defaultvalue&gt;</span>0<span class="nt">&lt;/defaultvalue&gt;</span>
4514 <span class="w">                </span><span class="nt">&lt;admindefaultvalue&gt;</span>1<span class="nt">&lt;/admindefaultvalue&gt;</span>
4515 <span class="w">                </span><span class="nt">&lt;usersonly&gt;</span>1<span class="nt">&lt;/usersonly&gt;</span>
4516 <span class="w">            </span><span class="nt">&lt;/option&gt;</span>
4517 <span class="w">        </span><span class="nt">&lt;/options&gt;</span>
4518 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
4519 <span class="nt">&lt;/data&gt;</span>
4520 </code></pre></div></td></tr></table></div>
4521 <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).
4522 As the permission is for administrators only, we set <code>defaultvalue</code> to <code>0</code> and <code>admindefaultvalue</code> to <code>1</code>.
4523 This permission is only relevant for registered users so that it should not be visible when editing the guest user group.
4524 This is achieved by setting <code>usersonly</code> to <code>1</code>.</p>
4525 <h2 id="packagexml"><code>package.xml</code><a class="headerlink" href="#packagexml" title="Permanent link">#</a></h2>
4526 <p>Lastly, we need to create the <code>package.xml</code> file.
4527 For more information about this kind of file, please refer to <a href="../../../package/package-xml/">the <code>package.xml</code> page</a>.</p>
4528 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">package.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1/package.xml" title="View on GitHub"><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8v2m9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1 0 1.71-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5Z"/></svg></span></a></span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4529 <span class="normal"> 2</span>
4530 <span class="normal"> 3</span>
4531 <span class="normal"> 4</span>
4532 <span class="normal"> 5</span>
4533 <span class="normal"> 6</span>
4534 <span class="normal"> 7</span>
4535 <span class="normal"> 8</span>
4536 <span class="normal"> 9</span>
4537 <span class="normal">10</span>
4538 <span class="normal">11</span>
4539 <span class="normal">12</span>
4540 <span class="normal">13</span>
4541 <span class="normal">14</span>
4542 <span class="normal">15</span>
4543 <span class="normal">16</span>
4544 <span class="normal">17</span>
4545 <span class="normal">18</span>
4546 <span class="normal">19</span>
4547 <span class="normal">20</span>
4548 <span class="normal">21</span>
4549 <span class="normal">22</span>
4550 <span class="normal">23</span>
4551 <span class="normal">24</span>
4552 <span class="normal">25</span>
4553 <span class="normal">26</span>
4554 <span class="normal">27</span>
4555 <span class="normal">28</span>
4556 <span class="normal">29</span>
4557 <span class="normal">30</span>
4558 <span class="normal">31</span>
4559 <span class="normal">32</span>
4560 <span class="normal">33</span>
4561 <span class="normal">34</span>
4562 <span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
4563 <span class="nt">&lt;package</span><span class="w"> </span><span class="na">name=</span><span class="s">&quot;com.woltlab.wcf.people&quot;</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span><span class="w"> </span><span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span><span class="w"> </span><span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/5.4/package.xsd&quot;</span><span class="nt">&gt;</span>
4564 <span class="w">    </span><span class="nt">&lt;packageinformation&gt;</span>
4565 <span class="w">        </span><span class="nt">&lt;packagename&gt;</span>WoltLab<span class="w"> </span>Suite<span class="w"> </span>Core<span class="w"> </span>Tutorial:<span class="w"> </span>People<span class="nt">&lt;/packagename&gt;</span>
4566 <span class="w">        </span><span class="nt">&lt;packagedescription&gt;</span>Adds<span class="w"> </span>a<span class="w"> </span>simple<span class="w"> </span>management<span class="w"> </span>system<span class="w"> </span>for<span class="w"> </span>people<span class="w"> </span>as<span class="w"> </span>part<span class="w"> </span>of<span class="w"> </span>a<span class="w"> </span>tutorial<span class="w"> </span>to<span class="w"> </span>create<span class="w"> </span>packages.<span class="nt">&lt;/packagedescription&gt;</span>
4567 <span class="w">        </span><span class="nt">&lt;version&gt;</span>5.4.0<span class="nt">&lt;/version&gt;</span>
4568 <span class="w">        </span><span class="nt">&lt;date&gt;</span>2022-01-17<span class="nt">&lt;/date&gt;</span>
4569 <span class="w">    </span><span class="nt">&lt;/packageinformation&gt;</span>
4570
4571 <span class="w">    </span><span class="nt">&lt;authorinformation&gt;</span>
4572 <span class="w">        </span><span class="nt">&lt;author&gt;</span>WoltLab<span class="w"> </span>GmbH<span class="nt">&lt;/author&gt;</span>
4573 <span class="w">        </span><span class="nt">&lt;authorurl&gt;</span>http://www.woltlab.com<span class="nt">&lt;/authorurl&gt;</span>
4574 <span class="w">    </span><span class="nt">&lt;/authorinformation&gt;</span>
4575
4576 <span class="w">    </span><span class="nt">&lt;requiredpackages&gt;</span>
4577 <span class="w">        </span><span class="nt">&lt;requiredpackage</span><span class="w"> </span><span class="na">minversion=</span><span class="s">&quot;5.4.10&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/requiredpackage&gt;</span>
4578 <span class="w">    </span><span class="nt">&lt;/requiredpackages&gt;</span>
4579
4580 <span class="w">    </span><span class="nt">&lt;excludedpackages&gt;</span>
4581 <span class="w">        </span><span class="nt">&lt;excludedpackage</span><span class="w"> </span><span class="na">version=</span><span class="s">&quot;6.0.0 Alpha 1&quot;</span><span class="nt">&gt;</span>com.woltlab.wcf<span class="nt">&lt;/excludedpackage&gt;</span>
4582 <span class="w">    </span><span class="nt">&lt;/excludedpackages&gt;</span>
4583
4584 <span class="w">    </span><span class="nt">&lt;instructions</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;install&quot;</span><span class="nt">&gt;</span>
4585 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;acpTemplate&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4586 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;file&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4587 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;database&quot;</span><span class="nt">&gt;</span>acp/database/install_com.woltlab.wcf.people.php<span class="nt">&lt;/instruction&gt;</span>
4588 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;template&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4589 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;language&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4590
4591 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;acpMenu&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4592 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;page&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4593 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;menuItem&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4594 <span class="w">        </span><span class="nt">&lt;instruction</span><span class="w"> </span><span class="na">type=</span><span class="s">&quot;userGroupOption&quot;</span><span class="w"> </span><span class="nt">/&gt;</span>
4595 <span class="w">    </span><span class="nt">&lt;/instructions&gt;</span>
4596 <span class="nt">&lt;/package&gt;</span>
4597 </code></pre></div></td></tr></table></div>
4598 <p>As this is a package for WoltLab Suite Core 3, we need to require it using <code>&lt;requiredpackage&gt;</code>.
4599 We require the latest version (when writing this tutorial) <code>5.4.0 Alpha 1</code>.
4600 Additionally, we disallow installation of the package in the next major version <code>6.0</code> by excluding the <code>6.0.0 Alpha 1</code> version.</p>
4601 <p>The most important part are to installation instructions.
4602 First, we install the ACP templates, files and templates, create the database table and import the language item.
4603 Afterwards, the ACP menu items and the permission are added.
4604 Now comes the part of the instructions where the order of the instructions is crucial:
4605 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>.
4606 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>
4607 <hr />
4608 <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>
4609 <p>The complete source code of this part can be found on <a href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-1">GitHub</a>.</p>
4610
4611   <hr>
4612 <div class="md-source-file">
4613   <small>
4614
4615       Last update:
4616       2022-04-19
4617
4618   </small>
4619 </div>
4620
4621
4622
4623
4624
4625
4626               </article>
4627             </div>
4628
4629
4630         </div>
4631
4632       </main>
4633
4634         <footer class="md-footer">
4635
4636   <div class="md-footer-meta md-typeset">
4637     <div class="md-footer-meta__inner md-grid">
4638       <div class="md-copyright">
4639
4640     <div class="md-copyright__highlight">
4641       Copyright © 2020 WoltLab GmbH
4642     </div>
4643
4644
4645     Made with
4646     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4647       Material for MkDocs
4648     </a>
4649
4650 </div>
4651
4652         <div class="md-copyright">
4653         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4654         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4655 </div>
4656
4657     </div>
4658   </div>
4659 </footer>
4660
4661     </div>
4662     <div class="md-dialog" data-md-component="dialog">
4663       <div class="md-dialog__inner md-typeset"></div>
4664     </div>
4665
4666     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
4667
4668
4669       <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
4670
4671
4672   </body>
4673 </html>