3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Database PHP API - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
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">
63 <a href=
"#database-php-api" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
80 <header class=
"md-header" data-md-component=
"header">
81 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
82 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
84 <img src=
"../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
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>
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>
122 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
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>
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">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
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">
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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
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">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
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">
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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
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>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
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>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
309 <li class=
"md-nav__item">
310 <a href=
"../../php/api/caches/" class=
"md-nav__link">
321 <li class=
"md-nav__item">
322 <a href=
"../../php/api/comments/" class=
"md-nav__link">
333 <li class=
"md-nav__item">
334 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
345 <li class=
"md-nav__item">
346 <a href=
"../../php/api/events/" class=
"md-nav__link">
358 <li class=
"md-nav__item md-nav__item--nested">
361 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
363 <label class=
"md-nav__link" for=
"__nav_2_5_5">
365 <span class=
"md-nav__icon md-icon"></span>
367 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
368 <label class=
"md-nav__title" for=
"__nav_2_5_5">
369 <span class=
"md-nav__icon md-icon"></span>
372 <ul class=
"md-nav__list" data-md-scrollfix
>
378 <li class=
"md-nav__item">
379 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
414 <li class=
"md-nav__item">
415 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
426 <li class=
"md-nav__item">
427 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
444 <li class=
"md-nav__item">
445 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
446 Package Installation Plugins
456 <li class=
"md-nav__item">
457 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
468 <li class=
"md-nav__item">
469 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
480 <li class=
"md-nav__item">
481 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
498 <li class=
"md-nav__item">
499 <a href=
"../../php/code-style/" class=
"md-nav__link">
510 <li class=
"md-nav__item">
511 <a href=
"../../php/apps/" class=
"md-nav__link">
522 <li class=
"md-nav__item">
523 <a href=
"../../php/gdpr/" class=
"md-nav__link">
544 <li class=
"md-nav__item md-nav__item--nested">
547 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
549 <label class=
"md-nav__link" for=
"__nav_3">
550 Languages, Templates & CSS
551 <span class=
"md-nav__icon md-icon"></span>
553 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
554 <label class=
"md-nav__title" for=
"__nav_3">
555 <span class=
"md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
558 <ul class=
"md-nav__list" data-md-scrollfix
>
564 <li class=
"md-nav__item">
565 <a href=
"../../view/languages/" class=
"md-nav__link">
576 <li class=
"md-nav__item">
577 <a href=
"../../view/templates/" class=
"md-nav__link">
588 <li class=
"md-nav__item">
589 <a href=
"../../view/css/" class=
"md-nav__link">
610 <li class=
"md-nav__item md-nav__item--nested">
613 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
615 <label class=
"md-nav__link" for=
"__nav_4">
617 <span class=
"md-nav__icon md-icon"></span>
619 <nav class=
"md-nav" aria-label=
"JavaScript API" data-md-level=
"1">
620 <label class=
"md-nav__title" for=
"__nav_4">
621 <span class=
"md-nav__icon md-icon"></span>
624 <ul class=
"md-nav__list" data-md-scrollfix
>
630 <li class=
"md-nav__item">
631 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
643 <li class=
"md-nav__item md-nav__item--nested">
646 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_2" type=
"checkbox" id=
"__nav_4_2" >
648 <label class=
"md-nav__link" for=
"__nav_4_2">
650 <span class=
"md-nav__icon md-icon"></span>
652 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
653 <label class=
"md-nav__title" for=
"__nav_4_2">
654 <span class=
"md-nav__icon md-icon"></span>
657 <ul class=
"md-nav__list" data-md-scrollfix
>
663 <li class=
"md-nav__item">
664 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
675 <li class=
"md-nav__item">
676 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
687 <li class=
"md-nav__item">
688 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
699 <li class=
"md-nav__item">
700 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
711 <li class=
"md-nav__item">
712 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
723 <li class=
"md-nav__item">
724 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
735 <li class=
"md-nav__item">
736 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
747 <li class=
"md-nav__item">
748 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
749 Browser and Screen Sizes
759 <li class=
"md-nav__item">
760 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
777 <li class=
"md-nav__item">
778 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
789 <li class=
"md-nav__item">
790 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
801 <li class=
"md-nav__item">
802 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
825 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
828 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" checked
>
830 <label class=
"md-nav__link" for=
"__nav_5">
832 <span class=
"md-nav__icon md-icon"></span>
834 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
835 <label class=
"md-nav__title" for=
"__nav_5">
836 <span class=
"md-nav__icon md-icon"></span>
839 <ul class=
"md-nav__list" data-md-scrollfix
>
845 <li class=
"md-nav__item">
846 <a href=
"../package-xml/" class=
"md-nav__link">
858 <li class=
"md-nav__item md-nav__item--nested">
861 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
863 <label class=
"md-nav__link" for=
"__nav_5_2">
865 <span class=
"md-nav__icon md-icon"></span>
867 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
868 <label class=
"md-nav__title" for=
"__nav_5_2">
869 <span class=
"md-nav__icon md-icon"></span>
872 <ul class=
"md-nav__list" data-md-scrollfix
>
878 <li class=
"md-nav__item">
879 <a href=
"../pip/" class=
"md-nav__link">
890 <li class=
"md-nav__item">
891 <a href=
"../pip/acl-option/" class=
"md-nav__link">
902 <li class=
"md-nav__item">
903 <a href=
"../pip/acp-menu/" class=
"md-nav__link">
914 <li class=
"md-nav__item">
915 <a href=
"../pip/acp-search-provider/" class=
"md-nav__link">
926 <li class=
"md-nav__item">
927 <a href=
"../pip/acp-template/" class=
"md-nav__link">
938 <li class=
"md-nav__item">
939 <a href=
"../pip/bbcode/" class=
"md-nav__link">
950 <li class=
"md-nav__item">
951 <a href=
"../pip/box/" class=
"md-nav__link">
962 <li class=
"md-nav__item">
963 <a href=
"../pip/clipboard-action/" class=
"md-nav__link">
974 <li class=
"md-nav__item">
975 <a href=
"../pip/core-object/" class=
"md-nav__link">
986 <li class=
"md-nav__item">
987 <a href=
"../pip/cronjob/" class=
"md-nav__link">
998 <li class=
"md-nav__item">
999 <a href=
"../pip/event-listener/" class=
"md-nav__link">
1010 <li class=
"md-nav__item">
1011 <a href=
"../pip/file/" class=
"md-nav__link">
1022 <li class=
"md-nav__item">
1023 <a href=
"../pip/language/" class=
"md-nav__link">
1034 <li class=
"md-nav__item">
1035 <a href=
"../pip/media-provider/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../pip/menu/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../pip/menu-item/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../pip/object-type/" class=
"md-nav__link">
1082 <li class=
"md-nav__item">
1083 <a href=
"../pip/object-type-definition/" class=
"md-nav__link">
1084 objectTypeDefinition
1094 <li class=
"md-nav__item">
1095 <a href=
"../pip/option/" class=
"md-nav__link">
1106 <li class=
"md-nav__item">
1107 <a href=
"../pip/page/" class=
"md-nav__link">
1118 <li class=
"md-nav__item">
1119 <a href=
"../pip/pip/" class=
"md-nav__link">
1130 <li class=
"md-nav__item">
1131 <a href=
"../pip/script/" class=
"md-nav__link">
1142 <li class=
"md-nav__item">
1143 <a href=
"../pip/smiley/" class=
"md-nav__link">
1154 <li class=
"md-nav__item">
1155 <a href=
"../pip/sql/" class=
"md-nav__link">
1166 <li class=
"md-nav__item">
1167 <a href=
"../pip/style/" class=
"md-nav__link">
1178 <li class=
"md-nav__item">
1179 <a href=
"../pip/template/" class=
"md-nav__link">
1190 <li class=
"md-nav__item">
1191 <a href=
"../pip/template-listener/" class=
"md-nav__link">
1202 <li class=
"md-nav__item">
1203 <a href=
"../pip/user-group-option/" class=
"md-nav__link">
1214 <li class=
"md-nav__item">
1215 <a href=
"../pip/user-menu/" class=
"md-nav__link">
1226 <li class=
"md-nav__item">
1227 <a href=
"../pip/user-notification-event/" class=
"md-nav__link">
1228 userNotificationEvent
1238 <li class=
"md-nav__item">
1239 <a href=
"../pip/user-option/" class=
"md-nav__link">
1250 <li class=
"md-nav__item">
1251 <a href=
"../pip/user-profile-menu/" class=
"md-nav__link">
1270 <li class=
"md-nav__item md-nav__item--active">
1272 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1277 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1279 <span class=
"md-nav__icon md-icon"></span>
1282 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1287 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1293 <label class=
"md-nav__title" for=
"__toc">
1294 <span class=
"md-nav__icon md-icon"></span>
1297 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1299 <li class=
"md-nav__item">
1300 <a href=
"#database-tables" class=
"md-nav__link">
1306 <li class=
"md-nav__item">
1307 <a href=
"#columns" class=
"md-nav__link">
1313 <li class=
"md-nav__item">
1314 <a href=
"#foreign-keys" class=
"md-nav__link">
1320 <li class=
"md-nav__item">
1321 <a href=
"#indices" class=
"md-nav__link">
1349 <li class=
"md-nav__item md-nav__item--nested">
1352 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1354 <label class=
"md-nav__link" for=
"__nav_6">
1356 <span class=
"md-nav__icon md-icon"></span>
1358 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1359 <label class=
"md-nav__title" for=
"__nav_6">
1360 <span class=
"md-nav__icon md-icon"></span>
1363 <ul class=
"md-nav__list" data-md-scrollfix
>
1370 <li class=
"md-nav__item md-nav__item--nested">
1373 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1375 <label class=
"md-nav__link" for=
"__nav_6_1">
1376 Migrating from WSC
5.3
1377 <span class=
"md-nav__icon md-icon"></span>
1379 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1380 <label class=
"md-nav__title" for=
"__nav_6_1">
1381 <span class=
"md-nav__icon md-icon"></span>
1382 Migrating from WSC
5.3
1384 <ul class=
"md-nav__list" data-md-scrollfix
>
1390 <li class=
"md-nav__item">
1391 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1402 <li class=
"md-nav__item">
1403 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1404 Session Handling and Authentication
1414 <li class=
"md-nav__item">
1415 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1426 <li class=
"md-nav__item">
1427 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1438 <li class=
"md-nav__item">
1439 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1440 Third Party Libraries
1457 <li class=
"md-nav__item md-nav__item--nested">
1460 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1462 <label class=
"md-nav__link" for=
"__nav_6_2">
1463 Migrating from WSC
5.2
1464 <span class=
"md-nav__icon md-icon"></span>
1466 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1467 <label class=
"md-nav__title" for=
"__nav_6_2">
1468 <span class=
"md-nav__icon md-icon"></span>
1469 Migrating from WSC
5.2
1471 <ul class=
"md-nav__list" data-md-scrollfix
>
1477 <li class=
"md-nav__item">
1478 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1489 <li class=
"md-nav__item">
1490 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1491 Templates and Languages
1501 <li class=
"md-nav__item">
1502 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1503 Third Party Libraries
1520 <li class=
"md-nav__item md-nav__item--nested">
1523 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1525 <label class=
"md-nav__link" for=
"__nav_6_3">
1526 Migrating from WSC
3.1
1527 <span class=
"md-nav__icon md-icon"></span>
1529 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1530 <label class=
"md-nav__title" for=
"__nav_6_3">
1531 <span class=
"md-nav__icon md-icon"></span>
1532 Migrating from WSC
3.1
1534 <ul class=
"md-nav__list" data-md-scrollfix
>
1540 <li class=
"md-nav__item">
1541 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1559 <li class=
"md-nav__item md-nav__item--nested">
1562 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1564 <label class=
"md-nav__link" for=
"__nav_6_4">
1565 Migrating from WSC
3.0
1566 <span class=
"md-nav__icon md-icon"></span>
1568 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1569 <label class=
"md-nav__title" for=
"__nav_6_4">
1570 <span class=
"md-nav__icon md-icon"></span>
1571 Migrating from WSC
3.0
1573 <ul class=
"md-nav__list" data-md-scrollfix
>
1579 <li class=
"md-nav__item">
1580 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1591 <li class=
"md-nav__item">
1592 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1603 <li class=
"md-nav__item">
1604 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1615 <li class=
"md-nav__item">
1616 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1627 <li class=
"md-nav__item">
1628 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1646 <li class=
"md-nav__item md-nav__item--nested">
1649 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1651 <label class=
"md-nav__link" for=
"__nav_6_5">
1652 Migrating from WCF
2.1
1653 <span class=
"md-nav__icon md-icon"></span>
1655 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1656 <label class=
"md-nav__title" for=
"__nav_6_5">
1657 <span class=
"md-nav__icon md-icon"></span>
1658 Migrating from WCF
2.1
1660 <ul class=
"md-nav__list" data-md-scrollfix
>
1666 <li class=
"md-nav__item">
1667 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1678 <li class=
"md-nav__item">
1679 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1690 <li class=
"md-nav__item">
1691 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1702 <li class=
"md-nav__item">
1703 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1730 <li class=
"md-nav__item md-nav__item--nested">
1733 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1735 <label class=
"md-nav__link" for=
"__nav_7">
1737 <span class=
"md-nav__icon md-icon"></span>
1739 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1740 <label class=
"md-nav__title" for=
"__nav_7">
1741 <span class=
"md-nav__icon md-icon"></span>
1744 <ul class=
"md-nav__list" data-md-scrollfix
>
1751 <li class=
"md-nav__item md-nav__item--nested">
1754 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1756 <label class=
"md-nav__link" for=
"__nav_7_1">
1758 <span class=
"md-nav__icon md-icon"></span>
1760 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1761 <label class=
"md-nav__title" for=
"__nav_7_1">
1762 <span class=
"md-nav__icon md-icon"></span>
1765 <ul class=
"md-nav__list" data-md-scrollfix
>
1771 <li class=
"md-nav__item">
1772 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1783 <li class=
"md-nav__item">
1784 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1795 <li class=
"md-nav__item">
1796 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1807 <li class=
"md-nav__item">
1808 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1835 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1836 <div class=
"md-sidebar__scrollwrap">
1837 <div class=
"md-sidebar__inner">
1839 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1845 <label class=
"md-nav__title" for=
"__toc">
1846 <span class=
"md-nav__icon md-icon"></span>
1849 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1851 <li class=
"md-nav__item">
1852 <a href=
"#database-tables" class=
"md-nav__link">
1858 <li class=
"md-nav__item">
1859 <a href=
"#columns" class=
"md-nav__link">
1865 <li class=
"md-nav__item">
1866 <a href=
"#foreign-keys" class=
"md-nav__link">
1872 <li class=
"md-nav__item">
1873 <a href=
"#indices" class=
"md-nav__link">
1887 <div class=
"md-content" data-md-component=
"content">
1888 <article class=
"md-content__inner md-typeset">
1891 <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">
1892 <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>
1896 <h1 id=
"database-php-api">Database PHP API
<a class=
"headerlink" href=
"#database-php-api" title=
"Permanent link">#
</a></h1>
1897 <div class=
"admonition info">
1898 <p class=
"admonition-title">Available since WoltLab Suite
5.2.
</p>
1900 <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.
1901 We have added a new PHP-based API to manipulate the database scheme which can be used in combination with the
<a href=
"../pip/script/">script
</a> package installation plugin that skips parts that already exist:
</p>
1902 <div class=
"highlight"><pre><span></span><code><span class=
"nv">$tables
</span> <span class=
"o">=
</span> <span class=
"p">[
</span>
1903 <span class=
"c1">// list of `DatabaseTable` objects
</span>
1904 <span class=
"p">];
</span>
1906 <span class=
"p">(
</span><span class=
"k">new
</span> <span class=
"nx">DatabaseTableChangeProcessor
</span><span class=
"p">(
</span>
1907 <span class=
"sd">/** @var ScriptPackageInstallationPlugin $this */
</span>
1908 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">installation
</span><span class=
"o">-
></span><span class=
"na">getPackage
</span><span class=
"p">(),
</span>
1909 <span class=
"nv">$tables
</span><span class=
"p">,
</span>
1910 <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getDB
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getEditor
</span><span class=
"p">())
</span>
1911 <span class=
"p">)
</span><span class=
"o">-
></span><span class=
"na">process
</span><span class=
"p">();
</span>
1913 <p>All of the relevant components can be found in the
<code>wcf\system\database\table
</code> namespace.
</p>
1914 <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>
1915 <div class=
"highlight"><pre><span></span><code><span class=
"k">return
</span> <span class=
"p">[
</span>
1916 <span class=
"c1">// list of `DatabaseTable` objects
</span>
1917 <span class=
"p">];
</span>
1919 <h2 id=
"database-tables">Database Tables
<a class=
"headerlink" href=
"#database-tables" title=
"Permanent link">#
</a></h2>
1920 <p>There are two classes representing database tables:
<code>DatabaseTable
</code> and
<code>PartialDatabaseTable
</code>.
1921 If a new table should be created, use
<code>DatabaseTable
</code>.
1922 In all other cases,
<code>PartialDatabaseTable
</code> should be used as it provides an additional save-guard against accidentally creating a new table by having a typo in the table name:
1923 If the tables does not already exist, a table represented by
<code>PartialDatabaseTable
</code> will cause an exception (while a
<code>DatabaseTable
</code> table will simply be created).
</p>
1924 <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>
1925 <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">'foo1_bar
'</span><span class=
"p">)
</span>
1926 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span>
1927 <span class=
"c1">// columns
</span>
1928 <span class=
"p">])
</span>
1929 <span class=
"o">-
></span><span class=
"na">foreignKeys
</span><span class=
"p">([
</span>
1930 <span class=
"c1">// foreign keys
</span>
1931 <span class=
"p">])
</span>
1932 <span class=
"o">-
></span><span class=
"na">indices
</span><span class=
"p">([
</span>
1933 <span class=
"c1">// indices
</span>
1934 <span class=
"p">])
</span>
1936 <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>
1937 <p>To drop a table, only the
<code>drop()
</code> method has to be called:
</p>
1938 <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">'foo1_bar
'</span><span class=
"p">)
</span>
1939 <span class=
"o">-
></span><span class=
"na">drop
</span><span class=
"p">()
</span>
1941 <h2 id=
"columns">Columns
<a class=
"headerlink" href=
"#columns" title=
"Permanent link">#
</a></h2>
1942 <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.
1943 Such instances are created similarly to database table objects using the
<code>create()
</code> factory method and passing the column name as the parameter.
</p>
1944 <p>Every column type supports the following methods:
</p>
1946 <li><code>defaultValue($defaultValue)
</code> sets the default value of the column (default: none).
</li>
1947 <li><code>drop()
</code> to drop the column.
</li>
1948 <li><code>notNull($notNull = true)
</code> sets if the value of the column can be
<code>NULL
</code> (default:
<code>false
</code>).
</li>
1950 <p>Depending on the specific column class implementing additional interfaces, the following methods are also available:
</p>
1952 <li><code>IAutoIncrementDatabaseTableColumn::autoIncrement($autoIncrement = true)
</code> sets if the value of the colum is auto-incremented.
</li>
1953 <li><code>IDecimalsDatabaseTableColumn::decimals($decimals)
</code> sets the number of decimals the column supports.
</li>
1954 <li><code>IEnumDatabaseTableColumn::enumValues(array $values)
</code> sets the predetermined set of valid values of the column.
</li>
1955 <li><code>ILengthDatabaseTableColumn::length($length)
</code> sets the (maximum) length of the column.
</li>
1957 <p>Additionally, there are some additionally classes of commonly used columns with specific properties:
</p>
1959 <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>
1960 <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>
1961 <li><code>NotNullInt10DatabaseTableColumn
</code> (a
<code>int
</code> column with length
<code>10</code> and whose values cannot be
<code>null
</code>)
</li>
1962 <li><code>NotNullVarchar191DatabaseTableColumn
</code> (a
<code>varchar
</code> column with length
<code>191</code> and whose values cannot be
<code>null
</code>)
</li>
1963 <li><code>NotNullVarchar255DatabaseTableColumn
</code> (a
<code>varchar
</code> column with length
<code>255</code> and whose values cannot be
<code>null
</code>)
</li>
1964 <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>
1967 <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">'isDisabled
'</span><span class=
"p">)
</span>
1969 <span class=
"nx">NotNullInt10DatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'fooTypeID
'</span><span class=
"p">)
</span>
1971 <span class=
"nx">SmallintDatabaseTableColumn
</span><span class=
"o">::
</span><span class=
"na">create
</span><span class=
"p">(
</span><span class=
"s1">'bar
'</span><span class=
"p">)
</span>
1972 <span class=
"o">-
></span><span class=
"na">length
</span><span class=
"p">(
</span><span class=
"mi">5</span><span class=
"p">)
</span>
1973 <span class=
"o">-
></span><span class=
"na">notNull
</span><span class=
"p">()
</span>
1975 <h2 id=
"foreign-keys">Foreign Keys
<a class=
"headerlink" href=
"#foreign-keys" title=
"Permanent link">#
</a></h2>
1976 <p>Foreign keys are represented by
<code>DatabaseTableForeignKey
</code> objects:
</p>
1977 <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>
1978 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
1979 <span class=
"o">-
></span><span class=
"na">referencedTable
</span><span class=
"p">(
</span><span class=
"s1">'wcf1_foo
'</span><span class=
"p">)
</span>
1980 <span class=
"o">-
></span><span class=
"na">referencedColumns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
1981 <span class=
"o">-
></span><span class=
"na">onDelete
</span><span class=
"p">(
</span><span class=
"s1">'CASCADE
'</span><span class=
"p">)
</span>
1983 <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>.
1984 To drop a foreign key, all of the relevant data to create the foreign key has to be present and the
<code>drop()
</code> method has to be called.
</p>
1985 <p><code>DatabaseTableForeignKey::create()
</code> also supports the foreign key name as a parameter.
1986 If it is not present,
<code>DatabaseTable::foreignKeys()
</code> will automatically set one based on the foreign key's data.
</p>
1987 <h2 id=
"indices">Indices
<a class=
"headerlink" href=
"#indices" title=
"Permanent link">#
</a></h2>
1988 <p>Indices are represented by
<code>DatabaseTableIndex
</code> objects:
</p>
1989 <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>
1990 <span class=
"o">-
></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>
1991 <span class=
"o">-
></span><span class=
"na">columns
</span><span class=
"p">([
</span><span class=
"s1">'fooID
'</span><span class=
"p">])
</span>
1993 <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>.
1994 For primary keys, there is also the
<code>DatabaseTablePrimaryIndex
</code> class which automatically sets the type to
<code>DatabaseTableIndex::PRIMARY_TYPE
</code>.
1995 To drop a index, all of the relevant data to create the index has to be present and the
<code>drop()
</code> method has to be called.
</p>
1996 <p><code>DatabaseTableIndex::create()
</code> also supports the index name as a parameter.
1997 If it is not present,
<code>DatabaseTable::indices()
</code> will automatically set one based on the index data.
</p>
2003 <div class=
"md-source-date">
2006 Last update:
2021-
03-
16
2025 <footer class=
"md-footer">
2027 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2029 <a href=
"../pip/user-profile-menu/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2030 <div class=
"md-footer__button md-icon">
2031 <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>
2033 <div class=
"md-footer__title">
2034 <div class=
"md-ellipsis">
2035 <span class=
"md-footer__direction">
2044 <a href=
"../../migration/wsc53/php/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2045 <div class=
"md-footer__title">
2046 <div class=
"md-ellipsis">
2047 <span class=
"md-footer__direction">
2053 <div class=
"md-footer__button md-icon">
2054 <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>
2060 <div class=
"md-footer-meta md-typeset">
2061 <div class=
"md-footer-meta__inner md-grid">
2062 <div class=
"md-footer-copyright">
2064 <div class=
"md-footer-copyright__highlight">
2065 Copyright ©
2020 WoltLab GmbH
2069 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2074 <div class=
"md-footer-copyright">
2075 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2076 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2083 <div class=
"md-dialog" data-md-component=
"dialog">
2084 <div class=
"md-dialog__inner md-typeset"></div>
2086 <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>
2089 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>