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>Legacy 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=
"#legacy-javascript-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
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../view/css/" class=
"md-nav__link">
675 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
678 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" checked
>
680 <label class=
"md-nav__link" for=
"__nav_4">
681 TypeScript and JavaScript API
682 <span class=
"md-nav__icon md-icon"></span>
684 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
685 <label class=
"md-nav__title" for=
"__nav_4">
686 <span class=
"md-nav__icon md-icon"></span>
687 TypeScript and JavaScript API
689 <ul class=
"md-nav__list" data-md-scrollfix
>
695 <li class=
"md-nav__item">
696 <a href=
"../general-usage/" class=
"md-nav__link">
707 <li class=
"md-nav__item">
708 <a href=
"../typescript/" class=
"md-nav__link">
720 <li class=
"md-nav__item md-nav__item--nested">
723 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
725 <label class=
"md-nav__link" for=
"__nav_4_3">
727 <span class=
"md-nav__icon md-icon"></span>
729 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
730 <label class=
"md-nav__title" for=
"__nav_4_3">
731 <span class=
"md-nav__icon md-icon"></span>
734 <ul class=
"md-nav__list" data-md-scrollfix
>
740 <li class=
"md-nav__item">
741 <a href=
"../new-api_writing-a-module/" class=
"md-nav__link">
752 <li class=
"md-nav__item">
753 <a href=
"../new-api_data-structures/" class=
"md-nav__link">
764 <li class=
"md-nav__item">
765 <a href=
"../new-api_core/" class=
"md-nav__link">
776 <li class=
"md-nav__item">
777 <a href=
"../new-api_dom/" class=
"md-nav__link">
788 <li class=
"md-nav__item">
789 <a href=
"../new-api_events/" class=
"md-nav__link">
800 <li class=
"md-nav__item">
801 <a href=
"../new-api_ajax/" class=
"md-nav__link">
812 <li class=
"md-nav__item">
813 <a href=
"../new-api_dialogs/" class=
"md-nav__link">
824 <li class=
"md-nav__item">
825 <a href=
"../new-api_browser/" class=
"md-nav__link">
826 Browser and Screen Sizes
836 <li class=
"md-nav__item">
837 <a href=
"../new-api_ui/" class=
"md-nav__link">
856 <li class=
"md-nav__item md-nav__item--active">
858 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
863 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
865 <span class=
"md-nav__icon md-icon"></span>
868 <a href=
"./" class=
"md-nav__link md-nav__link--active">
873 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
879 <label class=
"md-nav__title" for=
"__toc">
880 <span class=
"md-nav__icon md-icon"></span>
883 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
885 <li class=
"md-nav__item">
886 <a href=
"#introduction" class=
"md-nav__link">
892 <li class=
"md-nav__item">
893 <a href=
"#classes" class=
"md-nav__link">
897 <nav class=
"md-nav" aria-label=
"Classes">
898 <ul class=
"md-nav__list">
900 <li class=
"md-nav__item">
901 <a href=
"#singletons" class=
"md-nav__link">
907 <li class=
"md-nav__item">
908 <a href=
"#regular-classes" class=
"md-nav__link">
912 <nav class=
"md-nav" aria-label=
"Regular Classes">
913 <ul class=
"md-nav__list">
915 <li class=
"md-nav__item">
916 <a href=
"#inheritance" class=
"md-nav__link">
932 <li class=
"md-nav__item">
933 <a href=
"#ajax-requests" class=
"md-nav__link">
939 <li class=
"md-nav__item">
940 <a href=
"#phrases" class=
"md-nav__link">
946 <li class=
"md-nav__item">
947 <a href=
"#event-listener" class=
"md-nav__link">
965 <li class=
"md-nav__item">
966 <a href=
"../helper-functions/" class=
"md-nav__link">
977 <li class=
"md-nav__item">
978 <a href=
"../code-snippets/" class=
"md-nav__link">
999 <li class=
"md-nav__item md-nav__item--nested">
1002 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1004 <label class=
"md-nav__link" for=
"__nav_5">
1006 <span class=
"md-nav__icon md-icon"></span>
1008 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1009 <label class=
"md-nav__title" for=
"__nav_5">
1010 <span class=
"md-nav__icon md-icon"></span>
1013 <ul class=
"md-nav__list" data-md-scrollfix
>
1019 <li class=
"md-nav__item">
1020 <a href=
"../../package/package-xml/" class=
"md-nav__link">
1032 <li class=
"md-nav__item md-nav__item--nested">
1035 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1037 <label class=
"md-nav__link" for=
"__nav_5_2">
1039 <span class=
"md-nav__icon md-icon"></span>
1041 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1042 <label class=
"md-nav__title" for=
"__nav_5_2">
1043 <span class=
"md-nav__icon md-icon"></span>
1046 <ul class=
"md-nav__list" data-md-scrollfix
>
1052 <li class=
"md-nav__item">
1053 <a href=
"../../package/pip/" class=
"md-nav__link">
1064 <li class=
"md-nav__item">
1065 <a href=
"../../package/pip/acl-option/" class=
"md-nav__link">
1076 <li class=
"md-nav__item">
1077 <a href=
"../../package/pip/acp-menu/" class=
"md-nav__link">
1088 <li class=
"md-nav__item">
1089 <a href=
"../../package/pip/acp-search-provider/" class=
"md-nav__link">
1100 <li class=
"md-nav__item">
1101 <a href=
"../../package/pip/acp-template/" class=
"md-nav__link">
1112 <li class=
"md-nav__item">
1113 <a href=
"../../package/pip/bbcode/" class=
"md-nav__link">
1124 <li class=
"md-nav__item">
1125 <a href=
"../../package/pip/box/" class=
"md-nav__link">
1136 <li class=
"md-nav__item">
1137 <a href=
"../../package/pip/clipboard-action/" class=
"md-nav__link">
1148 <li class=
"md-nav__item">
1149 <a href=
"../../package/pip/core-object/" class=
"md-nav__link">
1160 <li class=
"md-nav__item">
1161 <a href=
"../../package/pip/cronjob/" class=
"md-nav__link">
1172 <li class=
"md-nav__item">
1173 <a href=
"../../package/pip/database/" class=
"md-nav__link">
1184 <li class=
"md-nav__item">
1185 <a href=
"../../package/pip/event-listener/" class=
"md-nav__link">
1196 <li class=
"md-nav__item">
1197 <a href=
"../../package/pip/file/" class=
"md-nav__link">
1208 <li class=
"md-nav__item">
1209 <a href=
"../../package/pip/language/" class=
"md-nav__link">
1220 <li class=
"md-nav__item">
1221 <a href=
"../../package/pip/media-provider/" class=
"md-nav__link">
1232 <li class=
"md-nav__item">
1233 <a href=
"../../package/pip/menu/" class=
"md-nav__link">
1244 <li class=
"md-nav__item">
1245 <a href=
"../../package/pip/menu-item/" class=
"md-nav__link">
1256 <li class=
"md-nav__item">
1257 <a href=
"../../package/pip/object-type/" class=
"md-nav__link">
1268 <li class=
"md-nav__item">
1269 <a href=
"../../package/pip/object-type-definition/" class=
"md-nav__link">
1270 objectTypeDefinition
1280 <li class=
"md-nav__item">
1281 <a href=
"../../package/pip/option/" class=
"md-nav__link">
1292 <li class=
"md-nav__item">
1293 <a href=
"../../package/pip/page/" class=
"md-nav__link">
1304 <li class=
"md-nav__item">
1305 <a href=
"../../package/pip/pip/" class=
"md-nav__link">
1316 <li class=
"md-nav__item">
1317 <a href=
"../../package/pip/script/" class=
"md-nav__link">
1328 <li class=
"md-nav__item">
1329 <a href=
"../../package/pip/smiley/" class=
"md-nav__link">
1340 <li class=
"md-nav__item">
1341 <a href=
"../../package/pip/sql/" class=
"md-nav__link">
1352 <li class=
"md-nav__item">
1353 <a href=
"../../package/pip/style/" class=
"md-nav__link">
1364 <li class=
"md-nav__item">
1365 <a href=
"../../package/pip/template/" class=
"md-nav__link">
1376 <li class=
"md-nav__item">
1377 <a href=
"../../package/pip/template-listener/" class=
"md-nav__link">
1388 <li class=
"md-nav__item">
1389 <a href=
"../../package/pip/user-group-option/" class=
"md-nav__link">
1400 <li class=
"md-nav__item">
1401 <a href=
"../../package/pip/user-menu/" class=
"md-nav__link">
1412 <li class=
"md-nav__item">
1413 <a href=
"../../package/pip/user-notification-event/" class=
"md-nav__link">
1414 userNotificationEvent
1424 <li class=
"md-nav__item">
1425 <a href=
"../../package/pip/user-option/" class=
"md-nav__link">
1436 <li class=
"md-nav__item">
1437 <a href=
"../../package/pip/user-profile-menu/" class=
"md-nav__link">
1454 <li class=
"md-nav__item">
1455 <a href=
"../../package/database-php-api/" class=
"md-nav__link">
1476 <li class=
"md-nav__item md-nav__item--nested">
1479 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1481 <label class=
"md-nav__link" for=
"__nav_6">
1483 <span class=
"md-nav__icon md-icon"></span>
1485 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1486 <label class=
"md-nav__title" for=
"__nav_6">
1487 <span class=
"md-nav__icon md-icon"></span>
1490 <ul class=
"md-nav__list" data-md-scrollfix
>
1497 <li class=
"md-nav__item md-nav__item--nested">
1500 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1502 <label class=
"md-nav__link" for=
"__nav_6_1">
1503 Migrating from WSC
5.3
1504 <span class=
"md-nav__icon md-icon"></span>
1506 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1507 <label class=
"md-nav__title" for=
"__nav_6_1">
1508 <span class=
"md-nav__icon md-icon"></span>
1509 Migrating from WSC
5.3
1511 <ul class=
"md-nav__list" data-md-scrollfix
>
1517 <li class=
"md-nav__item">
1518 <a href=
"../../migration/wsc53/php/" class=
"md-nav__link">
1529 <li class=
"md-nav__item">
1530 <a href=
"../../migration/wsc53/session/" class=
"md-nav__link">
1531 Session Handling and Authentication
1541 <li class=
"md-nav__item">
1542 <a href=
"../../migration/wsc53/javascript/" class=
"md-nav__link">
1543 TypeScript and JavaScript
1553 <li class=
"md-nav__item">
1554 <a href=
"../../migration/wsc53/templates/" class=
"md-nav__link">
1565 <li class=
"md-nav__item">
1566 <a href=
"../../migration/wsc53/libraries/" class=
"md-nav__link">
1567 Third Party Libraries
1584 <li class=
"md-nav__item md-nav__item--nested">
1587 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1589 <label class=
"md-nav__link" for=
"__nav_6_2">
1590 Migrating from WSC
5.2
1591 <span class=
"md-nav__icon md-icon"></span>
1593 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1594 <label class=
"md-nav__title" for=
"__nav_6_2">
1595 <span class=
"md-nav__icon md-icon"></span>
1596 Migrating from WSC
5.2
1598 <ul class=
"md-nav__list" data-md-scrollfix
>
1604 <li class=
"md-nav__item">
1605 <a href=
"../../migration/wsc52/php/" class=
"md-nav__link">
1616 <li class=
"md-nav__item">
1617 <a href=
"../../migration/wsc52/templates/" class=
"md-nav__link">
1618 Templates and Languages
1628 <li class=
"md-nav__item">
1629 <a href=
"../../migration/wsc52/libraries/" class=
"md-nav__link">
1630 Third Party Libraries
1647 <li class=
"md-nav__item md-nav__item--nested">
1650 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1652 <label class=
"md-nav__link" for=
"__nav_6_3">
1653 Migrating from WSC
3.1
1654 <span class=
"md-nav__icon md-icon"></span>
1656 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1657 <label class=
"md-nav__title" for=
"__nav_6_3">
1658 <span class=
"md-nav__icon md-icon"></span>
1659 Migrating from WSC
3.1
1661 <ul class=
"md-nav__list" data-md-scrollfix
>
1667 <li class=
"md-nav__item">
1668 <a href=
"../../migration/wsc31/php/" class=
"md-nav__link">
1686 <li class=
"md-nav__item md-nav__item--nested">
1689 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1691 <label class=
"md-nav__link" for=
"__nav_6_4">
1692 Migrating from WSC
3.0
1693 <span class=
"md-nav__icon md-icon"></span>
1695 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1696 <label class=
"md-nav__title" for=
"__nav_6_4">
1697 <span class=
"md-nav__icon md-icon"></span>
1698 Migrating from WSC
3.0
1700 <ul class=
"md-nav__list" data-md-scrollfix
>
1706 <li class=
"md-nav__item">
1707 <a href=
"../../migration/wsc30/php/" class=
"md-nav__link">
1718 <li class=
"md-nav__item">
1719 <a href=
"../../migration/wsc30/javascript/" class=
"md-nav__link">
1730 <li class=
"md-nav__item">
1731 <a href=
"../../migration/wsc30/templates/" class=
"md-nav__link">
1742 <li class=
"md-nav__item">
1743 <a href=
"../../migration/wsc30/css/" class=
"md-nav__link">
1754 <li class=
"md-nav__item">
1755 <a href=
"../../migration/wsc30/package/" class=
"md-nav__link">
1773 <li class=
"md-nav__item md-nav__item--nested">
1776 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1778 <label class=
"md-nav__link" for=
"__nav_6_5">
1779 Migrating from WCF
2.1
1780 <span class=
"md-nav__icon md-icon"></span>
1782 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1783 <label class=
"md-nav__title" for=
"__nav_6_5">
1784 <span class=
"md-nav__icon md-icon"></span>
1785 Migrating from WCF
2.1
1787 <ul class=
"md-nav__list" data-md-scrollfix
>
1793 <li class=
"md-nav__item">
1794 <a href=
"../../migration/wcf21/php/" class=
"md-nav__link">
1805 <li class=
"md-nav__item">
1806 <a href=
"../../migration/wcf21/templates/" class=
"md-nav__link">
1817 <li class=
"md-nav__item">
1818 <a href=
"../../migration/wcf21/css/" class=
"md-nav__link">
1829 <li class=
"md-nav__item">
1830 <a href=
"../../migration/wcf21/package/" class=
"md-nav__link">
1857 <li class=
"md-nav__item md-nav__item--nested">
1860 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1862 <label class=
"md-nav__link" for=
"__nav_7">
1864 <span class=
"md-nav__icon md-icon"></span>
1866 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1867 <label class=
"md-nav__title" for=
"__nav_7">
1868 <span class=
"md-nav__icon md-icon"></span>
1871 <ul class=
"md-nav__list" data-md-scrollfix
>
1878 <li class=
"md-nav__item md-nav__item--nested">
1881 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1883 <label class=
"md-nav__link" for=
"__nav_7_1">
1885 <span class=
"md-nav__icon md-icon"></span>
1887 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1888 <label class=
"md-nav__title" for=
"__nav_7_1">
1889 <span class=
"md-nav__icon md-icon"></span>
1892 <ul class=
"md-nav__list" data-md-scrollfix
>
1898 <li class=
"md-nav__item">
1899 <a href=
"../../tutorial/series/overview/" class=
"md-nav__link">
1910 <li class=
"md-nav__item">
1911 <a href=
"../../tutorial/series/part_1/" class=
"md-nav__link">
1922 <li class=
"md-nav__item">
1923 <a href=
"../../tutorial/series/part_2/" class=
"md-nav__link">
1934 <li class=
"md-nav__item">
1935 <a href=
"../../tutorial/series/part_3/" class=
"md-nav__link">
1962 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1963 <div class=
"md-sidebar__scrollwrap">
1964 <div class=
"md-sidebar__inner">
1966 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1972 <label class=
"md-nav__title" for=
"__toc">
1973 <span class=
"md-nav__icon md-icon"></span>
1976 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1978 <li class=
"md-nav__item">
1979 <a href=
"#introduction" class=
"md-nav__link">
1985 <li class=
"md-nav__item">
1986 <a href=
"#classes" class=
"md-nav__link">
1990 <nav class=
"md-nav" aria-label=
"Classes">
1991 <ul class=
"md-nav__list">
1993 <li class=
"md-nav__item">
1994 <a href=
"#singletons" class=
"md-nav__link">
2000 <li class=
"md-nav__item">
2001 <a href=
"#regular-classes" class=
"md-nav__link">
2005 <nav class=
"md-nav" aria-label=
"Regular Classes">
2006 <ul class=
"md-nav__list">
2008 <li class=
"md-nav__item">
2009 <a href=
"#inheritance" class=
"md-nav__link">
2025 <li class=
"md-nav__item">
2026 <a href=
"#ajax-requests" class=
"md-nav__link">
2032 <li class=
"md-nav__item">
2033 <a href=
"#phrases" class=
"md-nav__link">
2039 <li class=
"md-nav__item">
2040 <a href=
"#event-listener" class=
"md-nav__link">
2054 <div class=
"md-content" data-md-component=
"content">
2055 <article class=
"md-content__inner md-typeset">
2058 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/javascript/legacy-api.md" title=
"Edit this page" class=
"md-content__button md-icon">
2059 <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>
2063 <h1 id=
"legacy-javascript-api">Legacy JavaScript API
<a class=
"headerlink" href=
"#legacy-javascript-api" title=
"Permanent link">#
</a></h1>
2064 <h2 id=
"introduction">Introduction
<a class=
"headerlink" href=
"#introduction" title=
"Permanent link">#
</a></h2>
2065 <p>The legacy JavaScript API is the original code that was part of the
2.x series
2066 of WoltLab Suite, formerly known as WoltLab Community Framework. It has been
2067 superseded for the most part by the
<a href=
"../new-api_writing-a-module/">ES5/AMD-modules API
</a>
2068 introduced with WoltLab Suite
3.0.
</p>
2069 <p>Some parts still exist to this day for backwards-compatibility and because some
2070 less important components have not been rewritten yet. The old API is still
2071 supported, but marked as deprecated and will continue to be replaced parts by
2072 part in future releases, up until their entire removal, including jQuery support.
</p>
2073 <p>This guide does not provide any explanation on the usage of those legacy components,
2074 but instead serves as a cheat sheet to convert code to use the new API.
</p>
2075 <h2 id=
"classes">Classes
<a class=
"headerlink" href=
"#classes" title=
"Permanent link">#
</a></h2>
2076 <h3 id=
"singletons">Singletons
<a class=
"headerlink" href=
"#singletons" title=
"Permanent link">#
</a></h3>
2077 <p>Singleton instances are designed to provide a unique
"instance" of an object
2078 regardless of when its first instance was created. Due to the lack of a
<code>class
</code>
2079 construct in ES5, they are represented by mere objects that act as an instance.
</p>
2080 <div class=
"highlight"><pre><span></span><code><span class=
"c1">// App.js
</span>
2081 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">App
</span> <span class=
"o">=
</span> <span class=
"p">{};
</span>
2082 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2083 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2084 <span class=
"p">};
</span>
2086 <span class=
"c1">// --- NEW API ---
</span>
2088 <span class=
"c1">// App/Foo.js
</span>
2089 <span class=
"nx">define
</span><span class=
"p">([],
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2090 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2092 <span class=
"k">return
</span> <span class=
"p">{
</span>
2093 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2094 <span class=
"p">};
</span>
2095 <span class=
"p">});
</span>
2097 <h3 id=
"regular-classes">Regular Classes
<a class=
"headerlink" href=
"#regular-classes" title=
"Permanent link">#
</a></h3>
2098 <div class=
"highlight"><pre><span></span><code><span class=
"c1">// App.js
</span>
2099 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">App
</span> <span class=
"o">=
</span> <span class=
"p">{};
</span>
2100 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2101 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2102 <span class=
"p">});
</span>
2104 <span class=
"c1">// --- NEW API ---
</span>
2106 <span class=
"c1">// App/Foo.js
</span>
2107 <span class=
"nx">define
</span><span class=
"p">([],
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2108 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2110 <span class=
"kd">function
</span> <span class=
"nx">Foo
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2111 <span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2112 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2113 <span class=
"p">};
</span>
2115 <span class=
"k">return
</span> <span class=
"nx">Foo
</span><span class=
"p">;
</span>
2116 <span class=
"p">});
</span>
2118 <h4 id=
"inheritance">Inheritance
<a class=
"headerlink" href=
"#inheritance" title=
"Permanent link">#
</a></h4>
2119 <div class=
"highlight"><pre><span></span><code><span class=
"c1">// App.js
</span>
2120 <span class=
"nb">window
</span><span class=
"p">.
</span><span class=
"nx">App
</span> <span class=
"o">=
</span> <span class=
"p">{};
</span>
2121 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2122 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2123 <span class=
"p">});
</span>
2124 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Baz
</span> <span class=
"o">=
</span> <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2125 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2126 <span class=
"p">});
</span>
2128 <span class=
"c1">// --- NEW API ---
</span>
2130 <span class=
"c1">// App/Foo.js
</span>
2131 <span class=
"nx">define
</span><span class=
"p">([],
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2132 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2134 <span class=
"kd">function
</span> <span class=
"nx">Foo
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2135 <span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2136 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2137 <span class=
"p">};
</span>
2139 <span class=
"k">return
</span> <span class=
"nx">Foo
</span><span class=
"p">;
</span>
2140 <span class=
"p">});
</span>
2142 <span class=
"c1">// App/Baz.js
</span>
2143 <span class=
"nx">define
</span><span class=
"p">([
</span><span class=
"s2">"Core
"</span><span class=
"p">,
</span> <span class=
"s2">"./Foo
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Core
</span><span class=
"p">,
</span> <span class=
"nx">Foo
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2144 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2146 <span class=
"kd">function
</span> <span class=
"nx">Baz
</span><span class=
"p">()
</span> <span class=
"p">{};
</span>
2147 <span class=
"nx">Core
</span><span class=
"p">.
</span><span class=
"nx">inherit
</span><span class=
"p">(
</span><span class=
"nx">Baz
</span><span class=
"p">,
</span> <span class=
"nx">Foo
</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2148 <span class=
"nx">makeSnafucated
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2149 <span class=
"p">});
</span>
2151 <span class=
"k">return
</span> <span class=
"nx">Baz
</span><span class=
"p">;
</span>
2152 <span class=
"p">});
</span>
2154 <h2 id=
"ajax-requests">Ajax Requests
<a class=
"headerlink" href=
"#ajax-requests" title=
"Permanent link">#
</a></h2>
2155 <div class=
"highlight"><pre><span></span><code><span class=
"c1">// App.js
</span>
2156 <span class=
"nx">App
</span><span class=
"p">.
</span><span class=
"nx">Foo
</span> <span class=
"o">=
</span> <span class=
"nx">Class
</span><span class=
"p">.
</span><span class=
"nx">extend
</span><span class=
"p">({
</span>
2157 <span class=
"nx">_proxy
</span><span class=
"o">:
</span> <span class=
"kc">null
</span><span class=
"p">,
</span>
2159 <span class=
"nx">init
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2160 <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">_proxy
</span> <span class=
"o">=
</span> <span class=
"k">new
</span> <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Action
</span><span class=
"p">.
</span><span class=
"nb">Proxy
</span><span class=
"p">({
</span>
2161 <span class=
"nx">success
</span><span class=
"o">:
</span> <span class=
"nx">$
</span><span class=
"p">.
</span><span class=
"nx">proxy
</span><span class=
"p">(
</span><span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">_success
</span><span class=
"p">,
</span> <span class=
"k">this
</span><span class=
"p">)
</span>
2162 <span class=
"p">});
</span>
2163 <span class=
"p">},
</span>
2165 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2166 <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">_proxy
</span><span class=
"p">.
</span><span class=
"nx">setOption
</span><span class=
"p">(
</span><span class=
"s2">"data
"</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2167 <span class=
"nx">actionName
</span><span class=
"o">:
</span> <span class=
"s2">"baz
"</span><span class=
"p">,
</span>
2168 <span class=
"nx">className
</span><span class=
"o">:
</span> <span class=
"s2">"app\\foo\\FooAction
"</span><span class=
"p">,
</span>
2169 <span class=
"nx">objectIDs
</span><span class=
"o">:
</span> <span class=
"p">[
</span><span class=
"mf">1</span><span class=
"p">,
</span> <span class=
"mf">2</span><span class=
"p">,
</span> <span class=
"mf">3</span><span class=
"p">],
</span>
2170 <span class=
"nx">parameters
</span><span class=
"o">:
</span> <span class=
"p">{
</span>
2171 <span class=
"nx">foo
</span><span class=
"o">:
</span> <span class=
"s2">"bar
"</span><span class=
"p">,
</span>
2172 <span class=
"nx">baz
</span><span class=
"o">:
</span> <span class=
"kc">true
</span>
2173 <span class=
"p">}
</span>
2174 <span class=
"p">});
</span>
2175 <span class=
"k">this
</span><span class=
"p">.
</span><span class=
"nx">_proxy
</span><span class=
"p">.
</span><span class=
"nx">sendRequest
</span><span class=
"p">();
</span>
2176 <span class=
"p">},
</span>
2178 <span class=
"nx">_success
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">data
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2179 <span class=
"c1">// ajax request result
</span>
2180 <span class=
"p">}
</span>
2181 <span class=
"p">});
</span>
2183 <span class=
"c1">// --- NEW API ---
</span>
2185 <span class=
"c1">// App/Foo.js
</span>
2186 <span class=
"nx">define
</span><span class=
"p">([
</span><span class=
"s2">"Ajax
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Ajax
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2187 <span class=
"s2">"use strict
"</span><span class=
"p">;
</span>
2189 <span class=
"kd">function
</span> <span class=
"nx">Foo
</span><span class=
"p">()
</span> <span class=
"p">{}
</span>
2190 <span class=
"nx">Foo
</span><span class=
"p">.
</span><span class=
"nx">prototype
</span> <span class=
"o">=
</span> <span class=
"p">{
</span>
2191 <span class=
"nx">bar
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2192 <span class=
"nx">Ajax
</span><span class=
"p">.
</span><span class=
"nx">api
</span><span class=
"p">(
</span><span class=
"k">this
</span><span class=
"p">,
</span> <span class=
"p">{
</span>
2193 <span class=
"nx">objectIDs
</span><span class=
"o">:
</span> <span class=
"p">[
</span><span class=
"mf">1</span><span class=
"p">,
</span> <span class=
"mf">2</span><span class=
"p">,
</span> <span class=
"mf">3</span><span class=
"p">],
</span>
2194 <span class=
"nx">parameters
</span><span class=
"o">:
</span> <span class=
"p">{
</span>
2195 <span class=
"nx">foo
</span><span class=
"o">:
</span> <span class=
"s2">"bar
"</span><span class=
"p">,
</span>
2196 <span class=
"nx">baz
</span><span class=
"o">:
</span> <span class=
"kc">true
</span>
2197 <span class=
"p">}
</span>
2198 <span class=
"p">});
</span>
2199 <span class=
"p">},
</span>
2201 <span class=
"c1">// magic method!
</span>
2202 <span class=
"nx">_ajaxSuccess
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">data
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2203 <span class=
"c1">// ajax request result
</span>
2204 <span class=
"p">},
</span>
2206 <span class=
"c1">// magic method!
</span>
2207 <span class=
"nx">_ajaxSetup
</span><span class=
"o">:
</span> <span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2208 <span class=
"k">return
</span> <span class=
"p">{
</span>
2209 <span class=
"nx">actionName
</span><span class=
"o">:
</span> <span class=
"s2">"baz
"</span><span class=
"p">,
</span>
2210 <span class=
"nx">className
</span><span class=
"o">:
</span> <span class=
"s2">"app\\foo\\FooAction
"</span>
2211 <span class=
"p">}
</span>
2212 <span class=
"p">}
</span>
2213 <span class=
"p">}
</span>
2215 <span class=
"k">return
</span> <span class=
"nx">Foo
</span><span class=
"p">;
</span>
2216 <span class=
"p">});
</span>
2218 <h2 id=
"phrases">Phrases
<a class=
"headerlink" href=
"#phrases" title=
"Permanent link">#
</a></h2>
2219 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2220 <span class=
"nx">$
</span><span class=
"p">(
</span><span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2221 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">addObject
</span><span class=
"p">({
</span>
2222 <span class=
"s1">'app.foo.bar
'</span><span class=
"o">:
</span> <span class=
"s1">'{lang}app.foo.bar{/lang}
'</span>
2223 <span class=
"p">});
</span>
2225 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">));
</span>
2226 <span class=
"p">});
</span>
2227 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2229 <span class=
"c"><!-- NEW API --
></span>
2231 <span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2232 <span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"Language
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2233 <span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">addObject
</span><span class=
"p">({
</span>
2234 <span class=
"s1">'app.foo.bar
'</span><span class=
"o">:
</span> <span class=
"s1">'{jslang}app.foo.bar{/jslang}
'</span>
2235 <span class=
"p">});
</span>
2237 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"nx">Language
</span><span class=
"p">.
</span><span class=
"nx">get
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">));
</span>
2238 <span class=
"p">});
</span>
2239 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2241 <h2 id=
"event-listener">Event-Listener
<a class=
"headerlink" href=
"#event-listener" title=
"Permanent link">#
</a></h2>
2242 <div class=
"highlight"><pre><span></span><code><span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2243 <span class=
"nx">$
</span><span class=
"p">(
</span><span class=
"kd">function
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2244 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">System
</span><span class=
"p">.
</span><span class=
"nx">Event
</span><span class=
"p">.
</span><span class=
"nx">addListener
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">,
</span> <span class=
"s2">"makeSnafucated
"</span><span class=
"p">,
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">data
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2245 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"s2">"Event was invoked.
"</span><span class=
"p">);
</span>
2246 <span class=
"p">});
</span>
2248 <span class=
"nx">WCF
</span><span class=
"p">.
</span><span class=
"nx">System
</span><span class=
"p">.
</span><span class=
"nx">Event
</span><span class=
"p">.
</span><span class=
"nx">fireEvent
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">,
</span> <span class=
"s2">"makeSnafucated
"</span><span class=
"p">,
</span> <span class=
"p">{
</span> <span class=
"nx">some
</span><span class=
"o">:
</span> <span class=
"s2">"data
"</span> <span class=
"p">});
</span>
2249 <span class=
"p">});
</span>
2250 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2252 <span class=
"c"><!-- NEW API --
></span>
2254 <span class=
"p"><</span><span class=
"nt">script
</span> <span class=
"na">data-relocate
</span><span class=
"o">=
</span><span class=
"s">"true
"</span><span class=
"p">></span>
2255 <span class=
"nx">require
</span><span class=
"p">([
</span><span class=
"s2">"EventHandler
"</span><span class=
"p">],
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">EventHandler
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2256 <span class=
"nx">EventHandler
</span><span class=
"p">.
</span><span class=
"nx">add
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">,
</span> <span class=
"s2">"makeSnafucated
"</span><span class=
"p">,
</span> <span class=
"kd">function
</span><span class=
"p">(
</span><span class=
"nx">data
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2257 <span class=
"nx">console
</span><span class=
"p">.
</span><span class=
"nx">log
</span><span class=
"p">(
</span><span class=
"s2">"Event was invoked
"</span><span class=
"p">);
</span>
2258 <span class=
"p">});
</span>
2260 <span class=
"nx">EventHandler
</span><span class=
"p">.
</span><span class=
"nx">fire
</span><span class=
"p">(
</span><span class=
"s2">"app.foo.bar
"</span><span class=
"p">,
</span> <span class=
"s2">"makeSnafucated
"</span><span class=
"p">,
</span> <span class=
"p">{
</span> <span class=
"nx">some
</span><span class=
"o">:
</span> <span class=
"s2">"data
"</span> <span class=
"p">});
</span>
2261 <span class=
"p">});
</span>
2262 <span class=
"p"></
</span><span class=
"nt">script
</span><span class=
"p">></span>
2269 <div class=
"md-source-date">
2272 Last update:
2021-
01-
08
2291 <footer class=
"md-footer">
2293 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2295 <a href=
"../new-api_ui/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2296 <div class=
"md-footer__button md-icon">
2297 <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>
2299 <div class=
"md-footer__title">
2300 <div class=
"md-ellipsis">
2301 <span class=
"md-footer__direction">
2310 <a href=
"../helper-functions/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2311 <div class=
"md-footer__title">
2312 <div class=
"md-ellipsis">
2313 <span class=
"md-footer__direction">
2319 <div class=
"md-footer__button md-icon">
2320 <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>
2326 <div class=
"md-footer-meta md-typeset">
2327 <div class=
"md-footer-meta__inner md-grid">
2328 <div class=
"md-footer-copyright">
2330 <div class=
"md-footer-copyright__highlight">
2331 Copyright ©
2020 WoltLab GmbH
2335 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2340 <div class=
"md-footer-copyright">
2341 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2342 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2349 <div class=
"md-dialog" data-md-component=
"dialog">
2350 <div class=
"md-dialog__inner md-typeset"></div>
2352 <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>
2355 <script src=
"../../assets/javascripts/bundle.d892486b.min.js"></script>