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