6.0/package/database-php-api/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11         <link rel="canonical" href="https://docs.woltlab.com/6.0/package/database-php-api/">
  12
  13
  14         <link rel="prev" href="../pip/user-profile-menu/">
  15
  16
  17         <link rel="next" href="../../migration/wsc55/php/">
  18
  19       <link rel="icon" href="../../assets/default.favicon.ico">
  20       <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.0.15">
  21
  22
  23
  24         <title>Database PHP API - WoltLab Suite Documentation</title>
  25
  26
  27
  28       <link rel="stylesheet" href="../../assets/stylesheets/main.113286f1.min.css">
  29
  30
  31         <link rel="stylesheet" href="../../assets/stylesheets/palette.a0c5b2b5.min.css">
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41       <link rel="stylesheet" href="../../stylesheets/extra.css">
  42
  43     <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  44
  45
  46
  47
  48
  49
  50   </head>
  51
  52
  53
  54
  55
  56
  57
  58     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="">
  59
  60
  61
  62     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  63     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  64     <label class="md-overlay" for="__drawer"></label>
  65     <div data-md-component="skip">
  66
  67
  68         <a href="#database-php-api" class="md-skip">
  69           Skip to content
  70         </a>
  71
  72     </div>
  73     <div data-md-component="announce">
  74
  75         <aside class="md-banner">
  76           <div class="md-banner__inner md-grid md-typeset">
  77
  78
  79     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  80
  81           </div>
  82
  83         </aside>
  84
  85     </div>
  86
  87       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  88
  89       </div>
  90
  91
  92
  93
  94 <header class="md-header" data-md-component="header">
  95   <nav class="md-header__inner md-grid" aria-label="Header">
  96     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
  97
  98   <img src="../../assets/logo.png" alt="logo">
  99
 100     </a>
 101     <label class="md-header__button md-icon" for="__drawer">
 102       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 103     </label>
 104     <div class="md-header__title" data-md-component="header-title">
 105       <div class="md-header__ellipsis">
 106         <div class="md-header__topic">
 107           <span class="md-ellipsis">
 108             WoltLab Suite Documentation
 109           </span>
 110         </div>
 111         <div class="md-header__topic" data-md-component="header-topic">
 112           <span class="md-ellipsis">
 113
 114               Database PHP API
 115
 116           </span>
 117         </div>
 118       </div>
 119     </div>
 120
 121
 122
 123       <label class="md-header__button md-icon" for="__search">
 124         <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>
 125       </label>
 126       <div class="md-search" data-md-component="search" role="dialog">
 127   <label class="md-search__overlay" for="__search"></label>
 128   <div class="md-search__inner" role="search">
 129     <form class="md-search__form" name="search">
 130       <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
 131       <label class="md-search__icon md-icon" for="__search">
 132         <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>
 133         <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>
 134       </label>
 135       <nav class="md-search__options" aria-label="Search">
 136
 137         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 138           <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>
 139         </button>
 140       </nav>
 141
 142     </form>
 143     <div class="md-search__output">
 144       <div class="md-search__scrollwrap" data-md-scrollfix>
 145         <div class="md-search-result" data-md-component="search-result">
 146           <div class="md-search-result__meta">
 147             Initializing search
 148           </div>
 149           <ol class="md-search-result__list" role="presentation"></ol>
 150         </div>
 151       </div>
 152     </div>
 153   </div>
 154 </div>
 155
 156
 157       <div class="md-header__source">
 158         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 159   <div class="md-source__icon md-icon">
 160
 161     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 162   </div>
 163   <div class="md-source__repository">
 164     GitHub
 165   </div>
 166 </a>
 167       </div>
 168
 169   </nav>
 170
 171 </header>
 172
 173     <div class="md-container" data-md-component="container">
 174
 175
 176
 177
 178
 179
 180       <main class="md-main" data-md-component="main">
 181         <div class="md-main__inner md-grid">
 182
 183
 184
 185               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 186                 <div class="md-sidebar__scrollwrap">
 187                   <div class="md-sidebar__inner">
 188
 189
 190
 191 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 192   <label class="md-nav__title" for="__drawer">
 193     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 194
 195   <img src="../../assets/logo.png" alt="logo">
 196
 197     </a>
 198     WoltLab Suite Documentation
 199   </label>
 200
 201     <div class="md-nav__source">
 202       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 203   <div class="md-source__icon md-icon">
 204
 205     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.3.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 206   </div>
 207   <div class="md-source__repository">
 208     GitHub
 209   </div>
 210 </a>
 211     </div>
 212
 213   <ul class="md-nav__list" data-md-scrollfix>
 214
 215
 216
 217
 218
 219
 220
 221
 222     <li class="md-nav__item">
 223       <a href="../../getting-started/" class="md-nav__link">
 224         Getting Started
 225       </a>
 226     </li>
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238     <li class="md-nav__item md-nav__item--nested">
 239
 240
 241
 242
 243       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
 244
 245
 246
 247         <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 248           PHP API
 249           <span class="md-nav__icon md-icon"></span>
 250         </label>
 251
 252       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
 253         <label class="md-nav__title" for="__nav_2">
 254           <span class="md-nav__icon md-icon"></span>
 255           PHP API
 256         </label>
 257         <ul class="md-nav__list" data-md-scrollfix>
 258
 259
 260
 261
 262
 263
 264     <li class="md-nav__item">
 265       <a href="../../php/pages/" class="md-nav__link">
 266         Pages
 267       </a>
 268     </li>
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../php/database-objects/" class="md-nav__link">
 280         Database Objects
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292     <li class="md-nav__item">
 293       <a href="../../php/database-access/" class="md-nav__link">
 294         Database Access
 295       </a>
 296     </li>
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306     <li class="md-nav__item">
 307       <a href="../../php/exceptions/" class="md-nav__link">
 308         Exceptions
 309       </a>
 310     </li>
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321     <li class="md-nav__item md-nav__item--nested">
 322
 323
 324
 325
 326       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
 327
 328
 329
 330         <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 331           API
 332           <span class="md-nav__icon md-icon"></span>
 333         </label>
 334
 335       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
 336         <label class="md-nav__title" for="__nav_2_5">
 337           <span class="md-nav__icon md-icon"></span>
 338           API
 339         </label>
 340         <ul class="md-nav__list" data-md-scrollfix>
 341
 342
 343
 344
 345
 346
 347
 348     <li class="md-nav__item md-nav__item--nested">
 349
 350
 351
 352
 353       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 354
 355
 356
 357         <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 358           Caches
 359           <span class="md-nav__icon md-icon"></span>
 360         </label>
 361
 362       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 363         <label class="md-nav__title" for="__nav_2_5_1">
 364           <span class="md-nav__icon md-icon"></span>
 365           Caches
 366         </label>
 367         <ul class="md-nav__list" data-md-scrollfix>
 368
 369
 370
 371
 372
 373
 374     <li class="md-nav__item">
 375       <a href="../../php/api/caches/" class="md-nav__link">
 376         Overview
 377       </a>
 378     </li>
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388     <li class="md-nav__item">
 389       <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
 390         Persistent Caches
 391       </a>
 392     </li>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402     <li class="md-nav__item">
 403       <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
 404         Runtime Caches
 405       </a>
 406     </li>
 407
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423     <li class="md-nav__item">
 424       <a href="../../php/api/comments/" class="md-nav__link">
 425         Comments
 426       </a>
 427     </li>
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437     <li class="md-nav__item">
 438       <a href="../../php/api/cronjobs/" class="md-nav__link">
 439         Cronjobs
 440       </a>
 441     </li>
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451     <li class="md-nav__item">
 452       <a href="../../php/api/events/" class="md-nav__link">
 453         Events
 454       </a>
 455     </li>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466     <li class="md-nav__item md-nav__item--nested">
 467
 468
 469
 470
 471       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 472
 473
 474
 475         <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 476           Form Builder
 477           <span class="md-nav__icon md-icon"></span>
 478         </label>
 479
 480       <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 481         <label class="md-nav__title" for="__nav_2_5_5">
 482           <span class="md-nav__icon md-icon"></span>
 483           Form Builder
 484         </label>
 485         <ul class="md-nav__list" data-md-scrollfix>
 486
 487
 488
 489
 490
 491
 492     <li class="md-nav__item">
 493       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 494         Overview
 495       </a>
 496     </li>
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506     <li class="md-nav__item">
 507       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 508         Structure
 509       </a>
 510     </li>
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520     <li class="md-nav__item">
 521       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 522         Fields
 523       </a>
 524     </li>
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534     <li class="md-nav__item">
 535       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 536         Validation and Data
 537       </a>
 538     </li>
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548     <li class="md-nav__item">
 549       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 550         Dependencies
 551       </a>
 552     </li>
 553
 554
 555
 556
 557         </ul>
 558       </nav>
 559     </li>
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569     <li class="md-nav__item">
 570       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 571         Package Installation Plugins
 572       </a>
 573     </li>
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583     <li class="md-nav__item">
 584       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 585         User Activity Points
 586       </a>
 587     </li>
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597     <li class="md-nav__item">
 598       <a href="../../php/api/user_notifications/" class="md-nav__link">
 599         User Notifications
 600       </a>
 601     </li>
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611     <li class="md-nav__item">
 612       <a href="../../php/api/sitemaps/" class="md-nav__link">
 613         Sitemaps
 614       </a>
 615     </li>
 616
 617
 618
 619
 620         </ul>
 621       </nav>
 622     </li>
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632     <li class="md-nav__item">
 633       <a href="../../php/code-style/" class="md-nav__link">
 634         Code Style
 635       </a>
 636     </li>
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item">
 647       <a href="../../php/apps/" class="md-nav__link">
 648         Apps
 649       </a>
 650     </li>
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660     <li class="md-nav__item">
 661       <a href="../../php/gdpr/" class="md-nav__link">
 662         GDPR
 663       </a>
 664     </li>
 665
 666
 667
 668
 669         </ul>
 670       </nav>
 671     </li>
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683     <li class="md-nav__item md-nav__item--nested">
 684
 685
 686
 687
 688       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
 689
 690
 691
 692         <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
 693           Languages, Templates & CSS
 694           <span class="md-nav__icon md-icon"></span>
 695         </label>
 696
 697       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
 698         <label class="md-nav__title" for="__nav_3">
 699           <span class="md-nav__icon md-icon"></span>
 700           Languages, Templates & CSS
 701         </label>
 702         <ul class="md-nav__list" data-md-scrollfix>
 703
 704
 705
 706
 707
 708
 709     <li class="md-nav__item">
 710       <a href="../../view/languages/" class="md-nav__link">
 711         Languages
 712       </a>
 713     </li>
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723     <li class="md-nav__item">
 724       <a href="../../view/templates/" class="md-nav__link">
 725         Templates
 726       </a>
 727     </li>
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737     <li class="md-nav__item">
 738       <a href="../../view/template-plugins/" class="md-nav__link">
 739         Template Plugins
 740       </a>
 741     </li>
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751     <li class="md-nav__item">
 752       <a href="../../view/css/" class="md-nav__link">
 753         CSS
 754       </a>
 755     </li>
 756
 757
 758
 759
 760         </ul>
 761       </nav>
 762     </li>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item md-nav__item--nested">
 775
 776
 777
 778
 779       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
 780
 781
 782
 783         <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
 784           TypeScript and JavaScript API
 785           <span class="md-nav__icon md-icon"></span>
 786         </label>
 787
 788       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
 789         <label class="md-nav__title" for="__nav_4">
 790           <span class="md-nav__icon md-icon"></span>
 791           TypeScript and JavaScript API
 792         </label>
 793         <ul class="md-nav__list" data-md-scrollfix>
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item">
 801       <a href="../../javascript/general-usage/" class="md-nav__link">
 802         General Usage
 803       </a>
 804     </li>
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814     <li class="md-nav__item">
 815       <a href="../../javascript/typescript/" class="md-nav__link">
 816         TypeScript
 817       </a>
 818     </li>
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829     <li class="md-nav__item md-nav__item--nested">
 830
 831
 832
 833
 834       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
 835
 836
 837
 838         <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
 839           Components
 840           <span class="md-nav__icon md-icon"></span>
 841         </label>
 842
 843       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
 844         <label class="md-nav__title" for="__nav_4_3">
 845           <span class="md-nav__icon md-icon"></span>
 846           Components
 847         </label>
 848         <ul class="md-nav__list" data-md-scrollfix>
 849
 850
 851
 852
 853
 854
 855     <li class="md-nav__item">
 856       <a href="../../javascript/components_confirmation/" class="md-nav__link">
 857         Confirmation
 858       </a>
 859     </li>
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869     <li class="md-nav__item">
 870       <a href="../../javascript/components_dialog/" class="md-nav__link">
 871         Dialog
 872       </a>
 873     </li>
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883     <li class="md-nav__item">
 884       <a href="../../javascript/components_google_maps/" class="md-nav__link">
 885         Google Maps
 886       </a>
 887     </li>
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897     <li class="md-nav__item">
 898       <a href="../../javascript/components_pagination/" class="md-nav__link">
 899         Pagination
 900       </a>
 901     </li>
 902
 903
 904
 905
 906         </ul>
 907       </nav>
 908     </li>
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919     <li class="md-nav__item md-nav__item--nested">
 920
 921
 922
 923
 924       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
 925
 926
 927
 928         <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
 929           New API
 930           <span class="md-nav__icon md-icon"></span>
 931         </label>
 932
 933       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
 934         <label class="md-nav__title" for="__nav_4_4">
 935           <span class="md-nav__icon md-icon"></span>
 936           New API
 937         </label>
 938         <ul class="md-nav__list" data-md-scrollfix>
 939
 940
 941
 942
 943
 944
 945     <li class="md-nav__item">
 946       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 947         Writing a module
 948       </a>
 949     </li>
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959     <li class="md-nav__item">
 960       <a href="../../javascript/new-api_core/" class="md-nav__link">
 961         Core Functions
 962       </a>
 963     </li>
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973     <li class="md-nav__item">
 974       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 975         DOM
 976       </a>
 977     </li>
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item">
 988       <a href="../../javascript/new-api_events/" class="md-nav__link">
 989         Event Handling
 990       </a>
 991     </li>
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001     <li class="md-nav__item">
1002       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
1003         Ajax
1004       </a>
1005     </li>
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015     <li class="md-nav__item">
1016       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
1017         Dialogs
1018       </a>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029     <li class="md-nav__item">
1030       <a href="../../javascript/new-api_browser/" class="md-nav__link">
1031         Browser and Screen Sizes
1032       </a>
1033     </li>
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043     <li class="md-nav__item">
1044       <a href="../../javascript/new-api_ui/" class="md-nav__link">
1045         User Interface
1046       </a>
1047     </li>
1048
1049
1050
1051
1052         </ul>
1053       </nav>
1054     </li>
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064     <li class="md-nav__item">
1065       <a href="../../javascript/legacy-api/" class="md-nav__link">
1066         Legacy API
1067       </a>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../../javascript/code-snippets/" class="md-nav__link">
1080         Code Snippets
1081       </a>
1082     </li>
1083
1084
1085
1086
1087         </ul>
1088       </nav>
1089     </li>
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1104
1105
1106
1107
1108       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1109
1110
1111
1112         <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1113           Package Components
1114           <span class="md-nav__icon md-icon"></span>
1115         </label>
1116
1117       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1118         <label class="md-nav__title" for="__nav_5">
1119           <span class="md-nav__icon md-icon"></span>
1120           Package Components
1121         </label>
1122         <ul class="md-nav__list" data-md-scrollfix>
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../package-xml/" class="md-nav__link">
1131         package.xml
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144     <li class="md-nav__item md-nav__item--nested">
1145
1146
1147
1148
1149       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1150
1151
1152
1153         <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1154           PIPs
1155           <span class="md-nav__icon md-icon"></span>
1156         </label>
1157
1158       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1159         <label class="md-nav__title" for="__nav_5_2">
1160           <span class="md-nav__icon md-icon"></span>
1161           PIPs
1162         </label>
1163         <ul class="md-nav__list" data-md-scrollfix>
1164
1165
1166
1167
1168
1169
1170     <li class="md-nav__item">
1171       <a href="../pip/" class="md-nav__link">
1172         Overview
1173       </a>
1174     </li>
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184     <li class="md-nav__item">
1185       <a href="../pip/acl-option/" class="md-nav__link">
1186         aclOption
1187       </a>
1188     </li>
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198     <li class="md-nav__item">
1199       <a href="../pip/acp-menu/" class="md-nav__link">
1200         acpMenu
1201       </a>
1202     </li>
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212     <li class="md-nav__item">
1213       <a href="../pip/acp-search-provider/" class="md-nav__link">
1214         acpSearchProvider
1215       </a>
1216     </li>
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226     <li class="md-nav__item">
1227       <a href="../pip/acp-template/" class="md-nav__link">
1228         acpTemplate
1229       </a>
1230     </li>
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240     <li class="md-nav__item">
1241       <a href="../pip/acp-template-delete/" class="md-nav__link">
1242         acpTemplateDelete
1243       </a>
1244     </li>
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254     <li class="md-nav__item">
1255       <a href="../pip/bbcode/" class="md-nav__link">
1256         bbcode
1257       </a>
1258     </li>
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268     <li class="md-nav__item">
1269       <a href="../pip/box/" class="md-nav__link">
1270         box
1271       </a>
1272     </li>
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282     <li class="md-nav__item">
1283       <a href="../pip/clipboard-action/" class="md-nav__link">
1284         clipboardAction
1285       </a>
1286     </li>
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296     <li class="md-nav__item">
1297       <a href="../pip/core-object/" class="md-nav__link">
1298         coreObject
1299       </a>
1300     </li>
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310     <li class="md-nav__item">
1311       <a href="../pip/cronjob/" class="md-nav__link">
1312         cronjob
1313       </a>
1314     </li>
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324     <li class="md-nav__item">
1325       <a href="../pip/database/" class="md-nav__link">
1326         database
1327       </a>
1328     </li>
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338     <li class="md-nav__item">
1339       <a href="../pip/event-listener/" class="md-nav__link">
1340         eventListener
1341       </a>
1342     </li>
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352     <li class="md-nav__item">
1353       <a href="../pip/file/" class="md-nav__link">
1354         file
1355       </a>
1356     </li>
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366     <li class="md-nav__item">
1367       <a href="../pip/file-delete/" class="md-nav__link">
1368         fileDelete
1369       </a>
1370     </li>
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380     <li class="md-nav__item">
1381       <a href="../pip/language/" class="md-nav__link">
1382         language
1383       </a>
1384     </li>
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394     <li class="md-nav__item">
1395       <a href="../pip/media-provider/" class="md-nav__link">
1396         mediaProvider
1397       </a>
1398     </li>
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408     <li class="md-nav__item">
1409       <a href="../pip/menu/" class="md-nav__link">
1410         menu
1411       </a>
1412     </li>
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422     <li class="md-nav__item">
1423       <a href="../pip/menu-item/" class="md-nav__link">
1424         menuItem
1425       </a>
1426     </li>
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436     <li class="md-nav__item">
1437       <a href="../pip/object-type/" class="md-nav__link">
1438         objectType
1439       </a>
1440     </li>
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450     <li class="md-nav__item">
1451       <a href="../pip/object-type-definition/" class="md-nav__link">
1452         objectTypeDefinition
1453       </a>
1454     </li>
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464     <li class="md-nav__item">
1465       <a href="../pip/option/" class="md-nav__link">
1466         option
1467       </a>
1468     </li>
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478     <li class="md-nav__item">
1479       <a href="../pip/page/" class="md-nav__link">
1480         page
1481       </a>
1482     </li>
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492     <li class="md-nav__item">
1493       <a href="../pip/pip/" class="md-nav__link">
1494         pip
1495       </a>
1496     </li>
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506     <li class="md-nav__item">
1507       <a href="../pip/script/" class="md-nav__link">
1508         script
1509       </a>
1510     </li>
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520     <li class="md-nav__item">
1521       <a href="../pip/smiley/" class="md-nav__link">
1522         smiley
1523       </a>
1524     </li>
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534     <li class="md-nav__item">
1535       <a href="../pip/sql/" class="md-nav__link">
1536         sql
1537       </a>
1538     </li>
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548     <li class="md-nav__item">
1549       <a href="../pip/style/" class="md-nav__link">
1550         style
1551       </a>
1552     </li>
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562     <li class="md-nav__item">
1563       <a href="../pip/template/" class="md-nav__link">
1564         template
1565       </a>
1566     </li>
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576     <li class="md-nav__item">
1577       <a href="../pip/template-delete/" class="md-nav__link">
1578         templateDelete
1579       </a>
1580     </li>
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590     <li class="md-nav__item">
1591       <a href="../pip/template-listener/" class="md-nav__link">
1592         templateListener
1593       </a>
1594     </li>
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604     <li class="md-nav__item">
1605       <a href="../pip/user-group-option/" class="md-nav__link">
1606         userGroupOption
1607       </a>
1608     </li>
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../pip/user-menu/" class="md-nav__link">
1620         userMenu
1621       </a>
1622     </li>
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632     <li class="md-nav__item">
1633       <a href="../pip/user-notification-event/" class="md-nav__link">
1634         userNotificationEvent
1635       </a>
1636     </li>
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646     <li class="md-nav__item">
1647       <a href="../pip/user-option/" class="md-nav__link">
1648         userOption
1649       </a>
1650     </li>
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660     <li class="md-nav__item">
1661       <a href="../pip/user-profile-menu/" class="md-nav__link">
1662         userProfileMenu
1663       </a>
1664     </li>
1665
1666
1667
1668
1669         </ul>
1670       </nav>
1671     </li>
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683     <li class="md-nav__item md-nav__item--active">
1684
1685       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1686
1687
1688
1689
1690
1691         <label class="md-nav__link md-nav__link--active" for="__toc">
1692           Database PHP API
1693           <span class="md-nav__icon md-icon"></span>
1694         </label>
1695
1696       <a href="./" class="md-nav__link md-nav__link--active">
1697         Database PHP API
1698       </a>
1699
1700
1701
1702 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1703
1704
1705
1706
1707
1708
1709     <label class="md-nav__title" for="__toc">
1710       <span class="md-nav__icon md-icon"></span>
1711       Table of contents
1712     </label>
1713     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1714
1715         <li class="md-nav__item">
1716   <a href="#database-tables" class="md-nav__link">
1717     Database Tables
1718   </a>
1719
1720 </li>
1721
1722         <li class="md-nav__item">
1723   <a href="#columns" class="md-nav__link">
1724     Columns
1725   </a>
1726
1727 </li>
1728
1729         <li class="md-nav__item">
1730   <a href="#foreign-keys" class="md-nav__link">
1731     Foreign Keys
1732   </a>
1733
1734 </li>
1735
1736         <li class="md-nav__item">
1737   <a href="#indices" class="md-nav__link">
1738     Indices
1739   </a>
1740
1741 </li>
1742
1743     </ul>
1744
1745 </nav>
1746
1747     </li>
1748
1749
1750
1751
1752         </ul>
1753       </nav>
1754     </li>
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766     <li class="md-nav__item md-nav__item--nested">
1767
1768
1769
1770
1771       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
1772
1773
1774
1775         <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
1776           Migration
1777           <span class="md-nav__icon md-icon"></span>
1778         </label>
1779
1780       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
1781         <label class="md-nav__title" for="__nav_6">
1782           <span class="md-nav__icon md-icon"></span>
1783           Migration
1784         </label>
1785         <ul class="md-nav__list" data-md-scrollfix>
1786
1787
1788
1789
1790
1791
1792
1793     <li class="md-nav__item md-nav__item--nested">
1794
1795
1796
1797
1798       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
1799
1800
1801
1802         <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
1803           From WoltLab Suite 5.5
1804           <span class="md-nav__icon md-icon"></span>
1805         </label>
1806
1807       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
1808         <label class="md-nav__title" for="__nav_6_1">
1809           <span class="md-nav__icon md-icon"></span>
1810           From WoltLab Suite 5.5
1811         </label>
1812         <ul class="md-nav__list" data-md-scrollfix>
1813
1814
1815
1816
1817
1818
1819     <li class="md-nav__item">
1820       <a href="../../migration/wsc55/php/" class="md-nav__link">
1821         PHP API
1822       </a>
1823     </li>
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1835         TypeScript and JavaScript
1836       </a>
1837     </li>
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847     <li class="md-nav__item">
1848       <a href="../../migration/wsc55/templates/" class="md-nav__link">
1849         Templates
1850       </a>
1851     </li>
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861     <li class="md-nav__item">
1862       <a href="../../migration/wsc55/icons/" class="md-nav__link">
1863         Icons
1864       </a>
1865     </li>
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875     <li class="md-nav__item">
1876       <a href="../../migration/wsc55/dialogs/" class="md-nav__link">
1877         Dialogs
1878       </a>
1879     </li>
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889     <li class="md-nav__item">
1890       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
1891         Third Party Libraries
1892       </a>
1893     </li>
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903     <li class="md-nav__item">
1904       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1905         Deprecations and Removals
1906       </a>
1907     </li>
1908
1909
1910
1911
1912         </ul>
1913       </nav>
1914     </li>
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925     <li class="md-nav__item md-nav__item--nested">
1926
1927
1928
1929
1930       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
1931
1932
1933
1934         <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
1935           From WoltLab Suite 5.4
1936           <span class="md-nav__icon md-icon"></span>
1937         </label>
1938
1939       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
1940         <label class="md-nav__title" for="__nav_6_2">
1941           <span class="md-nav__icon md-icon"></span>
1942           From WoltLab Suite 5.4
1943         </label>
1944         <ul class="md-nav__list" data-md-scrollfix>
1945
1946
1947
1948
1949
1950
1951     <li class="md-nav__item">
1952       <a href="../../migration/wsc54/php/" class="md-nav__link">
1953         PHP API
1954       </a>
1955     </li>
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965     <li class="md-nav__item">
1966       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
1967         TypeScript and JavaScript
1968       </a>
1969     </li>
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979     <li class="md-nav__item">
1980       <a href="../../migration/wsc54/templates/" class="md-nav__link">
1981         Templates
1982       </a>
1983     </li>
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993     <li class="md-nav__item">
1994       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
1995         Third Party Libraries
1996       </a>
1997     </li>
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007     <li class="md-nav__item">
2008       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2009         Deprecations and Removals
2010       </a>
2011     </li>
2012
2013
2014
2015
2016         </ul>
2017       </nav>
2018     </li>
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029     <li class="md-nav__item md-nav__item--nested">
2030
2031
2032
2033
2034       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2035
2036
2037
2038         <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2039           From WoltLab Suite 5.3
2040           <span class="md-nav__icon md-icon"></span>
2041         </label>
2042
2043       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2044         <label class="md-nav__title" for="__nav_6_3">
2045           <span class="md-nav__icon md-icon"></span>
2046           From WoltLab Suite 5.3
2047         </label>
2048         <ul class="md-nav__list" data-md-scrollfix>
2049
2050
2051
2052
2053
2054
2055     <li class="md-nav__item">
2056       <a href="../../migration/wsc53/php/" class="md-nav__link">
2057         PHP API
2058       </a>
2059     </li>
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069     <li class="md-nav__item">
2070       <a href="../../migration/wsc53/session/" class="md-nav__link">
2071         Session Handling and Authentication
2072       </a>
2073     </li>
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083     <li class="md-nav__item">
2084       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
2085         TypeScript and JavaScript
2086       </a>
2087     </li>
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097     <li class="md-nav__item">
2098       <a href="../../migration/wsc53/templates/" class="md-nav__link">
2099         Templates
2100       </a>
2101     </li>
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111     <li class="md-nav__item">
2112       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2113         Third Party Libraries
2114       </a>
2115     </li>
2116
2117
2118
2119
2120         </ul>
2121       </nav>
2122     </li>
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133     <li class="md-nav__item md-nav__item--nested">
2134
2135
2136
2137
2138       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
2139
2140
2141
2142         <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
2143           From WoltLab Suite 5.2
2144           <span class="md-nav__icon md-icon"></span>
2145         </label>
2146
2147       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
2148         <label class="md-nav__title" for="__nav_6_4">
2149           <span class="md-nav__icon md-icon"></span>
2150           From WoltLab Suite 5.2
2151         </label>
2152         <ul class="md-nav__list" data-md-scrollfix>
2153
2154
2155
2156
2157
2158
2159     <li class="md-nav__item">
2160       <a href="../../migration/wsc52/php/" class="md-nav__link">
2161         PHP API
2162       </a>
2163     </li>
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173     <li class="md-nav__item">
2174       <a href="../../migration/wsc52/templates/" class="md-nav__link">
2175         Templates and Languages
2176       </a>
2177     </li>
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187     <li class="md-nav__item">
2188       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2189         Third Party Libraries
2190       </a>
2191     </li>
2192
2193
2194
2195
2196         </ul>
2197       </nav>
2198     </li>
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209     <li class="md-nav__item md-nav__item--nested">
2210
2211
2212
2213
2214       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
2215
2216
2217
2218         <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
2219           From WoltLab Suite 3.1
2220           <span class="md-nav__icon md-icon"></span>
2221         </label>
2222
2223       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
2224         <label class="md-nav__title" for="__nav_6_5">
2225           <span class="md-nav__icon md-icon"></span>
2226           From WoltLab Suite 3.1
2227         </label>
2228         <ul class="md-nav__list" data-md-scrollfix>
2229
2230
2231
2232
2233
2234
2235     <li class="md-nav__item">
2236       <a href="../../migration/wsc31/php/" class="md-nav__link">
2237         PHP API
2238       </a>
2239     </li>
2240
2241
2242
2243
2244         </ul>
2245       </nav>
2246     </li>
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257     <li class="md-nav__item md-nav__item--nested">
2258
2259
2260
2261
2262       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
2263
2264
2265
2266         <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
2267           From WoltLab Suite 3.0
2268           <span class="md-nav__icon md-icon"></span>
2269         </label>
2270
2271       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
2272         <label class="md-nav__title" for="__nav_6_6">
2273           <span class="md-nav__icon md-icon"></span>
2274           From WoltLab Suite 3.0
2275         </label>
2276         <ul class="md-nav__list" data-md-scrollfix>
2277
2278
2279
2280
2281
2282
2283     <li class="md-nav__item">
2284       <a href="../../migration/wsc30/php/" class="md-nav__link">
2285         PHP API
2286       </a>
2287     </li>
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297     <li class="md-nav__item">
2298       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2299         JavaScript API
2300       </a>
2301     </li>
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311     <li class="md-nav__item">
2312       <a href="../../migration/wsc30/templates/" class="md-nav__link">
2313         Templates
2314       </a>
2315     </li>
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325     <li class="md-nav__item">
2326       <a href="../../migration/wsc30/css/" class="md-nav__link">
2327         CSS
2328       </a>
2329     </li>
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339     <li class="md-nav__item">
2340       <a href="../../migration/wsc30/package/" class="md-nav__link">
2341         Package Components
2342       </a>
2343     </li>
2344
2345
2346
2347
2348         </ul>
2349       </nav>
2350     </li>
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361     <li class="md-nav__item md-nav__item--nested">
2362
2363
2364
2365
2366       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
2367
2368
2369
2370         <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
2371           From WCF 2.1
2372           <span class="md-nav__icon md-icon"></span>
2373         </label>
2374
2375       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
2376         <label class="md-nav__title" for="__nav_6_7">
2377           <span class="md-nav__icon md-icon"></span>
2378           From WCF 2.1
2379         </label>
2380         <ul class="md-nav__list" data-md-scrollfix>
2381
2382
2383
2384
2385
2386
2387     <li class="md-nav__item">
2388       <a href="../../migration/wcf21/php/" class="md-nav__link">
2389         PHP API
2390       </a>
2391     </li>
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401     <li class="md-nav__item">
2402       <a href="../../migration/wcf21/templates/" class="md-nav__link">
2403         Templates
2404       </a>
2405     </li>
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415     <li class="md-nav__item">
2416       <a href="../../migration/wcf21/css/" class="md-nav__link">
2417         CSS
2418       </a>
2419     </li>
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429     <li class="md-nav__item">
2430       <a href="../../migration/wcf21/package/" class="md-nav__link">
2431         Package Components
2432       </a>
2433     </li>
2434
2435
2436
2437
2438         </ul>
2439       </nav>
2440     </li>
2441
2442
2443
2444
2445         </ul>
2446       </nav>
2447     </li>
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459     <li class="md-nav__item md-nav__item--nested">
2460
2461
2462
2463
2464       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
2465
2466
2467
2468         <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
2469           Tutorials
2470           <span class="md-nav__icon md-icon"></span>
2471         </label>
2472
2473       <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
2474         <label class="md-nav__title" for="__nav_7">
2475           <span class="md-nav__icon md-icon"></span>
2476           Tutorials
2477         </label>
2478         <ul class="md-nav__list" data-md-scrollfix>
2479
2480
2481
2482
2483
2484
2485
2486     <li class="md-nav__item md-nav__item--nested">
2487
2488
2489
2490
2491       <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
2492
2493
2494
2495         <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
2496           Tutorial Series
2497           <span class="md-nav__icon md-icon"></span>
2498         </label>
2499
2500       <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
2501         <label class="md-nav__title" for="__nav_7_1">
2502           <span class="md-nav__icon md-icon"></span>
2503           Tutorial Series
2504         </label>
2505         <ul class="md-nav__list" data-md-scrollfix>
2506
2507
2508
2509
2510
2511
2512     <li class="md-nav__item">
2513       <a href="../../tutorial/series/overview/" class="md-nav__link">
2514         Overview
2515       </a>
2516     </li>
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526     <li class="md-nav__item">
2527       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2528         Part 1
2529       </a>
2530     </li>
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540     <li class="md-nav__item">
2541       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2542         Part 2
2543       </a>
2544     </li>
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554     <li class="md-nav__item">
2555       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2556         Part 3
2557       </a>
2558     </li>
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568     <li class="md-nav__item">
2569       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2570         Part 4
2571       </a>
2572     </li>
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582     <li class="md-nav__item">
2583       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2584         Part 5
2585       </a>
2586     </li>
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596     <li class="md-nav__item">
2597       <a href="../../tutorial/series/part_6/" class="md-nav__link">
2598         Part 6
2599       </a>
2600     </li>
2601
2602
2603
2604
2605         </ul>
2606       </nav>
2607     </li>
2608
2609
2610
2611
2612         </ul>
2613       </nav>
2614     </li>
2615
2616
2617
2618   </ul>
2619 </nav>
2620                   </div>
2621                 </div>
2622               </div>
2623
2624
2625
2626               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2627                 <div class="md-sidebar__scrollwrap">
2628                   <div class="md-sidebar__inner">
2629
2630
2631 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2632
2633
2634
2635
2636
2637
2638     <label class="md-nav__title" for="__toc">
2639       <span class="md-nav__icon md-icon"></span>
2640       Table of contents
2641     </label>
2642     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2643
2644         <li class="md-nav__item">
2645   <a href="#database-tables" class="md-nav__link">
2646     Database Tables
2647   </a>
2648
2649 </li>
2650
2651         <li class="md-nav__item">
2652   <a href="#columns" class="md-nav__link">
2653     Columns
2654   </a>
2655
2656 </li>
2657
2658         <li class="md-nav__item">
2659   <a href="#foreign-keys" class="md-nav__link">
2660     Foreign Keys
2661   </a>
2662
2663 </li>
2664
2665         <li class="md-nav__item">
2666   <a href="#indices" class="md-nav__link">
2667     Indices
2668   </a>
2669
2670 </li>
2671
2672     </ul>
2673
2674 </nav>
2675                   </div>
2676                 </div>
2677               </div>
2678
2679
2680
2681             <div class="md-content" data-md-component="content">
2682               <article class="md-content__inner md-typeset">
2683
2684
2685
2686
2687
2688
2689
2690 <h1 id="database-php-api">Database PHP API<a class="headerlink" href="#database-php-api" title="Permanent link">#</a></h1>
2691 <p>While the <a href="../pip/sql/">sql</a> package installation plugin supports adding and removing tables, columns, and indices, it is not able to handle cases where the added table, column, or index already exist.
2692 We have added a new PHP-based API to manipulate the database scheme which can be used in combination with the <a href="../pip/database/">database</a> package installation plugin that skips parts that already exist:</p>
2693 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2694 <span class="normal">2</span>
2695 <span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">return</span> <span class="p">[</span>
2696     <span class="c1">// list of `DatabaseTable` objects</span>
2697 <span class="p">];</span>
2698 </code></pre></div></td></tr></table></div>
2699 <p>All of the relevant components can be found in the <code>wcf\system\database\table</code> namespace.</p>
2700 <h2 id="database-tables">Database Tables<a class="headerlink" href="#database-tables" title="Permanent link">#</a></h2>
2701 <p>There are two classes representing database tables: <code>DatabaseTable</code> and <code>PartialDatabaseTable</code>.
2702 If a new table should be created, use <code>DatabaseTable</code>.
2703 In all other cases, <code>PartialDatabaseTable</code> should be used as it provides an additional save-guard against accidentally creating a new table by having a typo in the table name:
2704 If the tables does not already exist, a table represented by <code>PartialDatabaseTable</code> will cause an exception (while a <code>DatabaseTable</code> table will simply be created).</p>
2705 <p>To create a table, a <code>DatabaseTable</code> object with the table's name as to be created and table's columns, foreign keys and indices have to be specified:</p>
2706 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2707 <span class="normal"> 2</span>
2708 <span class="normal"> 3</span>
2709 <span class="normal"> 4</span>
2710 <span class="normal"> 5</span>
2711 <span class="normal"> 6</span>
2712 <span class="normal"> 7</span>
2713 <span class="normal"> 8</span>
2714 <span class="normal"> 9</span>
2715 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">DatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;foo1_bar&#39;</span><span class="p">)</span>
2716     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2717         <span class="c1">// columns</span>
2718     <span class="p">])</span>
2719     <span class="o">-&gt;</span><span class="na">foreignKeys</span><span class="p">([</span>
2720         <span class="c1">// foreign keys</span>
2721     <span class="p">])</span>
2722     <span class="o">-&gt;</span><span class="na">indices</span><span class="p">([</span>
2723         <span class="c1">// indices</span>
2724     <span class="p">])</span>
2725 </code></pre></div></td></tr></table></div>
2726 <p>To update a table, the same code as above can be used, except for <code>PartialDatabaseTable</code> being used instead of <code>DatabaseTable</code>.</p>
2727 <p>To drop a table, only the <code>drop()</code> method has to be called:</p>
2728 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2729 <span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">PartialDatabaseTable</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;foo1_bar&#39;</span><span class="p">)</span>
2730     <span class="o">-&gt;</span><span class="na">drop</span><span class="p">()</span>
2731 </code></pre></div></td></tr></table></div>
2732 <h2 id="columns">Columns<a class="headerlink" href="#columns" title="Permanent link">#</a></h2>
2733 <p>To represent a column of a database table, you have to create an instance of the relevant column class found in the <code>wcf\system\database\table\column</code> namespace.
2734 Such instances are created similarly to database table objects using the <code>create()</code> factory method and passing the column name as the parameter.</p>
2735 <p>Every column type supports the following methods:</p>
2736 <ul>
2737 <li><code>defaultValue($defaultValue)</code> sets the default value of the column (default: none).</li>
2738 <li><code>drop()</code> to drop the column.</li>
2739 <li><code>notNull($notNull = true)</code> sets if the value of the column can be <code>NULL</code> (default: <code>false</code>).</li>
2740 </ul>
2741 <p>Depending on the specific column class implementing additional interfaces, the following methods are also available:</p>
2742 <ul>
2743 <li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)</code> sets if the value of the colum is auto-incremented.</li>
2744 <li><code>IDecimalsDatabaseTableColumn::decimals($decimals)</code> sets the number of decimals the column supports.</li>
2745 <li><code>IEnumDatabaseTableColumn::enumValues(array $values)</code> sets the predetermined set of valid values of the column.</li>
2746 <li><code>ILengthDatabaseTableColumn::length($length)</code> sets the (maximum) length of the column.</li>
2747 </ul>
2748 <p>Additionally, there are some additionally classes of commonly used columns with specific properties:</p>
2749 <ul>
2750 <li><code>DefaultFalseBooleanDatabaseTableColumn</code> (a <code>tinyint</code> column with length <code>1</code>, default value <code>0</code> and whose values cannot be <code>null</code>)</li>
2751 <li><code>DefaultTrueBooleanDatabaseTableColumn</code> (a <code>tinyint</code> column with length <code>0</code>, default value <code>0</code> and whose values cannot be <code>null</code>)</li>
2752 <li><code>NotNullInt10DatabaseTableColumn</code> (a <code>int</code> column with length <code>10</code> and whose values cannot be <code>null</code>)</li>
2753 <li><code>NotNullVarchar191DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>191</code> and whose values cannot be <code>null</code>)</li>
2754 <li><code>NotNullVarchar255DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>255</code> and whose values cannot be <code>null</code>)</li>
2755 <li><code>ObjectIdDatabaseTableColumn</code> (a <code>int</code> column with length <code>10</code>, whose values cannot be <code>null</code>, and whose values are auto-incremented)</li>
2756 </ul>
2757 <p>Examples:</p>
2758 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2759 <span class="normal">2</span>
2760 <span class="normal">3</span>
2761 <span class="normal">4</span>
2762 <span class="normal">5</span>
2763 <span class="normal">6</span>
2764 <span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">DefaultFalseBooleanDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;isDisabled&#39;</span><span class="p">)</span>
2765
2766 <span class="nx">NotNullInt10DatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;fooTypeID&#39;</span><span class="p">)</span>
2767
2768 <span class="nx">SmallintDatabaseTableColumn</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;bar&#39;</span><span class="p">)</span>
2769     <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
2770     <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">()</span>
2771 </code></pre></div></td></tr></table></div>
2772 <h2 id="foreign-keys">Foreign Keys<a class="headerlink" href="#foreign-keys" title="Permanent link">#</a></h2>
2773 <p>Foreign keys are represented by <code>DatabaseTableForeignKey</code> objects: </p>
2774 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2775 <span class="normal">2</span>
2776 <span class="normal">3</span>
2777 <span class="normal">4</span>
2778 <span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">DatabaseTableForeignKey</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
2779     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
2780     <span class="o">-&gt;</span><span class="na">referencedTable</span><span class="p">(</span><span class="s1">&#39;wcf1_foo&#39;</span><span class="p">)</span>
2781     <span class="o">-&gt;</span><span class="na">referencedColumns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
2782     <span class="o">-&gt;</span><span class="na">onDelete</span><span class="p">(</span><span class="s1">&#39;CASCADE&#39;</span><span class="p">)</span>
2783 </code></pre></div></td></tr></table></div>
2784 <p>The supported actions for <code>onDelete()</code> and <code>onUpdate()</code> are <code>CASCADE</code>, <code>NO ACTION</code>, and <code>SET NULL</code>.
2785 To drop a foreign key, all of the relevant data to create the foreign key has to be present and the <code>drop()</code> method has to be called.</p>
2786 <p><code>DatabaseTableForeignKey::create()</code> also supports the foreign key name as a parameter.
2787 If it is not present, <code>DatabaseTable::foreignKeys()</code> will automatically set one based on the foreign key's data.</p>
2788 <h2 id="indices">Indices<a class="headerlink" href="#indices" title="Permanent link">#</a></h2>
2789 <p>Indices are represented by <code>DatabaseTableIndex</code> objects: </p>
2790 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2791 <span class="normal">2</span>
2792 <span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nx">DatabaseTableIndex</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;fooID&#39;</span><span class="p">)</span>
2793     <span class="o">-&gt;</span><span class="na">type</span><span class="p">(</span><span class="nx">DatabaseTableIndex</span><span class="o">::</span><span class="na">UNIQUE_TYPE</span><span class="p">)</span>
2794     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span><span class="s1">&#39;fooID&#39;</span><span class="p">])</span>
2795 </code></pre></div></td></tr></table></div>
2796 <p>There are four different types: <code>DatabaseTableIndex::DEFAULT_TYPE</code> (default), <code>DatabaseTableIndex::PRIMARY_TYPE</code>, <code>DatabaseTableIndex::UNIQUE_TYPE</code>, and <code>DatabaseTableIndex::FULLTEXT_TYPE</code>.
2797 For primary keys, there is also the <code>DatabaseTablePrimaryIndex</code> class which automatically sets the type to <code>DatabaseTableIndex::PRIMARY_TYPE</code>.
2798 To drop a index, all of the relevant data to create the index has to be present and the <code>drop()</code> method has to be called.</p>
2799 <p>The index name is specified as the parameter to <code>DatabaseTableIndex::create()</code>.
2800 It is strongly recommended to specify an explicit name (<a href="https://github.com/WoltLab/WCF/issues/4505">WoltLab/WCF#4505</a>).
2801 If no name is given, <code>DatabaseTable::indices()</code> will automatically set one based on the index data.</p>
2802
2803   <hr>
2804 <div class="md-source-file">
2805   <small>
2806
2807       Last update:
2808       2022-10-21
2809
2810   </small>
2811 </div>
2812
2813
2814
2815
2816
2817
2818               </article>
2819             </div>
2820
2821
2822         </div>
2823
2824       </main>
2825
2826         <footer class="md-footer">
2827
2828   <div class="md-footer-meta md-typeset">
2829     <div class="md-footer-meta__inner md-grid">
2830       <div class="md-copyright">
2831
2832     <div class="md-copyright__highlight">
2833       Copyright © 2020 WoltLab GmbH
2834     </div>
2835
2836
2837     Made with
2838     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2839       Material for MkDocs
2840     </a>
2841
2842 </div>
2843
2844         <div class="md-copyright">
2845         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2846         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2847 </div>
2848
2849     </div>
2850   </div>
2851 </footer>
2852
2853     </div>
2854     <div class="md-dialog" data-md-component="dialog">
2855       <div class="md-dialog__inner md-typeset"></div>
2856     </div>
2857
2858     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
2859
2860
2861       <script src="../../assets/javascripts/bundle.2a6f1dda.min.js"></script>
2862
2863
2864   </body>
2865 </html>