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