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