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>Pages - 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=
"#page-types" 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">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item md-nav__item--active">
246 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
251 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
253 <span class=
"md-nav__icon md-icon"></span>
256 <a href=
"./" class=
"md-nav__link md-nav__link--active">
261 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
267 <label class=
"md-nav__title" for=
"__toc">
268 <span class=
"md-nav__icon md-icon"></span>
271 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
273 <li class=
"md-nav__item">
274 <a href=
"#abstractpage" class=
"md-nav__link">
278 <nav class=
"md-nav" aria-label=
"AbstractPage">
279 <ul class=
"md-nav__list">
281 <li class=
"md-nav__item">
282 <a href=
"#method-chain" class=
"md-nav__link">
286 <nav class=
"md-nav" aria-label=
"Method Chain">
287 <ul class=
"md-nav__list">
289 <li class=
"md-nav__item">
290 <a href=
"#__run" class=
"md-nav__link">
296 <li class=
"md-nav__item">
297 <a href=
"#readparameters" class=
"md-nav__link">
303 <li class=
"md-nav__item">
304 <a href=
"#show" class=
"md-nav__link">
310 <li class=
"md-nav__item">
311 <a href=
"#readdata" class=
"md-nav__link">
317 <li class=
"md-nav__item">
318 <a href=
"#assignvariables" class=
"md-nav__link">
334 <li class=
"md-nav__item">
335 <a href=
"#abstractform" class=
"md-nav__link">
339 <nav class=
"md-nav" aria-label=
"AbstractForm">
340 <ul class=
"md-nav__list">
342 <li class=
"md-nav__item">
343 <a href=
"#method-chain_1" class=
"md-nav__link">
347 <nav class=
"md-nav" aria-label=
"Method Chain">
348 <ul class=
"md-nav__list">
350 <li class=
"md-nav__item">
351 <a href=
"#__run_1" class=
"md-nav__link">
357 <li class=
"md-nav__item">
358 <a href=
"#readparameters_1" class=
"md-nav__link">
364 <li class=
"md-nav__item">
365 <a href=
"#show_1" class=
"md-nav__link">
371 <li class=
"md-nav__item">
372 <a href=
"#submit" class=
"md-nav__link">
378 <li class=
"md-nav__item">
379 <a href=
"#readformparameters" class=
"md-nav__link">
385 <li class=
"md-nav__item">
386 <a href=
"#validate" class=
"md-nav__link">
392 <li class=
"md-nav__item">
393 <a href=
"#save" class=
"md-nav__link">
399 <li class=
"md-nav__item">
400 <a href=
"#saved" class=
"md-nav__link">
406 <li class=
"md-nav__item">
407 <a href=
"#readdata_1" class=
"md-nav__link">
413 <li class=
"md-nav__item">
414 <a href=
"#assignvariables_1" class=
"md-nav__link">
442 <li class=
"md-nav__item">
443 <a href=
"../database-objects/" class=
"md-nav__link">
454 <li class=
"md-nav__item">
455 <a href=
"../database-access/" class=
"md-nav__link">
466 <li class=
"md-nav__item">
467 <a href=
"../exceptions/" class=
"md-nav__link">
479 <li class=
"md-nav__item md-nav__item--nested">
482 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
484 <label class=
"md-nav__link" for=
"__nav_2_5">
486 <span class=
"md-nav__icon md-icon"></span>
488 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
489 <label class=
"md-nav__title" for=
"__nav_2_5">
490 <span class=
"md-nav__icon md-icon"></span>
493 <ul class=
"md-nav__list" data-md-scrollfix
>
500 <li class=
"md-nav__item md-nav__item--nested">
503 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
505 <label class=
"md-nav__link" for=
"__nav_2_5_1">
507 <span class=
"md-nav__icon md-icon"></span>
509 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
510 <label class=
"md-nav__title" for=
"__nav_2_5_1">
511 <span class=
"md-nav__icon md-icon"></span>
514 <ul class=
"md-nav__list" data-md-scrollfix
>
520 <li class=
"md-nav__item">
521 <a href=
"../api/caches/" class=
"md-nav__link">
532 <li class=
"md-nav__item">
533 <a href=
"../api/caches_persistent-caches/" class=
"md-nav__link">
544 <li class=
"md-nav__item">
545 <a href=
"../api/caches_runtime-caches/" class=
"md-nav__link">
562 <li class=
"md-nav__item">
563 <a href=
"../api/comments/" class=
"md-nav__link">
574 <li class=
"md-nav__item">
575 <a href=
"../api/cronjobs/" class=
"md-nav__link">
586 <li class=
"md-nav__item">
587 <a href=
"../api/events/" class=
"md-nav__link">
599 <li class=
"md-nav__item md-nav__item--nested">
602 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
604 <label class=
"md-nav__link" for=
"__nav_2_5_5">
606 <span class=
"md-nav__icon md-icon"></span>
608 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
609 <label class=
"md-nav__title" for=
"__nav_2_5_5">
610 <span class=
"md-nav__icon md-icon"></span>
613 <ul class=
"md-nav__list" data-md-scrollfix
>
619 <li class=
"md-nav__item">
620 <a href=
"../api/form_builder/overview/" class=
"md-nav__link">
631 <li class=
"md-nav__item">
632 <a href=
"../api/form_builder/structure/" class=
"md-nav__link">
643 <li class=
"md-nav__item">
644 <a href=
"../api/form_builder/form_fields/" class=
"md-nav__link">
655 <li class=
"md-nav__item">
656 <a href=
"../api/form_builder/validation_data/" class=
"md-nav__link">
667 <li class=
"md-nav__item">
668 <a href=
"../api/form_builder/dependencies/" class=
"md-nav__link">
685 <li class=
"md-nav__item">
686 <a href=
"../api/package_installation_plugins/" class=
"md-nav__link">
687 Package Installation Plugins
697 <li class=
"md-nav__item">
698 <a href=
"../api/user_activity_points/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../api/user_notifications/" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"../api/sitemaps/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../code-style/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../apps/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../gdpr/" class=
"md-nav__link">
785 <li class=
"md-nav__item md-nav__item--nested">
788 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
790 <label class=
"md-nav__link" for=
"__nav_3">
791 Languages, Templates & CSS
792 <span class=
"md-nav__icon md-icon"></span>
794 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
795 <label class=
"md-nav__title" for=
"__nav_3">
796 <span class=
"md-nav__icon md-icon"></span>
797 Languages, Templates & CSS
799 <ul class=
"md-nav__list" data-md-scrollfix
>
805 <li class=
"md-nav__item">
806 <a href=
"../../view/languages/" class=
"md-nav__link">
817 <li class=
"md-nav__item">
818 <a href=
"../../view/templates/" class=
"md-nav__link">
829 <li class=
"md-nav__item">
830 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
841 <li class=
"md-nav__item">
842 <a href=
"../../view/css/" class=
"md-nav__link">
863 <li class=
"md-nav__item md-nav__item--nested">
866 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
868 <label class=
"md-nav__link" for=
"__nav_4">
869 TypeScript and JavaScript API
870 <span class=
"md-nav__icon md-icon"></span>
872 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
873 <label class=
"md-nav__title" for=
"__nav_4">
874 <span class=
"md-nav__icon md-icon"></span>
875 TypeScript and JavaScript API
877 <ul class=
"md-nav__list" data-md-scrollfix
>
883 <li class=
"md-nav__item">
884 <a href=
"../../javascript/general-usage/" class=
"md-nav__link">
895 <li class=
"md-nav__item">
896 <a href=
"../../javascript/typescript/" class=
"md-nav__link">
908 <li class=
"md-nav__item md-nav__item--nested">
911 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
913 <label class=
"md-nav__link" for=
"__nav_4_3">
915 <span class=
"md-nav__icon md-icon"></span>
917 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
918 <label class=
"md-nav__title" for=
"__nav_4_3">
919 <span class=
"md-nav__icon md-icon"></span>
922 <ul class=
"md-nav__list" data-md-scrollfix
>
928 <li class=
"md-nav__item">
929 <a href=
"../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../../javascript/new-api_data-structures/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../javascript/new-api_core/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../javascript/new-api_dom/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../javascript/new-api_events/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../javascript/new-api_ajax/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../javascript/new-api_dialogs/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../javascript/new-api_browser/" class=
"md-nav__link">
1014 Browser and Screen Sizes
1024 <li class=
"md-nav__item">
1025 <a href=
"../../javascript/new-api_ui/" class=
"md-nav__link">
1042 <li class=
"md-nav__item">
1043 <a href=
"../../javascript/legacy-api/" class=
"md-nav__link">
1054 <li class=
"md-nav__item">
1055 <a href=
"../../javascript/helper-functions/" class=
"md-nav__link">
1066 <li class=
"md-nav__item">
1067 <a href=
"../../javascript/code-snippets/" class=
"md-nav__link">
1088 <li class=
"md-nav__item md-nav__item--nested">
1091 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1093 <label class=
"md-nav__link" for=
"__nav_5">
1095 <span class=
"md-nav__icon md-icon"></span>
1097 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1098 <label class=
"md-nav__title" for=
"__nav_5">
1099 <span class=
"md-nav__icon md-icon"></span>
1102 <ul class=
"md-nav__list" data-md-scrollfix
>
1108 <li class=
"md-nav__item">
1109 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1121 <li class=
"md-nav__item md-nav__item--nested">
1124 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1126 <label class=
"md-nav__link" for=
"__nav_5_2">
1128 <span class=
"md-nav__icon md-icon"></span>
1130 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1131 <label class=
"md-nav__title" for=
"__nav_5_2">
1132 <span class=
"md-nav__icon md-icon"></span>
1135 <ul class=
"md-nav__list" data-md-scrollfix
>
1141 <li class=
"md-nav__item">
1142 <a href=
"../../package/pip/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1189 <li class=
"md-nav__item">
1190 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1237 <li class=
"md-nav__item">
1238 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1249 <li class=
"md-nav__item">
1250 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1261 <li class=
"md-nav__item">
1262 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1321 <li class=
"md-nav__item">
1322 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1333 <li class=
"md-nav__item">
1334 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1357 <li class=
"md-nav__item">
1358 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1359 objectTypeDefinition
1369 <li class=
"md-nav__item">
1370 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1405 <li class=
"md-nav__item">
1406 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1417 <li class=
"md-nav__item">
1418 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1429 <li class=
"md-nav__item">
1430 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1453 <li class=
"md-nav__item">
1454 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1489 <li class=
"md-nav__item">
1490 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1501 <li class=
"md-nav__item">
1502 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1503 userNotificationEvent
1513 <li class=
"md-nav__item">
1514 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1525 <li class=
"md-nav__item">
1526 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1543 <li class=
"md-nav__item">
1544 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1565 <li class=
"md-nav__item md-nav__item--nested">
1568 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1570 <label class=
"md-nav__link" for=
"__nav_6">
1572 <span class=
"md-nav__icon md-icon"></span>
1574 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1575 <label class=
"md-nav__title" for=
"__nav_6">
1576 <span class=
"md-nav__icon md-icon"></span>
1579 <ul class=
"md-nav__list" data-md-scrollfix
>
1586 <li class=
"md-nav__item md-nav__item--nested">
1589 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1591 <label class=
"md-nav__link" for=
"__nav_6_1">
1592 Migrating from WSC
5.3
1593 <span class=
"md-nav__icon md-icon"></span>
1595 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1596 <label class=
"md-nav__title" for=
"__nav_6_1">
1597 <span class=
"md-nav__icon md-icon"></span>
1598 Migrating from WSC
5.3
1600 <ul class=
"md-nav__list" data-md-scrollfix
>
1606 <li class=
"md-nav__item">
1607 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1618 <li class=
"md-nav__item">
1619 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1620 Session Handling and Authentication
1630 <li class=
"md-nav__item">
1631 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1632 TypeScript and JavaScript
1642 <li class=
"md-nav__item">
1643 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1656 Third Party Libraries
1673 <li class=
"md-nav__item md-nav__item--nested">
1676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1678 <label class=
"md-nav__link" for=
"__nav_6_2">
1679 Migrating from WSC
5.2
1680 <span class=
"md-nav__icon md-icon"></span>
1682 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1683 <label class=
"md-nav__title" for=
"__nav_6_2">
1684 <span class=
"md-nav__icon md-icon"></span>
1685 Migrating from WSC
5.2
1687 <ul class=
"md-nav__list" data-md-scrollfix
>
1693 <li class=
"md-nav__item">
1694 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1705 <li class=
"md-nav__item">
1706 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1707 Templates and Languages
1717 <li class=
"md-nav__item">
1718 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1719 Third Party Libraries
1736 <li class=
"md-nav__item md-nav__item--nested">
1739 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1741 <label class=
"md-nav__link" for=
"__nav_6_3">
1742 Migrating from WSC
3.1
1743 <span class=
"md-nav__icon md-icon"></span>
1745 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1746 <label class=
"md-nav__title" for=
"__nav_6_3">
1747 <span class=
"md-nav__icon md-icon"></span>
1748 Migrating from WSC
3.1
1750 <ul class=
"md-nav__list" data-md-scrollfix
>
1756 <li class=
"md-nav__item">
1757 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1775 <li class=
"md-nav__item md-nav__item--nested">
1778 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1780 <label class=
"md-nav__link" for=
"__nav_6_4">
1781 Migrating from WSC
3.0
1782 <span class=
"md-nav__icon md-icon"></span>
1784 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1785 <label class=
"md-nav__title" for=
"__nav_6_4">
1786 <span class=
"md-nav__icon md-icon"></span>
1787 Migrating from WSC
3.0
1789 <ul class=
"md-nav__list" data-md-scrollfix
>
1795 <li class=
"md-nav__item">
1796 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1807 <li class=
"md-nav__item">
1808 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1819 <li class=
"md-nav__item">
1820 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1831 <li class=
"md-nav__item">
1832 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1843 <li class=
"md-nav__item">
1844 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1862 <li class=
"md-nav__item md-nav__item--nested">
1865 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1867 <label class=
"md-nav__link" for=
"__nav_6_5">
1868 Migrating from WCF
2.1
1869 <span class=
"md-nav__icon md-icon"></span>
1871 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1872 <label class=
"md-nav__title" for=
"__nav_6_5">
1873 <span class=
"md-nav__icon md-icon"></span>
1874 Migrating from WCF
2.1
1876 <ul class=
"md-nav__list" data-md-scrollfix
>
1882 <li class=
"md-nav__item">
1883 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1894 <li class=
"md-nav__item">
1895 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1906 <li class=
"md-nav__item">
1907 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1946 <li class=
"md-nav__item md-nav__item--nested">
1949 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1951 <label class=
"md-nav__link" for=
"__nav_7">
1953 <span class=
"md-nav__icon md-icon"></span>
1955 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1956 <label class=
"md-nav__title" for=
"__nav_7">
1957 <span class=
"md-nav__icon md-icon"></span>
1960 <ul class=
"md-nav__list" data-md-scrollfix
>
1967 <li class=
"md-nav__item md-nav__item--nested">
1970 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1972 <label class=
"md-nav__link" for=
"__nav_7_1">
1974 <span class=
"md-nav__icon md-icon"></span>
1976 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1977 <label class=
"md-nav__title" for=
"__nav_7_1">
1978 <span class=
"md-nav__icon md-icon"></span>
1981 <ul class=
"md-nav__list" data-md-scrollfix
>
1987 <li class=
"md-nav__item">
1988 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1999 <li class=
"md-nav__item">
2000 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
2011 <li class=
"md-nav__item">
2012 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
2023 <li class=
"md-nav__item">
2024 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
2051 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2052 <div class=
"md-sidebar__scrollwrap">
2053 <div class=
"md-sidebar__inner">
2055 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2061 <label class=
"md-nav__title" for=
"__toc">
2062 <span class=
"md-nav__icon md-icon"></span>
2065 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2067 <li class=
"md-nav__item">
2068 <a href=
"#abstractpage" class=
"md-nav__link">
2072 <nav class=
"md-nav" aria-label=
"AbstractPage">
2073 <ul class=
"md-nav__list">
2075 <li class=
"md-nav__item">
2076 <a href=
"#method-chain" class=
"md-nav__link">
2080 <nav class=
"md-nav" aria-label=
"Method Chain">
2081 <ul class=
"md-nav__list">
2083 <li class=
"md-nav__item">
2084 <a href=
"#__run" class=
"md-nav__link">
2090 <li class=
"md-nav__item">
2091 <a href=
"#readparameters" class=
"md-nav__link">
2097 <li class=
"md-nav__item">
2098 <a href=
"#show" class=
"md-nav__link">
2104 <li class=
"md-nav__item">
2105 <a href=
"#readdata" class=
"md-nav__link">
2111 <li class=
"md-nav__item">
2112 <a href=
"#assignvariables" class=
"md-nav__link">
2128 <li class=
"md-nav__item">
2129 <a href=
"#abstractform" class=
"md-nav__link">
2133 <nav class=
"md-nav" aria-label=
"AbstractForm">
2134 <ul class=
"md-nav__list">
2136 <li class=
"md-nav__item">
2137 <a href=
"#method-chain_1" class=
"md-nav__link">
2141 <nav class=
"md-nav" aria-label=
"Method Chain">
2142 <ul class=
"md-nav__list">
2144 <li class=
"md-nav__item">
2145 <a href=
"#__run_1" class=
"md-nav__link">
2151 <li class=
"md-nav__item">
2152 <a href=
"#readparameters_1" class=
"md-nav__link">
2158 <li class=
"md-nav__item">
2159 <a href=
"#show_1" class=
"md-nav__link">
2165 <li class=
"md-nav__item">
2166 <a href=
"#submit" class=
"md-nav__link">
2172 <li class=
"md-nav__item">
2173 <a href=
"#readformparameters" class=
"md-nav__link">
2174 readFormParameters()
2179 <li class=
"md-nav__item">
2180 <a href=
"#validate" class=
"md-nav__link">
2186 <li class=
"md-nav__item">
2187 <a href=
"#save" class=
"md-nav__link">
2193 <li class=
"md-nav__item">
2194 <a href=
"#saved" class=
"md-nav__link">
2200 <li class=
"md-nav__item">
2201 <a href=
"#readdata_1" class=
"md-nav__link">
2207 <li class=
"md-nav__item">
2208 <a href=
"#assignvariables_1" class=
"md-nav__link">
2232 <div class=
"md-content" data-md-component=
"content">
2233 <article class=
"md-content__inner md-typeset">
2236 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/pages.md" title=
"Edit this page" class=
"md-content__button md-icon">
2237 <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>
2241 <h1 id=
"page-types">Page Types
<a class=
"headerlink" href=
"#page-types" title=
"Permanent link">#
</a></h1>
2242 <h2 id=
"abstractpage">AbstractPage
<a class=
"headerlink" href=
"#abstractpage" title=
"Permanent link">#
</a></h2>
2243 <p>The default implementation for pages to present any sort of content, but are designed to handle
<code>GET
</code> requests only. They usually follow a fixed method chain that will be invoked one after another, adding logical sections to the request flow.
</p>
2244 <h3 id=
"method-chain">Method Chain
<a class=
"headerlink" href=
"#method-chain" title=
"Permanent link">#
</a></h3>
2245 <h4 id=
"__run">__run()
<a class=
"headerlink" href=
"#__run" title=
"Permanent link">#
</a></h4>
2246 <p>This is the only method being invoked from the outside and starts the whole chain.
</p>
2247 <h4 id=
"readparameters">readParameters()
<a class=
"headerlink" href=
"#readparameters" title=
"Permanent link">#
</a></h4>
2248 <p>Reads and sanitizes request parameters, this should be the only method to ever read user-supplied input. Read data should be stored in class properties to be accessible at a later point, allowing your code to safely assume that the data has been sanitized and is safe to work with.
</p>
2249 <p>A typical example is the board page from the forum app that reads the id and attempts to identify the request forum.
</p>
2250 <div class=
"highlight"><pre><span></span><code><span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">readParameters
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2251 <span class=
"k">parent
</span><span class=
"o">::
</span><span class=
"na">readParameters
</span><span class=
"p">();
</span>
2253 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nb">isset
</span><span class=
"p">(
</span><span class=
"nv">$_REQUEST
</span><span class=
"p">[
</span><span class=
"s1">'id
'</span><span class=
"p">]))
</span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">boardID
</span> <span class=
"o">=
</span> <span class=
"nb">intval
</span><span class=
"p">(
</span><span class=
"nv">$_REQUEST
</span><span class=
"p">[
</span><span class=
"s1">'id
'</span><span class=
"p">]);
</span>
2254 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">board
</span> <span class=
"o">=
</span> <span class=
"nx">BoardCache
</span><span class=
"o">::
</span><span class=
"na">getInstance
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">getBoard
</span><span class=
"p">(
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">boardID
</span><span class=
"p">);
</span>
2255 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">board
</span> <span class=
"o">===
</span> <span class=
"k">null
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2256 <span class=
"k">throw
</span> <span class=
"k">new
</span> <span class=
"nx">IllegalLinkException
</span><span class=
"p">();
</span>
2257 <span class=
"p">}
</span>
2259 <span class=
"c1">// check permissions
</span>
2260 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"o">!
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">board
</span><span class=
"o">-
></span><span class=
"na">canEnter
</span><span class=
"p">())
</span> <span class=
"p">{
</span>
2261 <span class=
"k">throw
</span> <span class=
"k">new
</span> <span class=
"nx">PermissionDeniedException
</span><span class=
"p">();
</span>
2262 <span class=
"p">}
</span>
2263 <span class=
"p">}
</span>
2265 <p><span class=
"label label-info">Events
</span> <code>readParameters
</code></p>
2266 <h4 id=
"show">show()
<a class=
"headerlink" href=
"#show" title=
"Permanent link">#
</a></h4>
2267 <p>Used to be the method of choice to handle permissions and module option checks, but has been used almost entirely as an internal method since the introduction of the properties
<code>$loginRequired
</code>,
<code>$neededModules
</code> and
<code>$neededPermissions
</code>.
</p>
2268 <p><span class=
"label label-info">Events
</span> <code>checkModules
</code>,
<code>checkPermissions
</code> and
<code>show
</code></p>
2269 <h4 id=
"readdata">readData()
<a class=
"headerlink" href=
"#readdata" title=
"Permanent link">#
</a></h4>
2270 <p>Central method for data retrieval based on class properties including those populated with user data in
<code>readParameters()
</code>. It is strongly recommended to use this method to read data in order to properly separate the business logic present in your class.
</p>
2271 <p><span class=
"label label-info">Events
</span> <code>readData
</code></p>
2272 <h4 id=
"assignvariables">assignVariables()
<a class=
"headerlink" href=
"#assignvariables" title=
"Permanent link">#
</a></h4>
2273 <p>Last method call before the template engine kicks in and renders the template. All though some properties are bound to the template automatically, you still need to pass any custom variables and class properties to the engine to make them available in templates.
</p>
2274 <p>Following the example in
<code>readParameters()
</code>, the code below adds the board data to the template.
</p>
2275 <div class=
"highlight"><pre><span></span><code><span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">assignVariables
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2276 <span class=
"k">parent
</span><span class=
"o">::
</span><span class=
"na">assignVariables
</span><span class=
"p">();
</span>
2278 <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getTPL
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">assign
</span><span class=
"p">([
</span>
2279 <span class=
"s1">'board
'</span> <span class=
"o">=
></span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">board
</span><span class=
"p">,
</span>
2280 <span class=
"s1">'boardID
'</span> <span class=
"o">=
></span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">boardID
</span>
2281 <span class=
"p">]);
</span>
2282 <span class=
"p">}
</span>
2284 <p><span class=
"label label-info">Events
</span> <code>assignVariables
</code></p>
2285 <h2 id=
"abstractform">AbstractForm
<a class=
"headerlink" href=
"#abstractform" title=
"Permanent link">#
</a></h2>
2286 <p>Extends the AbstractPage implementation with additional methods designed to handle form submissions properly.
</p>
2287 <h3 id=
"method-chain_1">Method Chain
<a class=
"headerlink" href=
"#method-chain_1" title=
"Permanent link">#
</a></h3>
2288 <h4 id=
"__run_1">__run()
<a class=
"headerlink" href=
"#__run_1" title=
"Permanent link">#
</a></h4>
2289 <p><em>Inherited from AbstractPage.
</em></p>
2290 <h4 id=
"readparameters_1">readParameters()
<a class=
"headerlink" href=
"#readparameters_1" title=
"Permanent link">#
</a></h4>
2291 <p><em>Inherited from AbstractPage.
</em></p>
2292 <h4 id=
"show_1">show()
<a class=
"headerlink" href=
"#show_1" title=
"Permanent link">#
</a></h4>
2293 <p><em>Inherited from AbstractPage.
</em></p>
2294 <h4 id=
"submit">submit()
<a class=
"headerlink" href=
"#submit" title=
"Permanent link">#
</a></h4>
2295 <div class=
"admonition warning">
2296 <p class=
"admonition-title">The methods
<code>submit()
</code> up until
<code>save()
</code> are only invoked if either
<code>$_POST
</code> or
<code>$_FILES
</code> are not empty, otherwise they won't be invoked and the execution will continue with
<code>readData()
</code>.
</p>
2298 <p>This is an internal method that is responsible of input processing and validation.
</p>
2299 <p><span class=
"label label-info">Events
</span> <code>submit
</code></p>
2300 <h4 id=
"readformparameters">readFormParameters()
<a class=
"headerlink" href=
"#readformparameters" title=
"Permanent link">#
</a></h4>
2301 <p>This method is quite similar to
<code>readParameters()
</code> that is being called earlier, but is designed around reading form data submitted through POST requests. You should avoid accessing
<code>$_GET
</code> or
<code>$_REQUEST
</code> in this context to avoid mixing up parameters evaluated when retrieving the page on first load and when submitting to it.
</p>
2302 <p><span class=
"label label-info">Events
</span> <code>readFormParameters
</code></p>
2303 <h4 id=
"validate">validate()
<a class=
"headerlink" href=
"#validate" title=
"Permanent link">#
</a></h4>
2304 <p>Deals with input validation and automatically catches exceptions deriving from
<code>wcf\system\exception\UserInputException
</code>, resulting in a clean and consistent error handling for the user.
</p>
2305 <p><span class=
"label label-info">Events
</span> <code>validate
</code></p>
2306 <h4 id=
"save">save()
<a class=
"headerlink" href=
"#save" title=
"Permanent link">#
</a></h4>
2307 <p>Saves the processed data to database or any other source of your choice. Please keep in mind to invoke
<code>$this-
>saved()
</code> before resetting the form data.
</p>
2308 <p><span class=
"label label-info">Events
</span> <code>save
</code></p>
2309 <h4 id=
"saved">saved()
<a class=
"headerlink" href=
"#saved" title=
"Permanent link">#
</a></h4>
2310 <div class=
"admonition warning">
2311 <p class=
"admonition-title">This method is not called automatically and must be invoked manually by executing
<code>$this-
>saved()
</code> inside
<code>save()
</code>.
</p>
2313 <p>The only purpose of this method is to fire the event
<code>saved
</code> that signals that the form data has been processed successfully and data has been saved. It is somewhat special as it is dispatched after the data has been saved, but before the data is purged during form reset. This is by default the last event that has access to the processed data.
</p>
2314 <p><span class=
"label label-info">Events
</span> <code>saved
</code></p>
2315 <h4 id=
"readdata_1">readData()
<a class=
"headerlink" href=
"#readdata_1" title=
"Permanent link">#
</a></h4>
2316 <p><em>Inherited from AbstractPage.
</em></p>
2317 <h4 id=
"assignvariables_1">assignVariables()
<a class=
"headerlink" href=
"#assignvariables_1" title=
"Permanent link">#
</a></h4>
2318 <p><em>Inherited from AbstractPage.
</em></p>
2324 <div class=
"md-source-date">
2327 Last update:
2021-
01-
08
2346 <footer class=
"md-footer">
2348 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2350 <a href=
"../../getting-started/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2351 <div class=
"md-footer__button md-icon">
2352 <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>
2354 <div class=
"md-footer__title">
2355 <div class=
"md-ellipsis">
2356 <span class=
"md-footer__direction">
2365 <a href=
"../database-objects/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2366 <div class=
"md-footer__title">
2367 <div class=
"md-ellipsis">
2368 <span class=
"md-footer__direction">
2374 <div class=
"md-footer__button md-icon">
2375 <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>
2381 <div class=
"md-footer-meta md-typeset">
2382 <div class=
"md-footer-meta__inner md-grid">
2383 <div class=
"md-footer-copyright">
2385 <div class=
"md-footer-copyright__highlight">
2386 Copyright ©
2020 WoltLab GmbH
2390 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2395 <div class=
"md-footer-copyright">
2396 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2397 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2404 <div class=
"md-dialog" data-md-component=
"dialog">
2405 <div class=
"md-dialog__inner md-typeset"></div>
2407 <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>
2410 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>