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