projects / GitHub / WoltLab / woltlab.github.io.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Deployed 59ff7f1 to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 5.4 / package / database-php-api / index.html
CommitLineData
45ca63d0
TD		 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
fb962f09
WG		 12 <link rel="icon" href="../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.1.0">
45ca63d0
TD		 14
15
16
17 <title>Database PHP API - WoltLab Suite Documentation</title>
18
19
20
fb962f09 21 <link rel="stylesheet" href="../../assets/stylesheets/main.33e2939f.min.css">
45ca63d0
TD		 22
23
fb962f09 24 <link rel="stylesheet" href="../../assets/stylesheets/palette.ef6f36e2.min.css">
45ca63d0
TD		 25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
fd8430cb
WG		 34
35
45ca63d0
TD		 36
37
38 <link rel="stylesheet" href="../../stylesheets/extra.css">
39
40
41
42
43
44 </head>
45
46
47
48
49
50
51
52 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
45ca63d0
TD		 53
54
fb962f09
WG		 55 <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script>
56
45ca63d0
TD		 57 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
58 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
59 <label class="md-overlay" for="__drawer"></label>
60 <div data-md-component="skip">
61
62
63 <a href="#database-php-api" class="md-skip">
64 Skip to content
65 </a>
66
67 </div>
68 <div data-md-component="announce">
69
70 <aside class="md-announce">
71 <div class="md-announce__inner md-grid md-typeset">
72
73 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
74
75 </div>
76 </aside>
77
78 </div>
79
fb962f09 80 <header class="md-header" data-md-component="header">
45ca63d0 81 <nav class="md-header__inner md-grid" aria-label="Header">
fb962f09 82 <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD		 83
84 <img src="../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 Database PHP API
101
102 </span>
103 </div>
104 </div>
45ca63d0
TD		 105 </div>
106
fb962f09
WG		 107
108
a3639e76
WG		 109 <label class="md-header__button md-icon" for="__search">
110 <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>
111 </label>
112
113<div class="md-search" data-md-component="search" role="dialog">
114 <label class="md-search__overlay" for="__search"></label>
115 <div class="md-search__inner" role="search">
116 <form class="md-search__form" name="search">
117 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
118 <label class="md-search__icon md-icon" for="__search">
119 <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>
120 <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>
121 </label>
122 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
fb962f09 123 <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>
a3639e76
WG		 124 </button>
125 </form>
126 <div class="md-search__output">
127 <div class="md-search__scrollwrap" data-md-scrollfix>
128 <div class="md-search-result" data-md-component="search-result">
129 <div class="md-search-result__meta">
130 Initializing search
131 </div>
132 <ol class="md-search-result__list"></ol>
133 </div>
134 </div>
135 </div>
136 </div>
137</div>
138
45ca63d0 139
7124f4cb
WG		 140 <div class="md-header__source">
141
142<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
143 <div class="md-source__icon md-icon">
144
fb962f09 145 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
7124f4cb
WG		 146 </div>
147 <div class="md-source__repository">
148 GitHub
149 </div>
150</a>
151 </div>
152
45ca63d0
TD		 153 </nav>
154</header>
155
156 <div class="md-container" data-md-component="container">
157
158
159
160
161 <main class="md-main" data-md-component="main">
162 <div class="md-main__inner md-grid">
163
164
165
166 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
167 <div class="md-sidebar__scrollwrap">
168 <div class="md-sidebar__inner">
169
170
171
45ca63d0
TD		 172<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
173 <label class="md-nav__title" for="__drawer">
fb962f09 174 <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
45ca63d0
TD		 175
176 <img src="../../assets/logo.png" alt="logo">
177
178 </a>
179 WoltLab Suite Documentation
180 </label>
181
7124f4cb
WG		 182 <div class="md-nav__source">
183
184<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
185 <div class="md-source__icon md-icon">
186
fb962f09 187 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
7124f4cb
WG		 188 </div>
189 <div class="md-source__repository">
190 GitHub
191 </div>
192</a>
193 </div>
194
45ca63d0
TD		 195 <ul class="md-nav__list" data-md-scrollfix>
196
197
198
199
200
201
202
203
204 <li class="md-nav__item">
205 <a href="../../getting-started/" class="md-nav__link">
206 Getting Started
207 </a>
208 </li>
209
210
211
212
213
214
215
216
217
218
219
220 <li class="md-nav__item md-nav__item--nested">
221
222
223 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
224
225 <label class="md-nav__link" for="__nav_2">
226 PHP API
227 <span class="md-nav__icon md-icon"></span>
228 </label>
229 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
230 <label class="md-nav__title" for="__nav_2">
231 <span class="md-nav__icon md-icon"></span>
232 PHP API
233 </label>
234 <ul class="md-nav__list" data-md-scrollfix>
235
236
237
238
239
240 <li class="md-nav__item">
241 <a href="../../php/pages/" class="md-nav__link">
242 Pages
243 </a>
244 </li>
245
246
247
248
249
250
251
252 <li class="md-nav__item">
253 <a href="../../php/database-objects/" class="md-nav__link">
254 Database Objects
255 </a>
256 </li>
257
258
259
260
261
262
263
264 <li class="md-nav__item">
265 <a href="../../php/database-access/" class="md-nav__link">
266 Database Access
267 </a>
268 </li>
269
270
271
272
273
274
275
276 <li class="md-nav__item">
277 <a href="../../php/exceptions/" class="md-nav__link">
278 Exceptions
279 </a>
280 </li>
281
282
283
284
285
286
287
288
289 <li class="md-nav__item md-nav__item--nested">
290
291
292 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
293
294 <label class="md-nav__link" for="__nav_2_5">
295 API
296 <span class="md-nav__icon md-icon"></span>
297 </label>
298 <nav class="md-nav" aria-label="API" data-md-level="2">
299 <label class="md-nav__title" for="__nav_2_5">
300 <span class="md-nav__icon md-icon"></span>
301 API
302 </label>
303 <ul class="md-nav__list" data-md-scrollfix>
304
305
306
307
308
6923e968
WG		 309
310 <li class="md-nav__item md-nav__item--nested">
311
312
313 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
314
315 <label class="md-nav__link" for="__nav_2_5_1">
316 Caches
317 <span class="md-nav__icon md-icon"></span>
318 </label>
319 <nav class="md-nav" aria-label="Caches" data-md-level="3">
320 <label class="md-nav__title" for="__nav_2_5_1">
321 <span class="md-nav__icon md-icon"></span>
322 Caches
323 </label>
324 <ul class="md-nav__list" data-md-scrollfix>
325
326
327
328
329
45ca63d0
TD		 330 <li class="md-nav__item">
331 <a href="../../php/api/caches/" class="md-nav__link">
6923e968
WG		 332 Overview
333 </a>
334 </li>
335
336
337
338
339
340
341
342 <li class="md-nav__item">
343 <a href="../../php/api/caches_persistent-caches/" class="md-nav__link">
344 Persistent Caches
345 </a>
346 </li>
347
348
349
350
351
352
353
354 <li class="md-nav__item">
355 <a href="../../php/api/caches_runtime-caches/" class="md-nav__link">
356 Runtime Caches
45ca63d0
TD		 357 </a>
358 </li>
359
360
361
6923e968
WG		 362 </ul>
363 </nav>
364 </li>
365
366
367
45ca63d0
TD		 368
369
370
371
372 <li class="md-nav__item">
373 <a href="../../php/api/comments/" class="md-nav__link">
374 Comments
375 </a>
376 </li>
377
378
379
380
381
382
383
384 <li class="md-nav__item">
385 <a href="../../php/api/cronjobs/" class="md-nav__link">
386 Cronjobs
387 </a>
388 </li>
389
390
391
392
393
394
395
396 <li class="md-nav__item">
397 <a href="../../php/api/events/" class="md-nav__link">
398 Events
399 </a>
400 </li>
401
402
403
404
405
406
407
408
409 <li class="md-nav__item md-nav__item--nested">
410
411
412 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
413
414 <label class="md-nav__link" for="__nav_2_5_5">
415 Form Builder
416 <span class="md-nav__icon md-icon"></span>
417 </label>
418 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
419 <label class="md-nav__title" for="__nav_2_5_5">
420 <span class="md-nav__icon md-icon"></span>
421 Form Builder
422 </label>
423 <ul class="md-nav__list" data-md-scrollfix>
424
425
426
427
428
429 <li class="md-nav__item">
430 <a href="../../php/api/form_builder/overview/" class="md-nav__link">
431 Overview
432 </a>
433 </li>
434
435
436
437
438
439
440
441 <li class="md-nav__item">
442 <a href="../../php/api/form_builder/structure/" class="md-nav__link">
443 Structure
444 </a>
445 </li>
446
447
448
449
450
451
452
453 <li class="md-nav__item">
454 <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
455 Fields
456 </a>
457 </li>
458
459
460
461
462
463
464
465 <li class="md-nav__item">
466 <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
467 Validation and Data
468 </a>
469 </li>
470
471
472
473
474
475
476
477 <li class="md-nav__item">
478 <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
479 Dependencies
480 </a>
481 </li>
482
483
484
485 </ul>
486 </nav>
487 </li>
488
489
490
491
492
493
494
495 <li class="md-nav__item">
496 <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
497 Package Installation Plugins
498 </a>
499 </li>
500
501
502
503
504
505
506
507 <li class="md-nav__item">
508 <a href="../../php/api/user_activity_points/" class="md-nav__link">
509 User Activity Points
510 </a>
511 </li>
512
513
514
515
516
517
518
519 <li class="md-nav__item">
520 <a href="../../php/api/user_notifications/" class="md-nav__link">
521 User Notifications
522 </a>
523 </li>
524
525
526
527
528
529
530
531 <li class="md-nav__item">
532 <a href="../../php/api/sitemaps/" class="md-nav__link">
533 Sitemaps
534 </a>
535 </li>
536
537
538
539 </ul>
540 </nav>
541 </li>
542
543
544
545
546
547
548
549 <li class="md-nav__item">
550 <a href="../../php/code-style/" class="md-nav__link">
551 Code Style
552 </a>
553 </li>
554
555
556
557
558
559
560
561 <li class="md-nav__item">
562 <a href="../../php/apps/" class="md-nav__link">
563 Apps
564 </a>
565 </li>
566
567
568
569
570
571
572
573 <li class="md-nav__item">
574 <a href="../../php/gdpr/" class="md-nav__link">
575 GDPR
576 </a>
577 </li>
578
579
580
581 </ul>
582 </nav>
583 </li>
584
585
586
587
588
589
590
591
592
593
594
595 <li class="md-nav__item md-nav__item--nested">
596
597
598 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
599
600 <label class="md-nav__link" for="__nav_3">
601 Languages, Templates & CSS
602 <span class="md-nav__icon md-icon"></span>
603 </label>
604 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
605 <label class="md-nav__title" for="__nav_3">
606 <span class="md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
608 </label>
609 <ul class="md-nav__list" data-md-scrollfix>
610
611
612
613
614
615 <li class="md-nav__item">
616 <a href="../../view/languages/" class="md-nav__link">
617 Languages
618 </a>
619 </li>
620
621
622
623
624
625
626
627 <li class="md-nav__item">
628 <a href="../../view/templates/" class="md-nav__link">
629 Templates
630 </a>
631 </li>
632
633
634
635
636
637
638
6923e968
WG		 639 <li class="md-nav__item">
640 <a href="../../view/template-plugins/" class="md-nav__link">
641 Template Plugins
642 </a>
643 </li>
644
645
646
647
648
649
650
45ca63d0
TD		 651 <li class="md-nav__item">
652 <a href="../../view/css/" class="md-nav__link">
653 CSS
654 </a>
655 </li>
656
657
658
659 </ul>
660 </nav>
661 </li>
662
663
664
665
666
667
668
669
670
671
672
673 <li class="md-nav__item md-nav__item--nested">
674
675
676 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
677
678 <label class="md-nav__link" for="__nav_4">
77efcd46 679 TypeScript and JavaScript API
45ca63d0
TD		 680 <span class="md-nav__icon md-icon"></span>
681 </label>
77efcd46 682 <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
45ca63d0
TD		 683 <label class="md-nav__title" for="__nav_4">
684 <span class="md-nav__icon md-icon"></span>
77efcd46 685 TypeScript and JavaScript API
45ca63d0
TD		 686 </label>
687 <ul class="md-nav__list" data-md-scrollfix>
688
689
690
691
692
693 <li class="md-nav__item">
694 <a href="../../javascript/general-usage/" class="md-nav__link">
695 General Usage
696 </a>
697 </li>
698
699
700
701
702
703
704
77efcd46
WG		 705 <li class="md-nav__item">
706 <a href="../../javascript/typescript/" class="md-nav__link">
707 TypeScript
708 </a>
709 </li>
710
711
712
713
714
715
716
45ca63d0
TD		 717
718 <li class="md-nav__item md-nav__item--nested">
719
720
77efcd46 721 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
45ca63d0 722
77efcd46 723 <label class="md-nav__link" for="__nav_4_3">
45ca63d0
TD		 724 New API
725 <span class="md-nav__icon md-icon"></span>
726 </label>
727 <nav class="md-nav" aria-label="New API" data-md-level="2">
77efcd46 728 <label class="md-nav__title" for="__nav_4_3">
45ca63d0
TD		 729 <span class="md-nav__icon md-icon"></span>
730 New API
731 </label>
732 <ul class="md-nav__list" data-md-scrollfix>
733
734
735
736
737
738 <li class="md-nav__item">
739 <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
740 Writing a module
741 </a>
742 </li>
743
744
745
746
747
748
749
750 <li class="md-nav__item">
751 <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
752 Data Structures
753 </a>
754 </li>
755
756
757
758
759
760
761
762 <li class="md-nav__item">
763 <a href="../../javascript/new-api_core/" class="md-nav__link">
764 Core Functions
765 </a>
766 </li>
767
768
769
770
771
772
773
774 <li class="md-nav__item">
775 <a href="../../javascript/new-api_dom/" class="md-nav__link">
776 DOM
777 </a>
778 </li>
779
780
781
782
783
784
785
786 <li class="md-nav__item">
787 <a href="../../javascript/new-api_events/" class="md-nav__link">
788 Event Handling
789 </a>
790 </li>
791
792
793
794
795
796
797
798 <li class="md-nav__item">
799 <a href="../../javascript/new-api_ajax/" class="md-nav__link">
800 Ajax
801 </a>
802 </li>
803
804
805
806
807
808
809
810 <li class="md-nav__item">
811 <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
812 Dialogs
813 </a>
814 </li>
815
816
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../javascript/new-api_browser/" class="md-nav__link">
824 Browser and Screen Sizes
825 </a>
826 </li>
827
828
829
830
831
832
833
834 <li class="md-nav__item">
835 <a href="../../javascript/new-api_ui/" class="md-nav__link">
836 User Interface
837 </a>
838 </li>
839
840
841
842 </ul>
843 </nav>
844 </li>
845
846
847
848
849
850
851
852 <li class="md-nav__item">
853 <a href="../../javascript/legacy-api/" class="md-nav__link">
854 Legacy API
855 </a>
856 </li>
857
858
859
860
861
862
863
864 <li class="md-nav__item">
865 <a href="../../javascript/helper-functions/" class="md-nav__link">
866 Helper Functions
867 </a>
868 </li>
869
870
871
872
873
874
875
876 <li class="md-nav__item">
877 <a href="../../javascript/code-snippets/" class="md-nav__link">
878 Code Snippets
879 </a>
880 </li>
881
882
883
884 </ul>
885 </nav>
886 </li>
887
888
889
890
891
892
893
894
895
896
897
898
899
900 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
901
902
903 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
904
905 <label class="md-nav__link" for="__nav_5">
906 Package Components
907 <span class="md-nav__icon md-icon"></span>
908 </label>
909 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
910 <label class="md-nav__title" for="__nav_5">
911 <span class="md-nav__icon md-icon"></span>
912 Package Components
913 </label>
914 <ul class="md-nav__list" data-md-scrollfix>
915
916
917
918
919
920 <li class="md-nav__item">
921 <a href="../package-xml/" class="md-nav__link">
922 package.xml
923 </a>
924 </li>
925
926
927
928
929
930
931
932
933 <li class="md-nav__item md-nav__item--nested">
934
935
936 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
937
938 <label class="md-nav__link" for="__nav_5_2">
939 PIPs
940 <span class="md-nav__icon md-icon"></span>
941 </label>
942 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
943 <label class="md-nav__title" for="__nav_5_2">
944 <span class="md-nav__icon md-icon"></span>
945 PIPs
946 </label>
947 <ul class="md-nav__list" data-md-scrollfix>
948
949
950
951
952
953 <li class="md-nav__item">
954 <a href="../pip/" class="md-nav__link">
955 Overview
956 </a>
957 </li>
958
959
960
961
962
963
964
965 <li class="md-nav__item">
966 <a href="../pip/acl-option/" class="md-nav__link">
967 aclOption
968 </a>
969 </li>
970
971
972
973
974
975
976
977 <li class="md-nav__item">
978 <a href="../pip/acp-menu/" class="md-nav__link">
979 acpMenu
980 </a>
981 </li>
982
983
984
985
986
987
988
989 <li class="md-nav__item">
990 <a href="../pip/acp-search-provider/" class="md-nav__link">
991 acpSearchProvider
992 </a>
993 </li>
994
995
996
997
998
999
1000
1001 <li class="md-nav__item">
1002 <a href="../pip/acp-template/" class="md-nav__link">
1003 acpTemplate
1004 </a>
1005 </li>
1006
1007
1008
1009
1010
1011
1012
1013 <li class="md-nav__item">
1014 <a href="../pip/bbcode/" class="md-nav__link">
1015 bbcode
1016 </a>
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../pip/box/" class="md-nav__link">
1027 box
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../pip/clipboard-action/" class="md-nav__link">
1039 clipboardAction
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../pip/core-object/" class="md-nav__link">
1051 coreObject
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../pip/cronjob/" class="md-nav__link">
1063 cronjob
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
6923e968
WG		 1073 <li class="md-nav__item">
1074 <a href="../pip/database/" class="md-nav__link">
1075 database
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
45ca63d0
TD		 1085 <li class="md-nav__item">
1086 <a href="../pip/event-listener/" class="md-nav__link">
1087 eventListener
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../pip/file/" class="md-nav__link">
1099 file
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../pip/language/" class="md-nav__link">
1111 language
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121 <li class="md-nav__item">
1122 <a href="../pip/media-provider/" class="md-nav__link">
1123 mediaProvider
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../pip/menu/" class="md-nav__link">
1135 menu
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../pip/menu-item/" class="md-nav__link">
1147 menuItem
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157 <li class="md-nav__item">
1158 <a href="../pip/object-type/" class="md-nav__link">
1159 objectType
1160 </a>
1161 </li>
1162
1163
1164
1165
1166
1167
1168
1169 <li class="md-nav__item">
1170 <a href="../pip/object-type-definition/" class="md-nav__link">
1171 objectTypeDefinition
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181 <li class="md-nav__item">
1182 <a href="../pip/option/" class="md-nav__link">
1183 option
1184 </a>
1185 </li>
1186
1187
1188
1189
1190
1191
1192
1193 <li class="md-nav__item">
1194 <a href="../pip/page/" class="md-nav__link">
1195 page
1196 </a>
1197 </li>
1198
1199
1200
1201
1202
1203
1204
1205 <li class="md-nav__item">
1206 <a href="../pip/pip/" class="md-nav__link">
1207 pip
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217 <li class="md-nav__item">
1218 <a href="../pip/script/" class="md-nav__link">
1219 script
1220 </a>
1221 </li>
1222
1223
1224
1225
1226
1227
1228
1229 <li class="md-nav__item">
1230 <a href="../pip/smiley/" class="md-nav__link">
1231 smiley
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241 <li class="md-nav__item">
1242 <a href="../pip/sql/" class="md-nav__link">
1243 sql
1244 </a>
1245 </li>
1246
1247
1248
1249
1250
1251
1252
1253 <li class="md-nav__item">
1254 <a href="../pip/style/" class="md-nav__link">
1255 style
1256 </a>
1257 </li>
1258
1259
1260
1261
1262
1263
1264
1265 <li class="md-nav__item">
1266 <a href="../pip/template/" class="md-nav__link">
1267 template
1268 </a>
1269 </li>
1270
1271
1272
1273
1274
1275
1276
1277 <li class="md-nav__item">
1278 <a href="../pip/template-listener/" class="md-nav__link">
1279 templateListener
1280 </a>
1281 </li>
1282
1283
1284
1285
1286
1287
1288
1289 <li class="md-nav__item">
1290 <a href="../pip/user-group-option/" class="md-nav__link">
1291 userGroupOption
1292 </a>
1293 </li>
1294
1295
1296
1297
1298
1299
1300
1301 <li class="md-nav__item">
1302 <a href="../pip/user-menu/" class="md-nav__link">
1303 userMenu
1304 </a>
1305 </li>
1306
1307
1308
1309
1310
1311
1312
1313 <li class="md-nav__item">
1314 <a href="../pip/user-notification-event/" class="md-nav__link">
1315 userNotificationEvent
1316 </a>
1317 </li>
1318
1319
1320
1321
1322
1323
1324
1325 <li class="md-nav__item">
1326 <a href="../pip/user-option/" class="md-nav__link">
1327 userOption
1328 </a>
1329 </li>
1330
1331
1332
1333
1334
1335
1336
1337 <li class="md-nav__item">
1338 <a href="../pip/user-profile-menu/" class="md-nav__link">
1339 userProfileMenu
1340 </a>
1341 </li>
1342
1343
1344
1345 </ul>
1346 </nav>
1347 </li>
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357 <li class="md-nav__item md-nav__item--active">
1358
1359 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1360
1361
1362
1363
1364 <label class="md-nav__link md-nav__link--active" for="__toc">
1365 Database PHP API
1366 <span class="md-nav__icon md-icon"></span>
1367 </label>
1368
1369 <a href="./" class="md-nav__link md-nav__link--active">
1370 Database PHP API
1371 </a>
1372
1373
1374<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1375
1376
1377
1378
1379
1380 <label class="md-nav__title" for="__toc">
1381 <span class="md-nav__icon md-icon"></span>
1382 Table of contents
1383 </label>
1384 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1385
1386 <li class="md-nav__item">
1387 <a href="#database-tables" class="md-nav__link">
1388 Database Tables
1389 </a>
1390
1391</li>
1392
1393 <li class="md-nav__item">
1394 <a href="#columns" class="md-nav__link">
1395 Columns
1396 </a>
1397
1398</li>
1399
1400 <li class="md-nav__item">
1401 <a href="#foreign-keys" class="md-nav__link">
1402 Foreign Keys
1403 </a>
1404
1405</li>
1406
1407 <li class="md-nav__item">
1408 <a href="#indices" class="md-nav__link">
1409 Indices
1410 </a>
1411
1412</li>
1413
1414 </ul>
1415
1416</nav>
1417
1418 </li>
1419
1420
1421
1422 </ul>
1423 </nav>
1424 </li>
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436 <li class="md-nav__item md-nav__item--nested">
1437
1438
1439 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1440
1441 <label class="md-nav__link" for="__nav_6">
1442 Migration
1443 <span class="md-nav__icon md-icon"></span>
1444 </label>
1445 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1446 <label class="md-nav__title" for="__nav_6">
1447 <span class="md-nav__icon md-icon"></span>
1448 Migration
1449 </label>
1450 <ul class="md-nav__list" data-md-scrollfix>
1451
1452
1453
1454
1455
1456
1457 <li class="md-nav__item md-nav__item--nested">
1458
1459
1460 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1461
1462 <label class="md-nav__link" for="__nav_6_1">
1463 Migrating from WSC 5.3
1464 <span class="md-nav__icon md-icon"></span>
1465 </label>
1466 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1467 <label class="md-nav__title" for="__nav_6_1">
1468 <span class="md-nav__icon md-icon"></span>
1469 Migrating from WSC 5.3
1470 </label>
1471 <ul class="md-nav__list" data-md-scrollfix>
1472
1473
1474
1475
1476
1477 <li class="md-nav__item">
1478 <a href="../../migration/wsc53/php/" class="md-nav__link">
1479 PHP API
1480 </a>
1481 </li>
1482
1483
1484
1485
1486
1487
1488
1489 <li class="md-nav__item">
1490 <a href="../../migration/wsc53/session/" class="md-nav__link">
1491 Session Handling and Authentication
1492 </a>
1493 </li>
1494
1495
1496
1497
1498
1499
1500
1501 <li class="md-nav__item">
1502 <a href="../../migration/wsc53/javascript/" class="md-nav__link">
77efcd46 1503 TypeScript and JavaScript
45ca63d0
TD		 1504 </a>
1505 </li>
1506
1507
1508
1509
1510
1511
1512
1513 <li class="md-nav__item">
1514 <a href="../../migration/wsc53/templates/" class="md-nav__link">
1515 Templates
1516 </a>
1517 </li>
1518
1519
1520
1521
1522
1523
1524
1525 <li class="md-nav__item">
1526 <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1527 Third Party Libraries
1528 </a>
1529 </li>
1530
1531
1532
1533 </ul>
1534 </nav>
1535 </li>
1536
1537
1538
1539
1540
1541
1542
1543
1544 <li class="md-nav__item md-nav__item--nested">
1545
1546
1547 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1548
1549 <label class="md-nav__link" for="__nav_6_2">
1550 Migrating from WSC 5.2
1551 <span class="md-nav__icon md-icon"></span>
1552 </label>
1553 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1554 <label class="md-nav__title" for="__nav_6_2">
1555 <span class="md-nav__icon md-icon"></span>
1556 Migrating from WSC 5.2
1557 </label>
1558 <ul class="md-nav__list" data-md-scrollfix>
1559
1560
1561
1562
1563
1564 <li class="md-nav__item">
1565 <a href="../../migration/wsc52/php/" class="md-nav__link">
1566 PHP API
1567 </a>
1568 </li>
1569
1570
1571
1572
1573
1574
1575
1576 <li class="md-nav__item">
1577 <a href="../../migration/wsc52/templates/" class="md-nav__link">
1578 Templates and Languages
1579 </a>
1580 </li>
1581
1582
1583
1584
1585
1586
1587
1588 <li class="md-nav__item">
1589 <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1590 Third Party Libraries
1591 </a>
1592 </li>
1593
1594
1595
1596 </ul>
1597 </nav>
1598 </li>
1599
1600
1601
1602
1603
1604
1605
1606
1607 <li class="md-nav__item md-nav__item--nested">
1608
1609
1610 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1611
1612 <label class="md-nav__link" for="__nav_6_3">
1613 Migrating from WSC 3.1
1614 <span class="md-nav__icon md-icon"></span>
1615 </label>
1616 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1617 <label class="md-nav__title" for="__nav_6_3">
1618 <span class="md-nav__icon md-icon"></span>
1619 Migrating from WSC 3.1
1620 </label>
1621 <ul class="md-nav__list" data-md-scrollfix>
1622
1623
1624
1625
1626
1627 <li class="md-nav__item">
1628 <a href="../../migration/wsc31/php/" class="md-nav__link">
1629 PHP API
1630 </a>
1631 </li>
1632
1633
1634
1635 </ul>
1636 </nav>
1637 </li>
1638
1639
1640
1641
1642
1643
1644
1645
1646 <li class="md-nav__item md-nav__item--nested">
1647
1648
1649 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1650
1651 <label class="md-nav__link" for="__nav_6_4">
1652 Migrating from WSC 3.0
1653 <span class="md-nav__icon md-icon"></span>
1654 </label>
1655 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1656 <label class="md-nav__title" for="__nav_6_4">
1657 <span class="md-nav__icon md-icon"></span>
1658 Migrating from WSC 3.0
1659 </label>
1660 <ul class="md-nav__list" data-md-scrollfix>
1661
1662
1663
1664
1665
1666 <li class="md-nav__item">
1667 <a href="../../migration/wsc30/php/" class="md-nav__link">
1668 PHP API
1669 </a>
1670 </li>
1671
1672
1673
1674
1675
1676
1677
1678 <li class="md-nav__item">
1679 <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1680 JavaScript API
1681 </a>
1682 </li>
1683
1684
1685
1686
1687
1688
1689
1690 <li class="md-nav__item">
1691 <a href="../../migration/wsc30/templates/" class="md-nav__link">
1692 Templates
1693 </a>
1694 </li>
1695
1696
1697
1698
1699
1700
1701
1702 <li class="md-nav__item">
1703 <a href="../../migration/wsc30/css/" class="md-nav__link">
1704 CSS
1705 </a>
1706 </li>
1707
1708
1709
1710
1711
1712
1713
1714 <li class="md-nav__item">
1715 <a href="../../migration/wsc30/package/" class="md-nav__link">
1716 Package Components
1717 </a>
1718 </li>
1719
1720
1721
1722 </ul>
1723 </nav>
1724 </li>
1725
1726
1727
1728
1729
1730
1731
1732
1733 <li class="md-nav__item md-nav__item--nested">
1734
1735
1736 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1737
1738 <label class="md-nav__link" for="__nav_6_5">
1739 Migrating from WCF 2.1
1740 <span class="md-nav__icon md-icon"></span>
1741 </label>
1742 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1743 <label class="md-nav__title" for="__nav_6_5">
1744 <span class="md-nav__icon md-icon"></span>
1745 Migrating from WCF 2.1
1746 </label>
1747 <ul class="md-nav__list" data-md-scrollfix>
1748
1749
1750
1751
1752
1753 <li class="md-nav__item">
1754 <a href="../../migration/wcf21/php/" class="md-nav__link">
1755 PHP API
1756 </a>
1757 </li>
1758
1759
1760
1761
1762
1763
1764
1765 <li class="md-nav__item">
1766 <a href="../../migration/wcf21/templates/" class="md-nav__link">
1767 Templates
1768 </a>
1769 </li>
1770
1771
1772
1773
1774
1775
1776
1777 <li class="md-nav__item">
1778 <a href="../../migration/wcf21/css/" class="md-nav__link">
1779 CSS
1780 </a>
1781 </li>
1782
1783
1784
1785
1786
1787
1788
1789 <li class="md-nav__item">
1790 <a href="../../migration/wcf21/package/" class="md-nav__link">
1791 Package Components
1792 </a>
1793 </li>
1794
1795
1796
1797 </ul>
1798 </nav>
1799 </li>
1800
1801
1802
1803 </ul>
1804 </nav>
1805 </li>
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817 <li class="md-nav__item md-nav__item--nested">
1818
1819
1820 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1821
1822 <label class="md-nav__link" for="__nav_7">
1823 Tutorials
1824 <span class="md-nav__icon md-icon"></span>
1825 </label>
1826 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1827 <label class="md-nav__title" for="__nav_7">
1828 <span class="md-nav__icon md-icon"></span>
1829 Tutorials
1830 </label>
1831 <ul class="md-nav__list" data-md-scrollfix>
1832
1833
1834
1835
1836
1837
1838 <li class="md-nav__item md-nav__item--nested">
1839
1840
1841 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1842
1843 <label class="md-nav__link" for="__nav_7_1">
1844 Tutorial Series
1845 <span class="md-nav__icon md-icon"></span>
1846 </label>
1847 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1848 <label class="md-nav__title" for="__nav_7_1">
1849 <span class="md-nav__icon md-icon"></span>
1850 Tutorial Series
1851 </label>
1852 <ul class="md-nav__list" data-md-scrollfix>
1853
1854
1855
1856
1857
1858 <li class="md-nav__item">
1859 <a href="../../tutorial/series/overview/" class="md-nav__link">
1860 Overview
1861 </a>
1862 </li>
1863
1864
1865
1866
1867
1868
1869
1870 <li class="md-nav__item">
1871 <a href="../../tutorial/series/part_1/" class="md-nav__link">
1872 Part 1
1873 </a>
1874 </li>
1875
1876
1877
1878
1879
1880
1881
1882 <li class="md-nav__item">
1883 <a href="../../tutorial/series/part_2/" class="md-nav__link">
1884 Part 2
1885 </a>
1886 </li>
1887
1888
1889
1890
1891
1892
1893
1894 <li class="md-nav__item">
1895 <a href="../../tutorial/series/part_3/" class="md-nav__link">
1896 Part 3
1897 </a>
1898 </li>
1899
1900
1901
1902 </ul>
1903 </nav>
1904 </li>
1905
1906
1907
1908 </ul>
1909 </nav>
1910 </li>
1911
1912
1913
1914 </ul>
1915</nav>
1916 </div>
1917 </div>
1918 </div>
1919
1920
1921
1922 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1923 <div class="md-sidebar__scrollwrap">
1924 <div class="md-sidebar__inner">
1925
1926<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1927
1928
1929
1930
1931
1932 <label class="md-nav__title" for="__toc">
1933 <span class="md-nav__icon md-icon"></span>
1934 Table of contents
1935 </label>
1936 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1937
1938 <li class="md-nav__item">
1939 <a href="#database-tables" class="md-nav__link">
1940 Database Tables
1941 </a>
1942
1943</li>
1944
1945 <li class="md-nav__item">
1946 <a href="#columns" class="md-nav__link">
1947 Columns
1948 </a>
1949
1950</li>
1951
1952 <li class="md-nav__item">
1953 <a href="#foreign-keys" class="md-nav__link">
1954 Foreign Keys
1955 </a>
1956
1957</li>
1958
1959 <li class="md-nav__item">
1960 <a href="#indices" class="md-nav__link">
1961 Indices
1962 </a>
1963
1964</li>
1965
1966 </ul>
1967
1968</nav>
1969 </div>
1970 </div>
1971 </div>
1972
1973
1974 <div class="md-content" data-md-component="content">
1975 <article class="md-content__inner md-typeset">
1976
1977
9b8bddda 1978 <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/package/database-php-api.md" title="Edit this page" class="md-content__button md-icon">
7124f4cb
WG		 1979 <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>
1980 </a>
1981
45ca63d0
TD		 1982
1983 <h1 id="database-php-api">Database PHP API<a class="headerlink" href="#database-php-api" title="Permanent link">#</a></h1>
1984<div class="admonition info">
1985<p class="admonition-title">Available since WoltLab Suite 5.2.</p>
1986</div>
1987<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.
1988We 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>
1989<div class="highlight"><pre><span></span><code><span class="nv">$tables</span> <span class="o">=</span> <span class="p">[</span>
abd2f18a 1990 <span class="c1">// list of `DatabaseTable` objects</span>
45ca63d0
TD		 1991<span class="p">];</span>
1992
1993<span class="p">(</span><span class="k">new</span> <span class="nx">DatabaseTableChangeProcessor</span><span class="p">(</span>
1994 <span class="sd">/** @var ScriptPackageInstallationPlugin $this */</span>
1995 <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>
1996 <span class="nv">$tables</span><span class="p">,</span>
1997 <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>
1998<span class="p">)</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">();</span>
1999</code></pre></div>
45ca63d0 2000<p>All of the relevant components can be found in the <code>wcf\system\database\table</code> namespace.</p>
abd2f18a
WG		 2001<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>
2002<div class="highlight"><pre><span></span><code><span class="k">return</span> <span class="p">[</span>
2003 <span class="c1">// list of `DatabaseTable` objects</span>
2004<span class="p">];</span>
2005</code></pre></div>
45ca63d0
TD		 2006<h2 id="database-tables">Database Tables<a class="headerlink" href="#database-tables" title="Permanent link">#</a></h2>
2007<p>There are two classes representing database tables: <code>DatabaseTable</code> and <code>PartialDatabaseTable</code>.
2008If a new table should be created, use <code>DatabaseTable</code>.
2009In 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:
2010If 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>
2011<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>
2012<div class="highlight"><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>
2013 <span class="o">-&gt;</span><span class="na">columns</span><span class="p">([</span>
2014 <span class="c1">// columns</span>
2015 <span class="p">])</span>
2016 <span class="o">-&gt;</span><span class="na">foreignKeys</span><span class="p">([</span>
2017 <span class="c1">// foreign keys</span>
2018 <span class="p">])</span>
2019 <span class="o">-&gt;</span><span class="na">indices</span><span class="p">([</span>
2020 <span class="c1">// indices</span>
2021 <span class="p">])</span>
2022</code></pre></div>
45ca63d0
TD		 2023<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>
2024<p>To drop a table, only the <code>drop()</code> method has to be called:</p>
2025<div class="highlight"><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>
2026 <span class="o">-&gt;</span><span class="na">drop</span><span class="p">()</span>
2027</code></pre></div>
45ca63d0
TD		 2028<h2 id="columns">Columns<a class="headerlink" href="#columns" title="Permanent link">#</a></h2>
2029<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.
2030Such instances are created similarly to database table objects using the <code>create()</code> factory method and passing the column name as the parameter.</p>
2031<p>Every column type supports the following methods:</p>
2032<ul>
2033<li><code>defaultValue($defaultValue)</code> sets the default value of the column (default: none).</li>
2034<li><code>drop()</code> to drop the column.</li>
2035<li><code>notNull($notNull = true)</code> sets if the value of the column can be <code>NULL</code> (default: <code>false</code>).</li>
2036</ul>
2037<p>Depending on the specific column class implementing additional interfaces, the following methods are also available:</p>
2038<ul>
2039<li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)</code> sets if the value of the colum is auto-incremented.</li>
2040<li><code>IDecimalsDatabaseTableColumn::decimals($decimals)</code> sets the number of decimals the column supports.</li>
2041<li><code>IEnumDatabaseTableColumn::enumValues(array $values)</code> sets the predetermined set of valid values of the column.</li>
2042<li><code>ILengthDatabaseTableColumn::length($length)</code> sets the (maximum) length of the column.</li>
2043</ul>
2044<p>Additionally, there are some additionally classes of commonly used columns with specific properties:</p>
2045<ul>
2046<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>
2047<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>
2048<li><code>NotNullInt10DatabaseTableColumn</code> (a <code>int</code> column with length <code>10</code> and whose values cannot be <code>null</code>)</li>
2049<li><code>NotNullVarchar191DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>191</code> and whose values cannot be <code>null</code>)</li>
2050<li><code>NotNullVarchar255DatabaseTableColumn</code> (a <code>varchar</code> column with length <code>255</code> and whose values cannot be <code>null</code>)</li>
2051<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>
2052</ul>
2053<p>Examples:</p>
2054<div class="highlight"><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>
2055
2056<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>
2057
2058<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>
2059 <span class="o">-&gt;</span><span class="na">length</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
2060 <span class="o">-&gt;</span><span class="na">notNull</span><span class="p">()</span>
2061</code></pre></div>
45ca63d0
TD		 2062<h2 id="foreign-keys">Foreign Keys<a class="headerlink" href="#foreign-keys" title="Permanent link">#</a></h2>
2063<p>Foreign keys are represented by <code>DatabaseTableForeignKey</code> objects: </p>
2064<div class="highlight"><pre><span></span><code><span class="nx">DatabaseTableForeignKey</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
2065 <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>
2066 <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>
2067 <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>
2068 <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>
2069</code></pre></div>
45ca63d0
TD		 2070<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>.
2071To 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>
2072<p><code>DatabaseTableForeignKey::create()</code> also supports the foreign key name as a parameter.
2073If it is not present, <code>DatabaseTable::foreignKeys()</code> will automatically set one based on the foreign key's data.</p>
2074<h2 id="indices">Indices<a class="headerlink" href="#indices" title="Permanent link">#</a></h2>
2075<p>Indices are represented by <code>DatabaseTableIndex</code> objects: </p>
2076<div class="highlight"><pre><span></span><code><span class="nx">DatabaseTableIndex</span><span class="o">::</span><span class="na">create</span><span class="p">()</span>
2077 <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>
2078 <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>
2079</code></pre></div>
45ca63d0
TD		 2080<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>.
2081For primary keys, there is also the <code>DatabaseTablePrimaryIndex</code> class which automatically sets the type to <code>DatabaseTableIndex::PRIMARY_TYPE</code>.
2082To 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>
2083<p><code>DatabaseTableIndex::create()</code> also supports the index name as a parameter.
2084If it is not present, <code>DatabaseTable::indices()</code> will automatically set one based on the index data.</p>
2085
4a5c32e1
WG		 2086
2087
2088
2089<hr>
2090<div class="md-source-date">
2091 <small>
2092
abd2f18a 2093 Last update: 2021-03-16
4a5c32e1
WG		 2094
2095 </small>
2096</div>
2097
2098
45ca63d0
TD		 2099
2100
2101
2102
2103
2104
2105 </article>
2106 </div>
2107 </div>
fb962f09 2108
45ca63d0
TD		 2109 </main>
2110
2111
2112<footer class="md-footer">
2113
2114 <nav class="md-footer__inner md-grid" aria-label="Footer">
2115
2116 <a href="../pip/user-profile-menu/" class="md-footer__link md-footer__link--prev" rel="prev">
2117 <div class="md-footer__button md-icon">
2118 <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>
2119 </div>
2120 <div class="md-footer__title">
2121 <div class="md-ellipsis">
2122 <span class="md-footer__direction">
2123 Previous
2124 </span>
2125 userProfileMenu
2126 </div>
2127 </div>
2128 </a>
2129
2130
2131 <a href="../../migration/wsc53/php/" class="md-footer__link md-footer__link--next" rel="next">
2132 <div class="md-footer__title">
2133 <div class="md-ellipsis">
2134 <span class="md-footer__direction">
2135 Next
2136 </span>
2137 PHP API
2138 </div>
2139 </div>
2140 <div class="md-footer__button md-icon">
2141 <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>
2142 </div>
2143 </a>
2144
2145 </nav>
2146
2147 <div class="md-footer-meta md-typeset">
2148 <div class="md-footer-meta__inner md-grid">
2149 <div class="md-footer-copyright">
2150
2151 <div class="md-footer-copyright__highlight">
2152 Copyright © 2020 WoltLab GmbH
2153 </div>
2154
2155 Made with
2156 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2157 Material for MkDocs
2158 </a>
fb88dc6e 2159
45ca63d0
TD		 2160 </div>
2161 <div class="md-footer-copyright">
2162 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2163 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2164</div>
2165 </div>
2166 </div>
2167</footer>
2168
2169 </div>
2170 <div class="md-dialog" data-md-component="dialog">
2171 <div class="md-dialog__inner md-typeset"></div>
2172 </div>
fb962f09 2173 <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../assets/javascripts/workers/search.fe42c31b.min.js", "version": {"provider": "mike"}}</script>
45ca63d0
TD		 2174
2175
fb962f09 2176 <script src="../../assets/javascripts/bundle.d892486b.min.js"></script>
45ca63d0
TD		 2177
2178
2179 </body>
2180</html>