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.0, mkdocs-material-8.5.4">
  15
  16
  17
  18         <title>Database PHP API - WoltLab Suite Documentation</title>
  19
  20
  21
  22       <link rel="stylesheet" href="../../assets/stylesheets/main.80dcb947.min.css">
  23
  24
  25         <link rel="stylesheet" href="../../assets/stylesheets/palette.cbb835fc.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="" 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           New API
 832           <span class="md-nav__icon md-icon"></span>
 833         </label>
 834
 835       <nav class="md-nav" aria-label="New API" data-md-level="2">
 836         <label class="md-nav__title" for="__nav_4_3">
 837           <span class="md-nav__icon md-icon"></span>
 838           New API
 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/new-api_writing-a-module/" class="md-nav__link">
 849         Writing a module
 850       </a>
 851     </li>
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861     <li class="md-nav__item">
 862       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 863         Data Structures
 864       </a>
 865     </li>
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875     <li class="md-nav__item">
 876       <a href="../../javascript/new-api_core/" class="md-nav__link">
 877         Core Functions
 878       </a>
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 891         DOM
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903     <li class="md-nav__item">
 904       <a href="../../javascript/new-api_events/" class="md-nav__link">
 905         Event Handling
 906       </a>
 907     </li>
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917     <li class="md-nav__item">
 918       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 919         Ajax
 920       </a>
 921     </li>
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931     <li class="md-nav__item">
 932       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 933         Dialogs
 934       </a>
 935     </li>
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945     <li class="md-nav__item">
 946       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 947         Browser and Screen Sizes
 948       </a>
 949     </li>
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959     <li class="md-nav__item">
 960       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 961         User Interface
 962       </a>
 963     </li>
 964
 965
 966
 967
 968         </ul>
 969       </nav>
 970     </li>
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980     <li class="md-nav__item">
 981       <a href="../../javascript/legacy-api/" class="md-nav__link">
 982         Legacy API
 983       </a>
 984     </li>
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994     <li class="md-nav__item">
 995       <a href="../../javascript/helper-functions/" class="md-nav__link">
 996         Helper Functions
 997       </a>
 998     </li>
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008     <li class="md-nav__item">
1009       <a href="../../javascript/code-snippets/" class="md-nav__link">
1010         Code Snippets
1011       </a>
1012     </li>
1013
1014
1015
1016
1017         </ul>
1018       </nav>
1019     </li>
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1034
1035
1036         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
1037
1038
1039
1040
1041         <label class="md-nav__link" for="__nav_5">
1042           Package Components
1043           <span class="md-nav__icon md-icon"></span>
1044         </label>
1045
1046       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1047         <label class="md-nav__title" for="__nav_5">
1048           <span class="md-nav__icon md-icon"></span>
1049           Package Components
1050         </label>
1051         <ul class="md-nav__list" data-md-scrollfix>
1052
1053
1054
1055
1056
1057
1058     <li class="md-nav__item">
1059       <a href="../package-xml/" class="md-nav__link">
1060         package.xml
1061       </a>
1062     </li>
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073     <li class="md-nav__item md-nav__item--nested">
1074
1075
1076         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1077
1078
1079
1080
1081         <label class="md-nav__link" for="__nav_5_2">
1082           PIPs
1083           <span class="md-nav__icon md-icon"></span>
1084         </label>
1085
1086       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1087         <label class="md-nav__title" for="__nav_5_2">
1088           <span class="md-nav__icon md-icon"></span>
1089           PIPs
1090         </label>
1091         <ul class="md-nav__list" data-md-scrollfix>
1092
1093
1094
1095
1096
1097
1098     <li class="md-nav__item">
1099       <a href="../pip/" class="md-nav__link">
1100         Overview
1101       </a>
1102     </li>
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112     <li class="md-nav__item">
1113       <a href="../pip/acl-option/" class="md-nav__link">
1114         aclOption
1115       </a>
1116     </li>
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126     <li class="md-nav__item">
1127       <a href="../pip/acp-menu/" class="md-nav__link">
1128         acpMenu
1129       </a>
1130     </li>
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140     <li class="md-nav__item">
1141       <a href="../pip/acp-search-provider/" class="md-nav__link">
1142         acpSearchProvider
1143       </a>
1144     </li>
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154     <li class="md-nav__item">
1155       <a href="../pip/acp-template/" class="md-nav__link">
1156         acpTemplate
1157       </a>
1158     </li>
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168     <li class="md-nav__item">
1169       <a href="../pip/acp-template-delete/" class="md-nav__link">
1170         acpTemplateDelete
1171       </a>
1172     </li>
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182     <li class="md-nav__item">
1183       <a href="../pip/bbcode/" class="md-nav__link">
1184         bbcode
1185       </a>
1186     </li>
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196     <li class="md-nav__item">
1197       <a href="../pip/box/" class="md-nav__link">
1198         box
1199       </a>
1200     </li>
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210     <li class="md-nav__item">
1211       <a href="../pip/clipboard-action/" class="md-nav__link">
1212         clipboardAction
1213       </a>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224     <li class="md-nav__item">
1225       <a href="../pip/core-object/" class="md-nav__link">
1226         coreObject
1227       </a>
1228     </li>
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238     <li class="md-nav__item">
1239       <a href="../pip/cronjob/" class="md-nav__link">
1240         cronjob
1241       </a>
1242     </li>
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252     <li class="md-nav__item">
1253       <a href="../pip/database/" class="md-nav__link">
1254         database
1255       </a>
1256     </li>
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../pip/event-listener/" class="md-nav__link">
1268         eventListener
1269       </a>
1270     </li>
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280     <li class="md-nav__item">
1281       <a href="../pip/file/" class="md-nav__link">
1282         file
1283       </a>
1284     </li>
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294     <li class="md-nav__item">
1295       <a href="../pip/file-delete/" class="md-nav__link">
1296         fileDelete
1297       </a>
1298     </li>
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../pip/language/" class="md-nav__link">
1310         language
1311       </a>
1312     </li>
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322     <li class="md-nav__item">
1323       <a href="../pip/media-provider/" class="md-nav__link">
1324         mediaProvider
1325       </a>
1326     </li>
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336     <li class="md-nav__item">
1337       <a href="../pip/menu/" class="md-nav__link">
1338         menu
1339       </a>
1340     </li>
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350     <li class="md-nav__item">
1351       <a href="../pip/menu-item/" class="md-nav__link">
1352         menuItem
1353       </a>
1354     </li>
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364     <li class="md-nav__item">
1365       <a href="../pip/object-type/" class="md-nav__link">
1366         objectType
1367       </a>
1368     </li>
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378     <li class="md-nav__item">
1379       <a href="../pip/object-type-definition/" class="md-nav__link">
1380         objectTypeDefinition
1381       </a>
1382     </li>
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392     <li class="md-nav__item">
1393       <a href="../pip/option/" class="md-nav__link">
1394         option
1395       </a>
1396     </li>
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406     <li class="md-nav__item">
1407       <a href="../pip/page/" class="md-nav__link">
1408         page
1409       </a>
1410     </li>
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420     <li class="md-nav__item">
1421       <a href="../pip/pip/" class="md-nav__link">
1422         pip
1423       </a>
1424     </li>
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434     <li class="md-nav__item">
1435       <a href="../pip/script/" class="md-nav__link">
1436         script
1437       </a>
1438     </li>
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448     <li class="md-nav__item">
1449       <a href="../pip/smiley/" class="md-nav__link">
1450         smiley
1451       </a>
1452     </li>
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462     <li class="md-nav__item">
1463       <a href="../pip/sql/" class="md-nav__link">
1464         sql
1465       </a>
1466     </li>
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476     <li class="md-nav__item">
1477       <a href="../pip/style/" class="md-nav__link">
1478         style
1479       </a>
1480     </li>
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490     <li class="md-nav__item">
1491       <a href="../pip/template/" class="md-nav__link">
1492         template
1493       </a>
1494     </li>
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504     <li class="md-nav__item">
1505       <a href="../pip/template-delete/" class="md-nav__link">
1506         templateDelete
1507       </a>
1508     </li>
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518     <li class="md-nav__item">
1519       <a href="../pip/template-listener/" class="md-nav__link">
1520         templateListener
1521       </a>
1522     </li>
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532     <li class="md-nav__item">
1533       <a href="../pip/user-group-option/" class="md-nav__link">
1534         userGroupOption
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../pip/user-menu/" class="md-nav__link">
1548         userMenu
1549       </a>
1550     </li>
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560     <li class="md-nav__item">
1561       <a href="../pip/user-notification-event/" class="md-nav__link">
1562         userNotificationEvent
1563       </a>
1564     </li>
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574     <li class="md-nav__item">
1575       <a href="../pip/user-option/" class="md-nav__link">
1576         userOption
1577       </a>
1578     </li>
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588     <li class="md-nav__item">
1589       <a href="../pip/user-profile-menu/" class="md-nav__link">
1590         userProfileMenu
1591       </a>
1592     </li>
1593
1594
1595
1596
1597         </ul>
1598       </nav>
1599     </li>
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611     <li class="md-nav__item md-nav__item--active">
1612
1613       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1614
1615
1616
1617
1618
1619         <label class="md-nav__link md-nav__link--active" for="__toc">
1620           Database PHP API
1621           <span class="md-nav__icon md-icon"></span>
1622         </label>
1623
1624       <a href="./" class="md-nav__link md-nav__link--active">
1625         Database PHP API
1626       </a>
1627
1628
1629
1630 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1631
1632
1633
1634
1635
1636
1637     <label class="md-nav__title" for="__toc">
1638       <span class="md-nav__icon md-icon"></span>
1639       Table of contents
1640     </label>
1641     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1642
1643         <li class="md-nav__item">
1644   <a href="#database-tables" class="md-nav__link">
1645     Database Tables
1646   </a>
1647
1648 </li>
1649
1650         <li class="md-nav__item">
1651   <a href="#columns" class="md-nav__link">
1652     Columns
1653   </a>
1654
1655 </li>
1656
1657         <li class="md-nav__item">
1658   <a href="#foreign-keys" class="md-nav__link">
1659     Foreign Keys
1660   </a>
1661
1662 </li>
1663
1664         <li class="md-nav__item">
1665   <a href="#indices" class="md-nav__link">
1666     Indices
1667   </a>
1668
1669 </li>
1670
1671     </ul>
1672
1673 </nav>
1674
1675     </li>
1676
1677
1678
1679
1680         </ul>
1681       </nav>
1682     </li>
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694     <li class="md-nav__item md-nav__item--nested">
1695
1696
1697         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1698
1699
1700
1701
1702         <label class="md-nav__link" for="__nav_6">
1703           Migration
1704           <span class="md-nav__icon md-icon"></span>
1705         </label>
1706
1707       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1708         <label class="md-nav__title" for="__nav_6">
1709           <span class="md-nav__icon md-icon"></span>
1710           Migration
1711         </label>
1712         <ul class="md-nav__list" data-md-scrollfix>
1713
1714
1715
1716
1717
1718
1719
1720     <li class="md-nav__item md-nav__item--nested">
1721
1722
1723         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1724
1725
1726
1727
1728         <label class="md-nav__link" for="__nav_6_1">
1729           From WoltLab Suite 5.5
1730           <span class="md-nav__icon md-icon"></span>
1731         </label>
1732
1733       <nav class="md-nav" aria-label="From WoltLab Suite 5.5" data-md-level="2">
1734         <label class="md-nav__title" for="__nav_6_1">
1735           <span class="md-nav__icon md-icon"></span>
1736           From WoltLab Suite 5.5
1737         </label>
1738         <ul class="md-nav__list" data-md-scrollfix>
1739
1740
1741
1742
1743
1744
1745     <li class="md-nav__item">
1746       <a href="../../migration/wsc55/php/" class="md-nav__link">
1747         PHP API
1748       </a>
1749     </li>
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759     <li class="md-nav__item">
1760       <a href="../../migration/wsc55/javascript/" class="md-nav__link">
1761         TypeScript and JavaScript
1762       </a>
1763     </li>
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773     <li class="md-nav__item">
1774       <a href="../../migration/wsc55/templates/" class="md-nav__link">
1775         Templates
1776       </a>
1777     </li>
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787     <li class="md-nav__item">
1788       <a href="../../migration/wsc55/icons/" class="md-nav__link">
1789         Icons
1790       </a>
1791     </li>
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801     <li class="md-nav__item">
1802       <a href="../../migration/wsc55/libraries/" class="md-nav__link">
1803         Third Party Libraries
1804       </a>
1805     </li>
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815     <li class="md-nav__item">
1816       <a href="../../migration/wsc55/deprecations_removals/" class="md-nav__link">
1817         Deprecations and Removals
1818       </a>
1819     </li>
1820
1821
1822
1823
1824         </ul>
1825       </nav>
1826     </li>
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837     <li class="md-nav__item md-nav__item--nested">
1838
1839
1840         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1841
1842
1843
1844
1845         <label class="md-nav__link" for="__nav_6_2">
1846           From WoltLab Suite 5.4
1847           <span class="md-nav__icon md-icon"></span>
1848         </label>
1849
1850       <nav class="md-nav" aria-label="From WoltLab Suite 5.4" data-md-level="2">
1851         <label class="md-nav__title" for="__nav_6_2">
1852           <span class="md-nav__icon md-icon"></span>
1853           From WoltLab Suite 5.4
1854         </label>
1855         <ul class="md-nav__list" data-md-scrollfix>
1856
1857
1858
1859
1860
1861
1862     <li class="md-nav__item">
1863       <a href="../../migration/wsc54/php/" class="md-nav__link">
1864         PHP API
1865       </a>
1866     </li>
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876     <li class="md-nav__item">
1877       <a href="../../migration/wsc54/javascript/" class="md-nav__link">
1878         TypeScript and JavaScript
1879       </a>
1880     </li>
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890     <li class="md-nav__item">
1891       <a href="../../migration/wsc54/templates/" class="md-nav__link">
1892         Templates
1893       </a>
1894     </li>
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904     <li class="md-nav__item">
1905       <a href="../../migration/wsc54/libraries/" class="md-nav__link">
1906         Third Party Libraries
1907       </a>
1908     </li>
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918     <li class="md-nav__item">
1919       <a href="../../migration/wsc54/deprecations_removals/" class="md-nav__link">
1920         Deprecations and Removals
1921       </a>
1922     </li>
1923
1924
1925
1926
1927         </ul>
1928       </nav>
1929     </li>
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940     <li class="md-nav__item md-nav__item--nested">
1941
1942
1943         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1944
1945
1946
1947
1948         <label class="md-nav__link" for="__nav_6_3">
1949           From WoltLab Suite 5.3
1950           <span class="md-nav__icon md-icon"></span>
1951         </label>
1952
1953       <nav class="md-nav" aria-label="From WoltLab Suite 5.3" data-md-level="2">
1954         <label class="md-nav__title" for="__nav_6_3">
1955           <span class="md-nav__icon md-icon"></span>
1956           From WoltLab Suite 5.3
1957         </label>
1958         <ul class="md-nav__list" data-md-scrollfix>
1959
1960
1961
1962
1963
1964
1965     <li class="md-nav__item">
1966       <a href="../../migration/wsc53/php/" class="md-nav__link">
1967         PHP API
1968       </a>
1969     </li>
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979     <li class="md-nav__item">
1980       <a href="../../migration/wsc53/session/" class="md-nav__link">
1981         Session Handling and Authentication
1982       </a>
1983     </li>
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993     <li class="md-nav__item">
1994       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1995         TypeScript and JavaScript
1996       </a>
1997     </li>
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007     <li class="md-nav__item">
2008       <a href="../../migration/wsc53/templates/" class="md-nav__link">
2009         Templates
2010       </a>
2011     </li>
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021     <li class="md-nav__item">
2022       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
2023         Third Party Libraries
2024       </a>
2025     </li>
2026
2027
2028
2029
2030         </ul>
2031       </nav>
2032     </li>
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043     <li class="md-nav__item md-nav__item--nested">
2044
2045
2046         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
2047
2048
2049
2050
2051         <label class="md-nav__link" for="__nav_6_4">
2052           From WoltLab Suite 5.2
2053           <span class="md-nav__icon md-icon"></span>
2054         </label>
2055
2056       <nav class="md-nav" aria-label="From WoltLab Suite 5.2" data-md-level="2">
2057         <label class="md-nav__title" for="__nav_6_4">
2058           <span class="md-nav__icon md-icon"></span>
2059           From WoltLab Suite 5.2
2060         </label>
2061         <ul class="md-nav__list" data-md-scrollfix>
2062
2063
2064
2065
2066
2067
2068     <li class="md-nav__item">
2069       <a href="../../migration/wsc52/php/" class="md-nav__link">
2070         PHP API
2071       </a>
2072     </li>
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082     <li class="md-nav__item">
2083       <a href="../../migration/wsc52/templates/" class="md-nav__link">
2084         Templates and Languages
2085       </a>
2086     </li>
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096     <li class="md-nav__item">
2097       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
2098         Third Party Libraries
2099       </a>
2100     </li>
2101
2102
2103
2104
2105         </ul>
2106       </nav>
2107     </li>
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118     <li class="md-nav__item md-nav__item--nested">
2119
2120
2121         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
2122
2123
2124
2125
2126         <label class="md-nav__link" for="__nav_6_5">
2127           From WoltLab Suite 3.1
2128           <span class="md-nav__icon md-icon"></span>
2129         </label>
2130
2131       <nav class="md-nav" aria-label="From WoltLab Suite 3.1" data-md-level="2">
2132         <label class="md-nav__title" for="__nav_6_5">
2133           <span class="md-nav__icon md-icon"></span>
2134           From WoltLab Suite 3.1
2135         </label>
2136         <ul class="md-nav__list" data-md-scrollfix>
2137
2138
2139
2140
2141
2142
2143     <li class="md-nav__item">
2144       <a href="../../migration/wsc31/php/" class="md-nav__link">
2145         PHP API
2146       </a>
2147     </li>
2148
2149
2150
2151
2152         </ul>
2153       </nav>
2154     </li>
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165     <li class="md-nav__item md-nav__item--nested">
2166
2167
2168         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_6" type="checkbox" id="__nav_6_6" >
2169
2170
2171
2172
2173         <label class="md-nav__link" for="__nav_6_6">
2174           From WoltLab Suite 3.0
2175           <span class="md-nav__icon md-icon"></span>
2176         </label>
2177
2178       <nav class="md-nav" aria-label="From WoltLab Suite 3.0" data-md-level="2">
2179         <label class="md-nav__title" for="__nav_6_6">
2180           <span class="md-nav__icon md-icon"></span>
2181           From WoltLab Suite 3.0
2182         </label>
2183         <ul class="md-nav__list" data-md-scrollfix>
2184
2185
2186
2187
2188
2189
2190     <li class="md-nav__item">
2191       <a href="../../migration/wsc30/php/" class="md-nav__link">
2192         PHP API
2193       </a>
2194     </li>
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204     <li class="md-nav__item">
2205       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
2206         JavaScript API
2207       </a>
2208     </li>
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218     <li class="md-nav__item">
2219       <a href="../../migration/wsc30/templates/" class="md-nav__link">
2220         Templates
2221       </a>
2222     </li>
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232     <li class="md-nav__item">
2233       <a href="../../migration/wsc30/css/" class="md-nav__link">
2234         CSS
2235       </a>
2236     </li>
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246     <li class="md-nav__item">
2247       <a href="../../migration/wsc30/package/" class="md-nav__link">
2248         Package Components
2249       </a>
2250     </li>
2251
2252
2253
2254
2255         </ul>
2256       </nav>
2257     </li>
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268     <li class="md-nav__item md-nav__item--nested">
2269
2270
2271         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_7" type="checkbox" id="__nav_6_7" >
2272
2273
2274
2275
2276         <label class="md-nav__link" for="__nav_6_7">
2277           From WCF 2.1
2278           <span class="md-nav__icon md-icon"></span>
2279         </label>
2280
2281       <nav class="md-nav" aria-label="From WCF 2.1" data-md-level="2">
2282         <label class="md-nav__title" for="__nav_6_7">
2283           <span class="md-nav__icon md-icon"></span>
2284           From WCF 2.1
2285         </label>
2286         <ul class="md-nav__list" data-md-scrollfix>
2287
2288
2289
2290
2291
2292
2293     <li class="md-nav__item">
2294       <a href="../../migration/wcf21/php/" class="md-nav__link">
2295         PHP API
2296       </a>
2297     </li>
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307     <li class="md-nav__item">
2308       <a href="../../migration/wcf21/templates/" class="md-nav__link">
2309         Templates
2310       </a>
2311     </li>
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321     <li class="md-nav__item">
2322       <a href="../../migration/wcf21/css/" class="md-nav__link">
2323         CSS
2324       </a>
2325     </li>
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335     <li class="md-nav__item">
2336       <a href="../../migration/wcf21/package/" class="md-nav__link">
2337         Package Components
2338       </a>
2339     </li>
2340
2341
2342
2343
2344         </ul>
2345       </nav>
2346     </li>
2347
2348
2349
2350
2351         </ul>
2352       </nav>
2353     </li>
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365     <li class="md-nav__item md-nav__item--nested">
2366
2367
2368         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
2369
2370
2371
2372
2373         <label class="md-nav__link" for="__nav_7">
2374           Tutorials
2375           <span class="md-nav__icon md-icon"></span>
2376         </label>
2377
2378       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
2379         <label class="md-nav__title" for="__nav_7">
2380           <span class="md-nav__icon md-icon"></span>
2381           Tutorials
2382         </label>
2383         <ul class="md-nav__list" data-md-scrollfix>
2384
2385
2386
2387
2388
2389
2390
2391     <li class="md-nav__item md-nav__item--nested">
2392
2393
2394         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
2395
2396
2397
2398
2399         <label class="md-nav__link" for="__nav_7_1">
2400           Tutorial Series
2401           <span class="md-nav__icon md-icon"></span>
2402         </label>
2403
2404       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
2405         <label class="md-nav__title" for="__nav_7_1">
2406           <span class="md-nav__icon md-icon"></span>
2407           Tutorial Series
2408         </label>
2409         <ul class="md-nav__list" data-md-scrollfix>
2410
2411
2412
2413
2414
2415
2416     <li class="md-nav__item">
2417       <a href="../../tutorial/series/overview/" class="md-nav__link">
2418         Overview
2419       </a>
2420     </li>
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430     <li class="md-nav__item">
2431       <a href="../../tutorial/series/part_1/" class="md-nav__link">
2432         Part 1
2433       </a>
2434     </li>
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444     <li class="md-nav__item">
2445       <a href="../../tutorial/series/part_2/" class="md-nav__link">
2446         Part 2
2447       </a>
2448     </li>
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458     <li class="md-nav__item">
2459       <a href="../../tutorial/series/part_3/" class="md-nav__link">
2460         Part 3
2461       </a>
2462     </li>
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472     <li class="md-nav__item">
2473       <a href="../../tutorial/series/part_4/" class="md-nav__link">
2474         Part 4
2475       </a>
2476     </li>
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486     <li class="md-nav__item">
2487       <a href="../../tutorial/series/part_5/" class="md-nav__link">
2488         Part 5
2489       </a>
2490     </li>
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500     <li class="md-nav__item">
2501       <a href="../../tutorial/series/part_6/" class="md-nav__link">
2502         Part 6
2503       </a>
2504     </li>
2505
2506
2507
2508
2509         </ul>
2510       </nav>
2511     </li>
2512
2513
2514
2515
2516         </ul>
2517       </nav>
2518     </li>
2519
2520
2521
2522   </ul>
2523 </nav>
2524                   </div>
2525                 </div>
2526               </div>
2527
2528
2529
2530               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2531                 <div class="md-sidebar__scrollwrap">
2532                   <div class="md-sidebar__inner">
2533
2534
2535 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2536
2537
2538
2539
2540
2541
2542     <label class="md-nav__title" for="__toc">
2543       <span class="md-nav__icon md-icon"></span>
2544       Table of contents
2545     </label>
2546     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2547
2548         <li class="md-nav__item">
2549   <a href="#database-tables" class="md-nav__link">
2550     Database Tables
2551   </a>
2552
2553 </li>
2554
2555         <li class="md-nav__item">
2556   <a href="#columns" class="md-nav__link">
2557     Columns
2558   </a>
2559
2560 </li>
2561
2562         <li class="md-nav__item">
2563   <a href="#foreign-keys" class="md-nav__link">
2564     Foreign Keys
2565   </a>
2566
2567 </li>
2568
2569         <li class="md-nav__item">
2570   <a href="#indices" class="md-nav__link">
2571     Indices
2572   </a>
2573
2574 </li>
2575
2576     </ul>
2577
2578 </nav>
2579                   </div>
2580                 </div>
2581               </div>
2582
2583
2584
2585             <div class="md-content" data-md-component="content">
2586               <article class="md-content__inner md-typeset">
2587
2588
2589
2590   <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">
2591
2592     <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>
2593   </a>
2594
2595
2596 <h1 id="database-php-api">Database PHP API<a class="headerlink" href="#database-php-api" title="Permanent link">#</a></h1>
2597 <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.
2598 We have added a new PHP-based API to manipulate the database scheme which can be used in combination with the <a href="../pip/script/">script</a> package installation plugin that skips parts that already exist:</p>
2599 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2600 <span class="normal"> 2</span>
2601 <span class="normal"> 3</span>
2602 <span class="normal"> 4</span>
2603 <span class="normal"> 5</span>
2604 <span class="normal"> 6</span>
2605 <span class="normal"> 7</span>
2606 <span class="normal"> 8</span>
2607 <span class="normal"> 9</span>
2608 <span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nv">$tables</span> <span class="o">=</span> <span class="p">[</span>
2609     <span class="c1">// list of `DatabaseTable` objects</span>
2610 <span class="p">];</span>
2611
2612 <span class="p">(</span><span class="k">new</span> <span class="nx">DatabaseTableChangeProcessor</span><span class="p">(</span>
2613     <span class="sd">/** @var ScriptPackageInstallationPlugin $this */</span>
2614     <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">installation</span><span class="o">-&gt;</span><span class="na">getPackage</span><span class="p">(),</span>
2615     <span class="nv">$tables</span><span class="p">,</span>
2616     <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getEditor</span><span class="p">())</span>
2617 <span class="p">)</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">();</span>
2618 </code></pre></div></td></tr></table></div>
2619 <p>All of the relevant components can be found in the <code>wcf\system\database\table</code> namespace.</p>
2620 <p>With WoltLab Suite 5.4, you should use the new <a href="../pip/database/">database</a> package installation plugin for which you only have to return the array of affected database tables:</p>
2621 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2622 <span class="normal">2</span>
2623 <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>
2624     <span class="c1">// list of `DatabaseTable` objects</span>
2625 <span class="p">];</span>
2626 </code></pre></div></td></tr></table></div>
2627 <h2 id="database-tables">Database Tables<a class="headerlink" href="#database-tables" title="Permanent link">#</a></h2>
2628 <p>There are two classes representing database tables: <code>DatabaseTable</code> and <code>PartialDatabaseTable</code>.
2629 If a new table should be created, use <code>DatabaseTable</code>.
2630 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:
2631 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>
2632 <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>
2633 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
2634 <span class="normal"> 2</span>
2635 <span class="normal"> 3</span>
2636 <span class="normal"> 4</span>
2637 <span class="normal"> 5</span>
2638 <span class="normal"> 6</span>
2639 <span class="normal"> 7</span>
2640 <span class="normal"> 8</span>
2641 <span class="normal"> 9</span>
2642 <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>
2643     <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2644         <span class="c1">// columns</span>
2645     <span class="p">])</span>
2646     <span class="o">-&gt;</span><span class="na">foreignKeys</span><span class="p">([</span>
2647         <span class="c1">// foreign keys</span>
2648     <span class="p">])</span>
2649     <span class="o">-&gt;</span><span class="na">indices</span><span class="p">([</span>
2650         <span class="c1">// indices</span>
2651     <span class="p">])</span>
2652 </code></pre></div></td></tr></table></div>
2653 <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>
2654 <p>To drop a table, only the <code>drop()</code> method has to be called:</p>
2655 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2656 <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>
2657     <span class="o">-&gt;</span><span class="na">drop</span><span class="p">()</span>
2658 </code></pre></div></td></tr></table></div>
2659 <h2 id="columns">Columns<a class="headerlink" href="#columns" title="Permanent link">#</a></h2>
2660 <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.
2661 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>
2662 <p>Every column type supports the following methods:</p>
2663 <ul>
2664 <li><code>defaultValue($defaultValue)</code> sets the default value of the column (default: none).</li>
2665 <li><code>drop()</code> to drop the column.</li>
2666 <li><code>notNull($notNull = true)</code> sets if the value of the column can be <code>NULL</code> (default: <code>false</code>).</li>
2667 </ul>
2668 <p>Depending on the specific column class implementing additional interfaces, the following methods are also available:</p>
2669 <ul>
2670 <li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)</code> sets if the value of the colum is auto-incremented.</li>
2671 <li><code>IDecimalsDatabaseTableColumn::decimals($decimals)</code> sets the number of decimals the column supports.</li>
2672 <li><code>IEnumDatabaseTableColumn::enumValues(array $values)</code> sets the predetermined set of valid values of the column.</li>
2673 <li><code>ILengthDatabaseTableColumn::length($length)</code> sets the (maximum) length of the column.</li>
2674 </ul>
2675 <p>Additionally, there are some additionally classes of commonly used columns with specific properties:</p>
2676 <ul>
2677 <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>
2678 <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>
2679 <li><code>NotNullInt10DatabaseTableColumn</code> (a <code>int</code> column with length <code>10</code> and whose values cannot be <code>null</code>)</li>
2680 <li><code>NotNullVarchar191DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>191</code> and whose values cannot be <code>null</code>)</li>
2681 <li><code>NotNullVarchar255DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>255</code> and whose values cannot be <code>null</code>)</li>
2682 <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>
2683 </ul>
2684 <p>Examples:</p>
2685 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2686 <span class="normal">2</span>
2687 <span class="normal">3</span>
2688 <span class="normal">4</span>
2689 <span class="normal">5</span>
2690 <span class="normal">6</span>
2691 <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>
2692
2693 <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>
2694
2695 <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>
2696     <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
2697     <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">()</span>
2698 </code></pre></div></td></tr></table></div>
2699 <h2 id="foreign-keys">Foreign Keys<a class="headerlink" href="#foreign-keys" title="Permanent link">#</a></h2>
2700 <p>Foreign keys are represented by <code>DatabaseTableForeignKey</code> objects: </p>
2701 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2702 <span class="normal">2</span>
2703 <span class="normal">3</span>
2704 <span class="normal">4</span>
2705 <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>
2706     <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>
2707     <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>
2708     <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>
2709     <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>
2710 </code></pre></div></td></tr></table></div>
2711 <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>.
2712 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>
2713 <p><code>DatabaseTableForeignKey::create()</code> also supports the foreign key name as a parameter.
2714 If it is not present, <code>DatabaseTable::foreignKeys()</code> will automatically set one based on the foreign key's data.</p>
2715 <h2 id="indices">Indices<a class="headerlink" href="#indices" title="Permanent link">#</a></h2>
2716 <p>Indices are represented by <code>DatabaseTableIndex</code> objects: </p>
2717 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
2718 <span class="normal">2</span>
2719 <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>
2720     <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>
2721     <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>
2722 </code></pre></div></td></tr></table></div>
2723 <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>.
2724 For primary keys, there is also the <code>DatabaseTablePrimaryIndex</code> class which automatically sets the type to <code>DatabaseTableIndex::PRIMARY_TYPE</code>.
2725 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>
2726 <p><code>DatabaseTableIndex::create()</code> also supports the index name as a parameter.
2727 If it is not present, <code>DatabaseTable::indices()</code> will automatically set one based on the index data.</p>
2728
2729   <hr>
2730 <div class="md-source-file">
2731   <small>
2732
2733       Last update:
2734       2021-10-20
2735
2736   </small>
2737 </div>
2738
2739
2740
2741
2742
2743
2744               </article>
2745             </div>
2746
2747
2748         </div>
2749
2750       </main>
2751
2752         <footer class="md-footer">
2753
2754
2755     <nav class="md-footer__inner md-grid" aria-label="Footer" >
2756
2757
2758         <a href="../pip/user-profile-menu/" class="md-footer__link md-footer__link--prev" aria-label="Previous: userProfileMenu" rel="prev">
2759           <div class="md-footer__button md-icon">
2760             <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>
2761           </div>
2762           <div class="md-footer__title">
2763             <div class="md-ellipsis">
2764               <span class="md-footer__direction">
2765                 Previous
2766               </span>
2767               userProfileMenu
2768             </div>
2769           </div>
2770         </a>
2771
2772
2773
2774         <a href="../../migration/wsc55/php/" class="md-footer__link md-footer__link--next" aria-label="Next: PHP API" rel="next">
2775           <div class="md-footer__title">
2776             <div class="md-ellipsis">
2777               <span class="md-footer__direction">
2778                 Next
2779               </span>
2780               PHP API
2781             </div>
2782           </div>
2783           <div class="md-footer__button md-icon">
2784             <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>
2785           </div>
2786         </a>
2787
2788     </nav>
2789
2790   <div class="md-footer-meta md-typeset">
2791     <div class="md-footer-meta__inner md-grid">
2792       <div class="md-copyright">
2793
2794     <div class="md-copyright__highlight">
2795       Copyright © 2020 WoltLab GmbH
2796     </div>
2797
2798
2799     Made with
2800     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2801       Material for MkDocs
2802     </a>
2803
2804 </div>
2805
2806         <div class="md-copyright">
2807         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2808         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2809 </div>
2810
2811     </div>
2812   </div>
2813 </footer>
2814
2815     </div>
2816     <div class="md-dialog" data-md-component="dialog">
2817       <div class="md-dialog__inner md-typeset"></div>
2818     </div>
2819
2820     <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tracking"], "search": "../../assets/javascripts/workers/search.5bf1dace.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>
2821
2822
2823       <script src="../../assets/javascripts/bundle.078830c0.min.js"></script>
2824
2825
2826   </body>
2827 </html>