6.0/tutorial/series/part_4/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_4/">
  12
  13
  14         <link rel="prev" href="../part_3/">
  15
  16
  17         <link rel="next" href="../part_5/">
  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 4 - 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="#part-4-box-and-box-conditions" 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 4
 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     <li class="md-nav__item">
2485       <a href="../part_1/" class="md-nav__link">
2486         Part 1
2487       </a>
2488     </li>
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498     <li class="md-nav__item">
2499       <a href="../part_2/" class="md-nav__link">
2500         Part 2
2501       </a>
2502     </li>
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512     <li class="md-nav__item">
2513       <a href="../part_3/" class="md-nav__link">
2514         Part 3
2515       </a>
2516     </li>
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528     <li class="md-nav__item md-nav__item--active">
2529
2530       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
2531
2532
2533
2534
2535
2536         <label class="md-nav__link md-nav__link--active" for="__toc">
2537           Part 4
2538           <span class="md-nav__icon md-icon"></span>
2539         </label>
2540
2541       <a href="./" class="md-nav__link md-nav__link--active">
2542         Part 4
2543       </a>
2544
2545
2546
2547 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2548
2549
2550
2551
2552
2553
2554     <label class="md-nav__title" for="__toc">
2555       <span class="md-nav__icon md-icon"></span>
2556       Table of contents
2557     </label>
2558     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2559
2560         <li class="md-nav__item">
2561   <a href="#package-functionality" class="md-nav__link">
2562     Package Functionality
2563   </a>
2564
2565 </li>
2566
2567         <li class="md-nav__item">
2568   <a href="#used-components" class="md-nav__link">
2569     Used Components
2570   </a>
2571
2572 </li>
2573
2574         <li class="md-nav__item">
2575   <a href="#package-structure" class="md-nav__link">
2576     Package Structure
2577   </a>
2578
2579 </li>
2580
2581         <li class="md-nav__item">
2582   <a href="#box-controller" class="md-nav__link">
2583     Box Controller
2584   </a>
2585
2586 </li>
2587
2588         <li class="md-nav__item">
2589   <a href="#conditions" class="md-nav__link">
2590     Conditions
2591   </a>
2592
2593 </li>
2594
2595     </ul>
2596
2597 </nav>
2598
2599     </li>
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609     <li class="md-nav__item">
2610       <a href="../part_5/" class="md-nav__link">
2611         Part 5
2612       </a>
2613     </li>
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623     <li class="md-nav__item">
2624       <a href="../part_6/" class="md-nav__link">
2625         Part 6
2626       </a>
2627     </li>
2628
2629
2630
2631
2632         </ul>
2633       </nav>
2634     </li>
2635
2636
2637
2638
2639         </ul>
2640       </nav>
2641     </li>
2642
2643
2644
2645   </ul>
2646 </nav>
2647                   </div>
2648                 </div>
2649               </div>
2650
2651
2652
2653               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2654                 <div class="md-sidebar__scrollwrap">
2655                   <div class="md-sidebar__inner">
2656
2657
2658 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2659
2660
2661
2662
2663
2664
2665     <label class="md-nav__title" for="__toc">
2666       <span class="md-nav__icon md-icon"></span>
2667       Table of contents
2668     </label>
2669     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2670
2671         <li class="md-nav__item">
2672   <a href="#package-functionality" class="md-nav__link">
2673     Package Functionality
2674   </a>
2675
2676 </li>
2677
2678         <li class="md-nav__item">
2679   <a href="#used-components" class="md-nav__link">
2680     Used Components
2681   </a>
2682
2683 </li>
2684
2685         <li class="md-nav__item">
2686   <a href="#package-structure" class="md-nav__link">
2687     Package Structure
2688   </a>
2689
2690 </li>
2691
2692         <li class="md-nav__item">
2693   <a href="#box-controller" class="md-nav__link">
2694     Box Controller
2695   </a>
2696
2697 </li>
2698
2699         <li class="md-nav__item">
2700   <a href="#conditions" class="md-nav__link">
2701     Conditions
2702   </a>
2703
2704 </li>
2705
2706     </ul>
2707
2708 </nav>
2709                   </div>
2710                 </div>
2711               </div>
2712
2713
2714
2715             <div class="md-content" data-md-component="content">
2716               <article class="md-content__inner md-typeset">
2717
2718
2719
2720
2721
2722
2723
2724 <h1 id="part-4-box-and-box-conditions">Part 4: Box and Box Conditions<a class="headerlink" href="#part-4-box-and-box-conditions" title="Permanent link">#</a></h1>
2725 <p>In this part of our tutorial series, we add support for creating boxes listing people.</p>
2726 <h2 id="package-functionality">Package Functionality<a class="headerlink" href="#package-functionality" title="Permanent link">#</a></h2>
2727 <p>In addition to the existing functions from <a href="../part_3/">part 3</a>, the package will provide the following functionality after this part of the tutorial:</p>
2728 <ul>
2729 <li>Creating boxes dynamically listing people</li>
2730 <li>Filtering the people listed in boxes using conditions</li>
2731 </ul>
2732 <h2 id="used-components">Used Components<a class="headerlink" href="#used-components" title="Permanent link">#</a></h2>
2733 <p>In addition to the components used in previous parts, we will use the <a href="../../../package/pip/object-type-definition/"><code>objectTypeDefinition</code> package installation plugin</a> and use the box and condition APIs.</p>
2734 <p>To pre-install a specific person list box, we refer to the documentation of the <a href="../../../package/pip/box/"><code>box</code> package installation plugin</a>.</p>
2735 <h2 id="package-structure">Package Structure<a class="headerlink" href="#package-structure" title="Permanent link">#</a></h2>
2736 <p>The complete package will have the following file structure (<em>excluding</em> unchanged files from <a href="../part_3/">part 3</a>):</p>
2737 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2738 <span class="normal"> 2</span>
2739 <span class="normal"> 3</span>
2740 <span class="normal"> 4</span>
2741 <span class="normal"> 5</span>
2742 <span class="normal"> 6</span>
2743 <span class="normal"> 7</span>
2744 <span class="normal"> 8</span>
2745 <span class="normal"> 9</span>
2746 <span class="normal">10</span>
2747 <span class="normal">11</span>
2748 <span class="normal">12</span>
2749 <span class="normal">13</span>
2750 <span class="normal">14</span>
2751 <span class="normal">15</span>
2752 <span class="normal">16</span></pre></div></td><td class="code"><div><pre><span></span><code>├── files
2753 │   └── lib
2754 │       └── system
2755 │           ├── box
2756 │           │   └── PersonListBoxController.class.php
2757 │           └── condition
2758 │               └── person
2759 │                   ├── PersonFirstNameTextPropertyCondition.class.php
2760 │                   └── PersonLastNameTextPropertyCondition.class.php
2761 ├── language
2762 │   ├── de.xml
2763 │   └── en.xml
2764 ├── objectType.xml
2765 ├── objectTypeDefinition.xml
2766 └── templates
2767     └── boxPersonList.tpl
2768 </code></pre></div></td></tr></table></div>
2769 <p>For all changes, please refer to the <a href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-4">source code on GitHub</a>.</p>
2770 <h2 id="box-controller">Box Controller<a class="headerlink" href="#box-controller" title="Permanent link">#</a></h2>
2771 <p>In addition to static boxes with fixed contents, administrators are able to create dynamic boxes with contents from the database.
2772 In our case here, we want administrators to be able to create boxes listing people.
2773 To do so, we first have to register a new object type for this person list box controller for the object type definition <code>com.woltlab.wcf.boxController</code>:</p>
2774 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2775 <span class="normal">2</span>
2776 <span class="normal">3</span>
2777 <span class="normal">4</span>
2778 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nt">&lt;type&gt;</span>
2779 <span class="w">    </span><span class="nt">&lt;name&gt;</span>com.woltlab.wcf.personList<span class="nt">&lt;/name&gt;</span>
2780 <span class="w">    </span><span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.boxController<span class="nt">&lt;/definitionname&gt;</span>
2781 <span class="w">    </span><span class="nt">&lt;classname&gt;</span>wcf\system\box\PersonListBoxController<span class="nt">&lt;/classname&gt;</span>
2782 <span class="nt">&lt;/type&gt;</span>
2783 </code></pre></div></td></tr></table></div>
2784 <p>The <code>com.woltlab.wcf.boxController</code> object type definition requires the provided class to implement <code>wcf\system\box\IBoxController</code>:</p>
2785 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/system/box/PersonListBoxController.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-4/files/lib/system/box/PersonListBoxController.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>
2786 <span class="normal"> 2</span>
2787 <span class="normal"> 3</span>
2788 <span class="normal"> 4</span>
2789 <span class="normal"> 5</span>
2790 <span class="normal"> 6</span>
2791 <span class="normal"> 7</span>
2792 <span class="normal"> 8</span>
2793 <span class="normal"> 9</span>
2794 <span class="normal">10</span>
2795 <span class="normal">11</span>
2796 <span class="normal">12</span>
2797 <span class="normal">13</span>
2798 <span class="normal">14</span>
2799 <span class="normal">15</span>
2800 <span class="normal">16</span>
2801 <span class="normal">17</span>
2802 <span class="normal">18</span>
2803 <span class="normal">19</span>
2804 <span class="normal">20</span>
2805 <span class="normal">21</span>
2806 <span class="normal">22</span>
2807 <span class="normal">23</span>
2808 <span class="normal">24</span>
2809 <span class="normal">25</span>
2810 <span class="normal">26</span>
2811 <span class="normal">27</span>
2812 <span class="normal">28</span>
2813 <span class="normal">29</span>
2814 <span class="normal">30</span>
2815 <span class="normal">31</span>
2816 <span class="normal">32</span>
2817 <span class="normal">33</span>
2818 <span class="normal">34</span>
2819 <span class="normal">35</span>
2820 <span class="normal">36</span>
2821 <span class="normal">37</span>
2822 <span class="normal">38</span>
2823 <span class="normal">39</span>
2824 <span class="normal">40</span>
2825 <span class="normal">41</span>
2826 <span class="normal">42</span>
2827 <span class="normal">43</span>
2828 <span class="normal">44</span>
2829 <span class="normal">45</span>
2830 <span class="normal">46</span>
2831 <span class="normal">47</span>
2832 <span class="normal">48</span>
2833 <span class="normal">49</span>
2834 <span class="normal">50</span>
2835 <span class="normal">51</span>
2836 <span class="normal">52</span>
2837 <span class="normal">53</span>
2838 <span class="normal">54</span>
2839 <span class="normal">55</span>
2840 <span class="normal">56</span>
2841 <span class="normal">57</span>
2842 <span class="normal">58</span>
2843 <span class="normal">59</span>
2844 <span class="normal">60</span>
2845 <span class="normal">61</span>
2846 <span class="normal">62</span>
2847 <span class="normal">63</span>
2848 <span class="normal">64</span>
2849 <span class="normal">65</span>
2850 <span class="normal">66</span>
2851 <span class="normal">67</span>
2852 <span class="normal">68</span>
2853 <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>
2854
2855 <span class="k">namespace</span> <span class="nx">wcf\system\box</span><span class="p">;</span>
2856
2857 <span class="k">use</span> <span class="nx">wcf\data\person\PersonList</span><span class="p">;</span>
2858 <span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
2859
2860 <span class="sd">/**</span>
2861 <span class="sd"> * Dynamic box controller implementation for a list of persons.</span>
2862 <span class="sd"> *</span>
2863 <span class="sd"> * @author  Matthias Schmidt</span>
2864 <span class="sd"> * @copyright   2001-2022 WoltLab GmbH</span>
2865 <span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2866 <span class="sd"> * @package WoltLabSuite\Core\System\Box</span>
2867 <span class="sd"> */</span>
2868 <span class="k">final</span> <span class="k">class</span> <span class="nc">PersonListBoxController</span> <span class="k">extends</span> <span class="nx">AbstractDatabaseObjectListBoxController</span>
2869 <span class="p">{</span>
2870     <span class="sd">/**</span>
2871 <span class="sd">     * @inheritDoc</span>
2872 <span class="sd">     */</span>
2873     <span class="k">protected</span> <span class="nv">$conditionDefinition</span> <span class="o">=</span> <span class="s1">&#39;com.woltlab.wcf.box.personList.condition&#39;</span><span class="p">;</span>
2874
2875     <span class="sd">/**</span>
2876 <span class="sd">     * @inheritDoc</span>
2877 <span class="sd">     */</span>
2878     <span class="k">public</span> <span class="nv">$defaultLimit</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span>
2879
2880     <span class="sd">/**</span>
2881 <span class="sd">     * @inheritDoc</span>
2882 <span class="sd">     */</span>
2883     <span class="k">protected</span> <span class="nv">$sortFieldLanguageItemPrefix</span> <span class="o">=</span> <span class="s1">&#39;wcf.person&#39;</span><span class="p">;</span>
2884
2885     <span class="sd">/**</span>
2886 <span class="sd">     * @inheritDoc</span>
2887 <span class="sd">     */</span>
2888     <span class="k">protected</span> <span class="k">static</span> <span class="nv">$supportedPositions</span> <span class="o">=</span> <span class="p">[</span>
2889         <span class="s1">&#39;sidebarLeft&#39;</span><span class="p">,</span>
2890         <span class="s1">&#39;sidebarRight&#39;</span><span class="p">,</span>
2891     <span class="p">];</span>
2892
2893     <span class="sd">/**</span>
2894 <span class="sd">     * @inheritDoc</span>
2895 <span class="sd">     */</span>
2896     <span class="k">public</span> <span class="nv">$validSortFields</span> <span class="o">=</span> <span class="p">[</span>
2897         <span class="s1">&#39;firstName&#39;</span><span class="p">,</span>
2898         <span class="s1">&#39;lastName&#39;</span><span class="p">,</span>
2899         <span class="s1">&#39;comments&#39;</span><span class="p">,</span>
2900     <span class="p">];</span>
2901
2902     <span class="sd">/**</span>
2903 <span class="sd">     * @inheritDoc</span>
2904 <span class="sd">     */</span>
2905     <span class="k">protected</span> <span class="k">function</span> <span class="nf">getObjectList</span><span class="p">()</span>
2906     <span class="p">{</span>
2907         <span class="k">return</span> <span class="k">new</span> <span class="nx">PersonList</span><span class="p">();</span>
2908     <span class="p">}</span>
2909
2910     <span class="sd">/**</span>
2911 <span class="sd">     * @inheritDoc</span>
2912 <span class="sd">     */</span>
2913     <span class="k">protected</span> <span class="k">function</span> <span class="nf">getTemplate</span><span class="p">()</span>
2914     <span class="p">{</span>
2915         <span class="k">return</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">fetch</span><span class="p">(</span><span class="s1">&#39;boxPersonList&#39;</span><span class="p">,</span> <span class="s1">&#39;wcf&#39;</span><span class="p">,</span> <span class="p">[</span>
2916             <span class="s1">&#39;boxPersonList&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objectList</span><span class="p">,</span>
2917             <span class="s1">&#39;boxSortField&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">sortField</span><span class="p">,</span>
2918             <span class="s1">&#39;boxPosition&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">box</span><span class="o">-&gt;</span><span class="na">position</span><span class="p">,</span>
2919         <span class="p">],</span> <span class="k">true</span><span class="p">);</span>
2920     <span class="p">}</span>
2921 <span class="p">}</span>
2922 </code></pre></div></td></tr></table></div>
2923 <p>By extending <code>AbstractDatabaseObjectListBoxController</code>, we only have to provide minimal data ourself and rely mostly on the default implementation provided by <code>AbstractDatabaseObjectListBoxController</code>:</p>
2924 <ol>
2925 <li>As we will support <a href="#conditions">conditions</a> for the listed people, we have to set the relevant condition definition via <code>$conditionDefinition</code>.</li>
2926 <li><code>AbstractDatabaseObjectListBoxController</code> already supports restricting the number of listed objects.
2927    To do so, you only have to specify the default number of listed objects via <code>$defaultLimit</code>.</li>
2928 <li><code>AbstractDatabaseObjectListBoxController</code> also supports setting the sort order of the listed objects.
2929    You have to provide the supported sort fields via <code>$validSortFields</code> and specify the prefix used for the language items of the sort fields via <code>$sortFieldLanguageItemPrefix</code> so that for every <code>$validSortField</code> in <code>$validSortFields</code>, the language item <code>{$sortFieldLanguageItemPrefix}.{$validSortField}</code> must exist.</li>
2930 <li>The box system supports <a href="../../../package/pip/box/#position">different positions</a>.
2931    Each box controller specifies the positions it supports via <code>$supportedPositions</code>.
2932    To keep the implementation simple here as different positions might require different output in the template, we restrict ourselves to sidebars.</li>
2933 <li><code>getObjectList()</code> returns an instance of <code>DatabaseObjectList</code> that is used to read the listed objects.
2934    <code>getObjectList()</code> itself must not call <code>readObjects()</code>, as <code>AbstractDatabaseObjectListBoxController</code> takes care of calling the method after adding the conditions and setting the sort order.</li>
2935 <li><code>getTemplate()</code> returns the contents of the box relying on the <code>boxPersonList</code> template here:</li>
2936 </ol>
2937 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">templates/boxPersonList.tpl <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-4/templates/boxPersonList.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>
2938 <span class="normal"> 2</span>
2939 <span class="normal"> 3</span>
2940 <span class="normal"> 4</span>
2941 <span class="normal"> 5</span>
2942 <span class="normal"> 6</span>
2943 <span class="normal"> 7</span>
2944 <span class="normal"> 8</span>
2945 <span class="normal"> 9</span>
2946 <span class="normal">10</span>
2947 <span class="normal">11</span>
2948 <span class="normal">12</span>
2949 <span class="normal">13</span>
2950 <span class="normal">14</span>
2951 <span class="normal">15</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x">&lt;ul class=&quot;sidebarItemList&quot;&gt;</span>
2952 <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">$boxPersonList</span> <span class="na">item</span><span class="o">=</span><span class="na">boxPerson</span><span class="cp">}</span>
2953 <span class="x">        &lt;li class=&quot;box24&quot;&gt;</span>
2954 <span class="x">            &lt;span class=&quot;icon icon24 fa-user&quot;&gt;&lt;/span&gt;</span>
2955
2956 <span class="x">            &lt;div class=&quot;sidebarItemTitle&quot;&gt;</span>
2957 <span class="x">                &lt;h3&gt;</span><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$boxPerson</span><span class="cp">}</span><span class="x">&lt;/h3&gt;</span>
2958 <span class="x">                </span><span class="cp">{</span><span class="nf">capture</span> <span class="na">assign</span><span class="o">=</span><span class="s1">&#39;__boxPersonDescription&#39;</span><span class="cp">}{</span><span class="nf">lang</span> <span class="na">__optional</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">wcf.person.boxList.description.</span><span class="cp">{</span><span class="nv">$boxSortField</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}{</span><span class="nf">/capture</span><span class="cp">}</span>
2959 <span class="x">                </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$__boxPersonDescription</span><span class="cp">}</span>
2960 <span class="x">                    &lt;small&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$__boxPersonDescription</span><span class="cp">}</span><span class="x">&lt;/small&gt;</span>
2961 <span class="x">                </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span>
2962 <span class="x">            &lt;/div&gt;</span>
2963 <span class="x">        &lt;/li&gt;</span>
2964 <span class="x">    </span><span class="cp">{</span><span class="nf">/foreach</span><span class="cp">}</span>
2965 <span class="x">&lt;/ul&gt;</span>
2966 </code></pre></div></td></tr></table></div>
2967 <p>The template relies on a <code>.sidebarItemList</code> element, which is generally used for sidebar listings.
2968    (If different box positions were supported, we either have to generate different output by considering the value of <code>$boxPosition</code> in the template or by using different templates in <code>getTemplate()</code>.)
2969    One specific piece of code is the <code>$__boxPersonDescription</code> variable, which supports an optional description below the person's name relying on the optional language item <code>wcf.person.boxList.description.{$boxSortField}</code>.
2970    We only add one such language item when sorting the people by comments:
2971    In such a case, the number of comments will be shown.
2972    (When sorting by first and last name, there are no additional useful information that could be shown here, though the plugin from <a href="../part_2/">part 2</a> adding support for birthdays might also show the birthday when sorting by first or last name.)</p>
2973 <p>Lastly, we also provide the language item <code>wcf.acp.box.boxController.com.woltlab.wcf.personList</code>, which is used in the list of available box controllers.</p>
2974 <h2 id="conditions">Conditions<a class="headerlink" href="#conditions" title="Permanent link">#</a></h2>
2975 <p>The condition system can be used to generally filter a list of objects.
2976 In our case, the box system supports conditions to filter the objects shown in a specific box.
2977 Admittedly, our current person implementation only contains minimal data so that filtering might not make the most sense here but it will still show how to use the condition system for boxes.
2978 We will support filtering the people by their first and last name so that, for example, a box can be created listing all people with a specific first name.</p>
2979 <p>The first step for condition support is to register a object type definition for the relevant conditions requiring the <code>IObjectListCondition</code> interface:</p>
2980 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">objectTypeDefinition.xml <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-4/objectTypeDefinition.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>
2981 <span class="normal">2</span>
2982 <span class="normal">3</span>
2983 <span class="normal">4</span>
2984 <span class="normal">5</span>
2985 <span class="normal">6</span>
2986 <span class="normal">7</span>
2987 <span class="normal">8</span>
2988 <span class="normal">9</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>
2989 <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/objectTypeDefinition.xsd&quot;</span><span class="nt">&gt;</span>
2990 <span class="w">    </span><span class="nt">&lt;import&gt;</span>
2991 <span class="w">        </span><span class="nt">&lt;definition&gt;</span>
2992 <span class="w">            </span><span class="nt">&lt;name&gt;</span>com.woltlab.wcf.box.personList.condition<span class="nt">&lt;/name&gt;</span>
2993 <span class="w">            </span><span class="nt">&lt;interfacename&gt;</span>wcf\system\condition\IObjectListCondition<span class="nt">&lt;/interfacename&gt;</span>
2994 <span class="w">        </span><span class="nt">&lt;/definition&gt;</span>
2995 <span class="w">    </span><span class="nt">&lt;/import&gt;</span>
2996 <span class="nt">&lt;/data&gt;</span>
2997 </code></pre></div></td></tr></table></div>
2998 <p>Next, we register the specific conditions for filtering by the first and last name using this object type condition:</p>
2999 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
3000 <span class="normal"> 2</span>
3001 <span class="normal"> 3</span>
3002 <span class="normal"> 4</span>
3003 <span class="normal"> 5</span>
3004 <span class="normal"> 6</span>
3005 <span class="normal"> 7</span>
3006 <span class="normal"> 8</span>
3007 <span class="normal"> 9</span>
3008 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nt">&lt;type&gt;</span>
3009 <span class="w">   </span><span class="nt">&lt;name&gt;</span>com.woltlab.wcf.people.firstName<span class="nt">&lt;/name&gt;</span>
3010 <span class="w">   </span><span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.box.personList.condition<span class="nt">&lt;/definitionname&gt;</span>
3011 <span class="w">   </span><span class="nt">&lt;classname&gt;</span>wcf\system\condition\person\PersonFirstNameTextPropertyCondition<span class="nt">&lt;/classname&gt;</span>
3012 <span class="nt">&lt;/type&gt;</span>
3013 <span class="nt">&lt;type&gt;</span>
3014 <span class="w">   </span><span class="nt">&lt;name&gt;</span>com.woltlab.wcf.people.lastName<span class="nt">&lt;/name&gt;</span>
3015 <span class="w">   </span><span class="nt">&lt;definitionname&gt;</span>com.woltlab.wcf.box.personList.condition<span class="nt">&lt;/definitionname&gt;</span>
3016 <span class="w">   </span><span class="nt">&lt;classname&gt;</span>wcf\system\condition\person\PersonLastNameTextPropertyCondition<span class="nt">&lt;/classname&gt;</span>
3017 <span class="nt">&lt;/type&gt;</span>
3018 </code></pre></div></td></tr></table></div>
3019 <p><code>PersonFirstNameTextPropertyCondition</code> and <code>PersonLastNameTextPropertyCondition</code> only differ minimally so that we only focus on <code>PersonFirstNameTextPropertyCondition</code> here, which relies on the default implementation <code>AbstractObjectTextPropertyCondition</code> and only requires specifying different object properties:</p>
3020 <div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/system/condition/person/PersonFirstNameTextPropertyCondition.class.php <a class="codeBoxTitleGitHubLink" href="https://github.com/WoltLab/docs.woltlab.com/tree/6.0/snippets/tutorial/tutorial-series/part-4/files/lib/system/condition/person/PersonFirstNameTextPropertyCondition.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>
3021 <span class="normal"> 2</span>
3022 <span class="normal"> 3</span>
3023 <span class="normal"> 4</span>
3024 <span class="normal"> 5</span>
3025 <span class="normal"> 6</span>
3026 <span class="normal"> 7</span>
3027 <span class="normal"> 8</span>
3028 <span class="normal"> 9</span>
3029 <span class="normal">10</span>
3030 <span class="normal">11</span>
3031 <span class="normal">12</span>
3032 <span class="normal">13</span>
3033 <span class="normal">14</span>
3034 <span class="normal">15</span>
3035 <span class="normal">16</span>
3036 <span class="normal">17</span>
3037 <span class="normal">18</span>
3038 <span class="normal">19</span>
3039 <span class="normal">20</span>
3040 <span class="normal">21</span>
3041 <span class="normal">22</span>
3042 <span class="normal">23</span>
3043 <span class="normal">24</span>
3044 <span class="normal">25</span>
3045 <span class="normal">26</span>
3046 <span class="normal">27</span>
3047 <span class="normal">28</span>
3048 <span class="normal">29</span>
3049 <span class="normal">30</span>
3050 <span class="normal">31</span>
3051 <span class="normal">32</span>
3052 <span class="normal">33</span>
3053 <span class="normal">34</span>
3054 <span class="normal">35</span>
3055 <span class="normal">36</span>
3056 <span class="normal">37</span>
3057 <span class="normal">38</span>
3058 <span class="normal">39</span>
3059 <span class="normal">40</span>
3060 <span class="normal">41</span>
3061 <span class="normal">42</span>
3062 <span class="normal">43</span>
3063 <span class="normal">44</span>
3064 <span class="normal">45</span>
3065 <span class="normal">46</span>
3066 <span class="normal">47</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
3067
3068 <span class="k">namespace</span> <span class="nx">wcf\system\condition\person</span><span class="p">;</span>
3069
3070 <span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
3071 <span class="k">use</span> <span class="nx">wcf\system\condition\AbstractObjectTextPropertyCondition</span><span class="p">;</span>
3072
3073 <span class="sd">/**</span>
3074 <span class="sd"> * Condition implementation for the first name of a person.</span>
3075 <span class="sd"> *</span>
3076 <span class="sd"> * @author  Matthias Schmidt</span>
3077 <span class="sd"> * @copyright   2001-2022 WoltLab GmbH</span>
3078 <span class="sd"> * @license WoltLab License &lt;http://www.woltlab.com/license-agreement.html&gt;</span>
3079 <span class="sd"> * @package WoltLabSuite\Core\System\Condition</span>
3080 <span class="sd"> */</span>
3081 <span class="k">final</span> <span class="k">class</span> <span class="nc">PersonFirstNameTextPropertyCondition</span> <span class="k">extends</span> <span class="nx">AbstractObjectTextPropertyCondition</span>
3082 <span class="p">{</span>
3083     <span class="sd">/**</span>
3084 <span class="sd">     * @inheritDoc</span>
3085 <span class="sd">     */</span>
3086     <span class="k">protected</span> <span class="nv">$className</span> <span class="o">=</span> <span class="nx">Person</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
3087
3088     <span class="sd">/**</span>
3089 <span class="sd">     * @inheritDoc</span>
3090 <span class="sd">     */</span>
3091     <span class="k">protected</span> <span class="nv">$description</span> <span class="o">=</span> <span class="s1">&#39;wcf.person.condition.firstName.description&#39;</span><span class="p">;</span>
3092
3093     <span class="sd">/**</span>
3094 <span class="sd">     * @inheritDoc</span>
3095 <span class="sd">     */</span>
3096     <span class="k">protected</span> <span class="nv">$fieldName</span> <span class="o">=</span> <span class="s1">&#39;personFirstName&#39;</span><span class="p">;</span>
3097
3098     <span class="sd">/**</span>
3099 <span class="sd">     * @inheritDoc</span>
3100 <span class="sd">     */</span>
3101     <span class="k">protected</span> <span class="nv">$label</span> <span class="o">=</span> <span class="s1">&#39;wcf.person.firstName&#39;</span><span class="p">;</span>
3102
3103     <span class="sd">/**</span>
3104 <span class="sd">     * @inheritDoc</span>
3105 <span class="sd">     */</span>
3106     <span class="k">protected</span> <span class="nv">$propertyName</span> <span class="o">=</span> <span class="s1">&#39;firstName&#39;</span><span class="p">;</span>
3107
3108     <span class="sd">/**</span>
3109 <span class="sd">     * @inheritDoc</span>
3110 <span class="sd">     */</span>
3111     <span class="k">protected</span> <span class="nv">$supportsMultipleValues</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span>
3112 <span class="p">}</span>
3113 </code></pre></div></td></tr></table></div>
3114 <ol>
3115 <li><code>$className</code> contains the class name of the relevant database object from which the class name of the database object list is derived and <code>$propertyName</code> is the name of the database object's property that contains the value used for filtering.</li>
3116 <li>By setting <code>$supportsMultipleValues</code> to <code>true</code>, multiple comma-separated values can be specified so that, for example, a box can also only list people with either of two specific first names.</li>
3117 <li><code>$description</code> (optional), <code>$fieldName</code>, and <code>$label</code> are used in the output of the form field.</li>
3118 </ol>
3119 <p>(The implementation here is specific for <code>AbstractObjectTextPropertyCondition</code>.
3120 The <code>wcf\system\condition</code> namespace also contains several other default condition implementations.)</p>
3121
3122   <hr>
3123 <div class="md-source-file">
3124   <small>
3125
3126       Last update:
3127       2021-05-03
3128
3129   </small>
3130 </div>
3131
3132
3133
3134
3135
3136
3137               </article>
3138             </div>
3139
3140
3141         </div>
3142
3143       </main>
3144
3145         <footer class="md-footer">
3146
3147   <div class="md-footer-meta md-typeset">
3148     <div class="md-footer-meta__inner md-grid">
3149       <div class="md-copyright">
3150
3151     <div class="md-copyright__highlight">
3152       Copyright © 2020 WoltLab GmbH
3153     </div>
3154
3155
3156     Made with
3157     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3158       Material for MkDocs
3159     </a>
3160
3161 </div>
3162
3163         <div class="md-copyright">
3164         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
3165         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
3166 </div>
3167
3168     </div>
3169   </div>
3170 </footer>
3171
3172     </div>
3173     <div class="md-dialog" data-md-component="dialog">
3174       <div class="md-dialog__inner md-typeset"></div>
3175     </div>
3176
3177     <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>
3178
3179
3180       <script src="../../../assets/javascripts/bundle.b4d07000.min.js"></script>
3181
3182
3183   </body>
3184 </html>