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