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