Commit | Line | Data |
---|---|---|
0c5338dd 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"> | |
0c5338dd 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"> |
0c5338dd TD |
22 | |
23 | ||
fb962f09 | 24 | <link rel="stylesheet" href="../../../assets/stylesheets/palette.ef6f36e2.min.css"> |
0c5338dd TD |
25 | |
26 | ||
27 | ||
28 | <meta name="theme-color" content="#009485"> | |
29 | ||
30 | ||
31 | ||
32 | ||
33 | ||
fd8430cb WG |
34 | |
35 | ||
0c5338dd 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=""> | |
0c5338dd 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 | ||
0c5338dd 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-52-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"> |
0c5338dd | 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"> |
0c5338dd 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> | |
0c5338dd 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 | ||
0c5338dd | 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 | ||
0c5338dd 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 | ||
0c5338dd 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"> |
0c5338dd 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 | ||
0c5338dd 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 | ||
0c5338dd 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 | |
0c5338dd TD |
357 | </a> |
358 | </li> | |
359 | ||
360 | ||
361 | ||
6923e968 WG |
362 | </ul> |
363 | </nav> | |
364 | </li> | |
365 | ||
366 | ||
367 | ||
0c5338dd 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 | ||
0c5338dd 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 |
0c5338dd 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"> |
0c5338dd 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 |
0c5338dd 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 | ||
0c5338dd 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" > |
0c5338dd | 722 | |
77efcd46 | 723 | <label class="md-nav__link" for="__nav_4_3"> |
0c5338dd 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"> |
0c5338dd 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 | ||
0c5338dd 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 |
0c5338dd 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 | ||
1486 | ||
1487 | <li class="md-nav__item md-nav__item--active md-nav__item--nested"> | |
1488 | ||
1489 | ||
1490 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" checked> | |
1491 | ||
1492 | <label class="md-nav__link" for="__nav_6_2"> | |
1493 | Migrating from WSC 5.2 | |
1494 | <span class="md-nav__icon md-icon"></span> | |
1495 | </label> | |
1496 | <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2"> | |
1497 | <label class="md-nav__title" for="__nav_6_2"> | |
1498 | <span class="md-nav__icon md-icon"></span> | |
1499 | Migrating from WSC 5.2 | |
1500 | </label> | |
1501 | <ul class="md-nav__list" data-md-scrollfix> | |
1502 | ||
1503 | ||
1504 | ||
1505 | ||
1506 | ||
1507 | ||
1508 | ||
1509 | <li class="md-nav__item md-nav__item--active"> | |
1510 | ||
1511 | <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> | |
1512 | ||
1513 | ||
1514 | ||
1515 | ||
1516 | <label class="md-nav__link md-nav__link--active" for="__toc"> | |
1517 | PHP API | |
1518 | <span class="md-nav__icon md-icon"></span> | |
1519 | </label> | |
1520 | ||
1521 | <a href="./" class="md-nav__link md-nav__link--active"> | |
1522 | PHP API | |
1523 | </a> | |
1524 | ||
1525 | ||
1526 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
1527 | ||
1528 | ||
1529 | ||
1530 | ||
1531 | ||
1532 | <label class="md-nav__title" for="__toc"> | |
1533 | <span class="md-nav__icon md-icon"></span> | |
1534 | Table of contents | |
1535 | </label> | |
1536 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
1537 | ||
1538 | <li class="md-nav__item"> | |
1539 | <a href="#comments" class="md-nav__link"> | |
1540 | Comments | |
1541 | </a> | |
1542 | ||
1543 | </li> | |
1544 | ||
1545 | <li class="md-nav__item"> | |
1546 | <a href="#event-listeners" class="md-nav__link"> | |
1547 | Event Listeners | |
1548 | </a> | |
1549 | ||
1550 | </li> | |
1551 | ||
1552 | <li class="md-nav__item"> | |
1553 | <a href="#email-activation" class="md-nav__link"> | |
1554 | Email Activation | |
1555 | </a> | |
1556 | ||
1557 | </li> | |
1558 | ||
1559 | <li class="md-nav__item"> | |
1560 | <a href="#addform" class="md-nav__link"> | |
1561 | *AddForm | |
1562 | </a> | |
1563 | ||
1564 | </li> | |
1565 | ||
1566 | <li class="md-nav__item"> | |
1567 | <a href="#user-generated-links" class="md-nav__link"> | |
1568 | User Generated Links | |
1569 | </a> | |
1570 | ||
1571 | </li> | |
1572 | ||
1573 | <li class="md-nav__item"> | |
1574 | <a href="#resource-management-when-scaling-images" class="md-nav__link"> | |
1575 | Resource Management When Scaling Images | |
1576 | </a> | |
1577 | ||
1578 | </li> | |
1579 | ||
1580 | <li class="md-nav__item"> | |
1581 | <a href="#toggle-for-accelerated-mobile-pages-amp" class="md-nav__link"> | |
1582 | Toggle for Accelerated Mobile Pages (AMP) | |
1583 | </a> | |
1584 | ||
1585 | </li> | |
1586 | ||
1587 | </ul> | |
1588 | ||
1589 | </nav> | |
1590 | ||
1591 | </li> | |
1592 | ||
1593 | ||
1594 | ||
1595 | ||
1596 | ||
1597 | ||
1598 | ||
1599 | <li class="md-nav__item"> | |
1600 | <a href="../templates/" class="md-nav__link"> | |
1601 | Templates and Languages | |
1602 | </a> | |
1603 | </li> | |
1604 | ||
1605 | ||
1606 | ||
1607 | ||
1608 | ||
1609 | ||
1610 | ||
1611 | <li class="md-nav__item"> | |
1612 | <a href="../libraries/" class="md-nav__link"> | |
1613 | Third Party Libraries | |
1614 | </a> | |
1615 | </li> | |
1616 | ||
1617 | ||
1618 | ||
1619 | </ul> | |
1620 | </nav> | |
1621 | </li> | |
1622 | ||
1623 | ||
1624 | ||
1625 | ||
1626 | ||
1627 | ||
1628 | ||
1629 | ||
1630 | <li class="md-nav__item md-nav__item--nested"> | |
1631 | ||
1632 | ||
1633 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" > | |
1634 | ||
1635 | <label class="md-nav__link" for="__nav_6_3"> | |
1636 | Migrating from WSC 3.1 | |
1637 | <span class="md-nav__icon md-icon"></span> | |
1638 | </label> | |
1639 | <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2"> | |
1640 | <label class="md-nav__title" for="__nav_6_3"> | |
1641 | <span class="md-nav__icon md-icon"></span> | |
1642 | Migrating from WSC 3.1 | |
1643 | </label> | |
1644 | <ul class="md-nav__list" data-md-scrollfix> | |
1645 | ||
1646 | ||
1647 | ||
1648 | ||
1649 | ||
1650 | <li class="md-nav__item"> | |
1651 | <a href="../../wsc31/php/" class="md-nav__link"> | |
1652 | PHP API | |
1653 | </a> | |
1654 | </li> | |
1655 | ||
1656 | ||
1657 | ||
1658 | </ul> | |
1659 | </nav> | |
1660 | </li> | |
1661 | ||
1662 | ||
1663 | ||
1664 | ||
1665 | ||
1666 | ||
1667 | ||
1668 | ||
1669 | <li class="md-nav__item md-nav__item--nested"> | |
1670 | ||
1671 | ||
1672 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" > | |
1673 | ||
1674 | <label class="md-nav__link" for="__nav_6_4"> | |
1675 | Migrating from WSC 3.0 | |
1676 | <span class="md-nav__icon md-icon"></span> | |
1677 | </label> | |
1678 | <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2"> | |
1679 | <label class="md-nav__title" for="__nav_6_4"> | |
1680 | <span class="md-nav__icon md-icon"></span> | |
1681 | Migrating from WSC 3.0 | |
1682 | </label> | |
1683 | <ul class="md-nav__list" data-md-scrollfix> | |
1684 | ||
1685 | ||
1686 | ||
1687 | ||
1688 | ||
1689 | <li class="md-nav__item"> | |
1690 | <a href="../../wsc30/php/" class="md-nav__link"> | |
1691 | PHP API | |
1692 | </a> | |
1693 | </li> | |
1694 | ||
1695 | ||
1696 | ||
1697 | ||
1698 | ||
1699 | ||
1700 | ||
1701 | <li class="md-nav__item"> | |
1702 | <a href="../../wsc30/javascript/" class="md-nav__link"> | |
1703 | JavaScript API | |
1704 | </a> | |
1705 | </li> | |
1706 | ||
1707 | ||
1708 | ||
1709 | ||
1710 | ||
1711 | ||
1712 | ||
1713 | <li class="md-nav__item"> | |
1714 | <a href="../../wsc30/templates/" class="md-nav__link"> | |
1715 | Templates | |
1716 | </a> | |
1717 | </li> | |
1718 | ||
1719 | ||
1720 | ||
1721 | ||
1722 | ||
1723 | ||
1724 | ||
1725 | <li class="md-nav__item"> | |
1726 | <a href="../../wsc30/css/" class="md-nav__link"> | |
1727 | CSS | |
1728 | </a> | |
1729 | </li> | |
1730 | ||
1731 | ||
1732 | ||
1733 | ||
1734 | ||
1735 | ||
1736 | ||
1737 | <li class="md-nav__item"> | |
1738 | <a href="../../wsc30/package/" class="md-nav__link"> | |
1739 | Package Components | |
1740 | </a> | |
1741 | </li> | |
1742 | ||
1743 | ||
1744 | ||
1745 | </ul> | |
1746 | </nav> | |
1747 | </li> | |
1748 | ||
1749 | ||
1750 | ||
1751 | ||
1752 | ||
1753 | ||
1754 | ||
1755 | ||
1756 | <li class="md-nav__item md-nav__item--nested"> | |
1757 | ||
1758 | ||
1759 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" > | |
1760 | ||
1761 | <label class="md-nav__link" for="__nav_6_5"> | |
1762 | Migrating from WCF 2.1 | |
1763 | <span class="md-nav__icon md-icon"></span> | |
1764 | </label> | |
1765 | <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2"> | |
1766 | <label class="md-nav__title" for="__nav_6_5"> | |
1767 | <span class="md-nav__icon md-icon"></span> | |
1768 | Migrating from WCF 2.1 | |
1769 | </label> | |
1770 | <ul class="md-nav__list" data-md-scrollfix> | |
1771 | ||
1772 | ||
1773 | ||
1774 | ||
1775 | ||
1776 | <li class="md-nav__item"> | |
1777 | <a href="../../wcf21/php/" class="md-nav__link"> | |
1778 | PHP API | |
1779 | </a> | |
1780 | </li> | |
1781 | ||
1782 | ||
1783 | ||
1784 | ||
1785 | ||
1786 | ||
1787 | ||
1788 | <li class="md-nav__item"> | |
1789 | <a href="../../wcf21/templates/" class="md-nav__link"> | |
1790 | Templates | |
1791 | </a> | |
1792 | </li> | |
1793 | ||
1794 | ||
1795 | ||
1796 | ||
1797 | ||
1798 | ||
1799 | ||
1800 | <li class="md-nav__item"> | |
1801 | <a href="../../wcf21/css/" class="md-nav__link"> | |
1802 | CSS | |
1803 | </a> | |
1804 | </li> | |
1805 | ||
1806 | ||
1807 | ||
1808 | ||
1809 | ||
1810 | ||
1811 | ||
1812 | <li class="md-nav__item"> | |
1813 | <a href="../../wcf21/package/" class="md-nav__link"> | |
1814 | Package Components | |
1815 | </a> | |
1816 | </li> | |
1817 | ||
1818 | ||
1819 | ||
1820 | </ul> | |
1821 | </nav> | |
1822 | </li> | |
1823 | ||
1824 | ||
1825 | ||
1826 | </ul> | |
1827 | </nav> | |
1828 | </li> | |
1829 | ||
1830 | ||
1831 | ||
1832 | ||
1833 | ||
1834 | ||
1835 | ||
1836 | ||
1837 | ||
1838 | ||
1839 | ||
1840 | <li class="md-nav__item md-nav__item--nested"> | |
1841 | ||
1842 | ||
1843 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > | |
1844 | ||
1845 | <label class="md-nav__link" for="__nav_7"> | |
1846 | Tutorials | |
1847 | <span class="md-nav__icon md-icon"></span> | |
1848 | </label> | |
1849 | <nav class="md-nav" aria-label="Tutorials" data-md-level="1"> | |
1850 | <label class="md-nav__title" for="__nav_7"> | |
1851 | <span class="md-nav__icon md-icon"></span> | |
1852 | Tutorials | |
1853 | </label> | |
1854 | <ul class="md-nav__list" data-md-scrollfix> | |
1855 | ||
1856 | ||
1857 | ||
1858 | ||
1859 | ||
1860 | ||
1861 | <li class="md-nav__item md-nav__item--nested"> | |
1862 | ||
1863 | ||
1864 | <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" > | |
1865 | ||
1866 | <label class="md-nav__link" for="__nav_7_1"> | |
1867 | Tutorial Series | |
1868 | <span class="md-nav__icon md-icon"></span> | |
1869 | </label> | |
1870 | <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2"> | |
1871 | <label class="md-nav__title" for="__nav_7_1"> | |
1872 | <span class="md-nav__icon md-icon"></span> | |
1873 | Tutorial Series | |
1874 | </label> | |
1875 | <ul class="md-nav__list" data-md-scrollfix> | |
1876 | ||
1877 | ||
1878 | ||
1879 | ||
1880 | ||
1881 | <li class="md-nav__item"> | |
1882 | <a href="../../../tutorial/series/overview/" class="md-nav__link"> | |
1883 | Overview | |
1884 | </a> | |
1885 | </li> | |
1886 | ||
1887 | ||
1888 | ||
1889 | ||
1890 | ||
1891 | ||
1892 | ||
1893 | <li class="md-nav__item"> | |
1894 | <a href="../../../tutorial/series/part_1/" class="md-nav__link"> | |
1895 | Part 1 | |
1896 | </a> | |
1897 | </li> | |
1898 | ||
1899 | ||
1900 | ||
1901 | ||
1902 | ||
1903 | ||
1904 | ||
1905 | <li class="md-nav__item"> | |
1906 | <a href="../../../tutorial/series/part_2/" class="md-nav__link"> | |
1907 | Part 2 | |
1908 | </a> | |
1909 | </li> | |
1910 | ||
1911 | ||
1912 | ||
1913 | ||
1914 | ||
1915 | ||
1916 | ||
1917 | <li class="md-nav__item"> | |
1918 | <a href="../../../tutorial/series/part_3/" class="md-nav__link"> | |
1919 | Part 3 | |
1920 | </a> | |
1921 | </li> | |
1922 | ||
1923 | ||
1924 | ||
41eda543 WG |
1925 | |
1926 | ||
1927 | ||
1928 | ||
1929 | <li class="md-nav__item"> | |
1930 | <a href="../../../tutorial/series/part_4/" class="md-nav__link"> | |
1931 | Part 4 | |
1932 | </a> | |
1933 | </li> | |
1934 | ||
1935 | ||
1936 | ||
0c5338dd TD |
1937 | </ul> |
1938 | </nav> | |
1939 | </li> | |
1940 | ||
1941 | ||
1942 | ||
1943 | </ul> | |
1944 | </nav> | |
1945 | </li> | |
1946 | ||
1947 | ||
1948 | ||
1949 | </ul> | |
1950 | </nav> | |
1951 | </div> | |
1952 | </div> | |
1953 | </div> | |
1954 | ||
1955 | ||
1956 | ||
1957 | <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > | |
1958 | <div class="md-sidebar__scrollwrap"> | |
1959 | <div class="md-sidebar__inner"> | |
1960 | ||
1961 | <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> | |
1962 | ||
1963 | ||
1964 | ||
1965 | ||
1966 | ||
1967 | <label class="md-nav__title" for="__toc"> | |
1968 | <span class="md-nav__icon md-icon"></span> | |
1969 | Table of contents | |
1970 | </label> | |
1971 | <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> | |
1972 | ||
1973 | <li class="md-nav__item"> | |
1974 | <a href="#comments" class="md-nav__link"> | |
1975 | Comments | |
1976 | </a> | |
1977 | ||
1978 | </li> | |
1979 | ||
1980 | <li class="md-nav__item"> | |
1981 | <a href="#event-listeners" class="md-nav__link"> | |
1982 | Event Listeners | |
1983 | </a> | |
1984 | ||
1985 | </li> | |
1986 | ||
1987 | <li class="md-nav__item"> | |
1988 | <a href="#email-activation" class="md-nav__link"> | |
1989 | Email Activation | |
1990 | </a> | |
1991 | ||
1992 | </li> | |
1993 | ||
1994 | <li class="md-nav__item"> | |
1995 | <a href="#addform" class="md-nav__link"> | |
1996 | *AddForm | |
1997 | </a> | |
1998 | ||
1999 | </li> | |
2000 | ||
2001 | <li class="md-nav__item"> | |
2002 | <a href="#user-generated-links" class="md-nav__link"> | |
2003 | User Generated Links | |
2004 | </a> | |
2005 | ||
2006 | </li> | |
2007 | ||
2008 | <li class="md-nav__item"> | |
2009 | <a href="#resource-management-when-scaling-images" class="md-nav__link"> | |
2010 | Resource Management When Scaling Images | |
2011 | </a> | |
2012 | ||
2013 | </li> | |
2014 | ||
2015 | <li class="md-nav__item"> | |
2016 | <a href="#toggle-for-accelerated-mobile-pages-amp" class="md-nav__link"> | |
2017 | Toggle for Accelerated Mobile Pages (AMP) | |
2018 | </a> | |
2019 | ||
2020 | </li> | |
2021 | ||
2022 | </ul> | |
2023 | ||
2024 | </nav> | |
2025 | </div> | |
2026 | </div> | |
2027 | </div> | |
2028 | ||
2029 | ||
2030 | <div class="md-content" data-md-component="content"> | |
2031 | <article class="md-content__inner md-typeset"> | |
2032 | ||
2033 | ||
9b8bddda | 2034 | <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/migration/wsc52/php.md" title="Edit this page" class="md-content__button md-icon"> |
7124f4cb WG |
2035 | <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> |
2036 | </a> | |
2037 | ||
0c5338dd TD |
2038 | |
2039 | <h1 id="migrating-from-wsc-52-php">Migrating from WSC 5.2 - PHP<a class="headerlink" href="#migrating-from-wsc-52-php" title="Permanent link">#</a></h1> | |
2040 | <h2 id="comments">Comments<a class="headerlink" href="#comments" title="Permanent link">#</a></h2> | |
2041 | <p>The <a href="https://github.com/WoltLab/WCF/blob/aa96d34130d58c150a35ebd8936f09c830ccd685/wcfsetup/install/files/lib/system/comment/manager/ICommentManager.class.php#L151-L158"><code>ICommentManager::isContentAuthor(Comment|CommentResponse): bool</code></a> method was added. | |
2042 | A default implementation that always returns <code>false</code> is available when inheriting from <code>AbstractCommentManager</code>.</p> | |
2043 | <p>It is strongly recommended to implement <code>isContentAuthor</code> within your custom comment manager. | |
2044 | An example implementation <a href="https://github.com/WoltLab/WCF/blob/aa96d34130d58c150a35ebd8936f09c830ccd685/wcfsetup/install/files/lib/system/comment/manager/ArticleCommentManager.class.php#L213-L219">can be found in <code>ArticleCommentManager</code></a>.</p> | |
2045 | <h2 id="event-listeners">Event Listeners<a class="headerlink" href="#event-listeners" title="Permanent link">#</a></h2> | |
2046 | <p>The <a href="https://github.com/WoltLab/WCF/blob/75631516d45f9355f6c73d6375bf804d2abd587e/wcfsetup/install/files/lib/system/event/listener/AbstractEventListener.class.php"><code>AbstractEventListener</code></a> class was added. | |
2047 | <code>AbstractEventListener</code> contains an implementation of <code>execute()</code> that will dispatch the event handling to dedicated methods based on the <code>$eventName</code> and, in case of the event object being an <code>AbstractDatabaseObjectAction</code>, the action name.</p> | |
2048 | <p>Find the details of the dispatch behavior within the class comment of <code>AbstractEventListener</code>.</p> | |
2049 | <h2 id="email-activation">Email Activation<a class="headerlink" href="#email-activation" title="Permanent link">#</a></h2> | |
2050 | <p>Starting with WoltLab Suite 5.3 the user activation status is independent of the email activation status. | |
2051 | A user can be activated even though their email address has not been confirmed, preventing emails being sent to these users. | |
2052 | Going forward the new <code>User::isEmailConfirmed()</code> method should be used to check whether sending automated emails to this user is acceptable. | |
2053 | If you need to check the user's activation status you should use the new method <code>User::pendingActivation()</code> instead of relying on <code>activationCode</code>. | |
2054 | To check, which type of activation is missing, you can use the new methods <code>User::requiresEmailActivation()</code> and <code>User::requiresAdminActivation()</code>.</p> | |
2055 | <h2 id="addform"><code>*AddForm</code><a class="headerlink" href="#addform" title="Permanent link">#</a></h2> | |
2056 | <p>WoltLab Suite 5.3 provides a new framework to allow the administrator to easily edit newly created objects by adding an edit link to the success message. | |
2057 | To support this edit link two small changes are required within your <code>*AddForm</code>.</p> | |
2058 | <ol> | |
2059 | <li> | |
2060 | <p>Update the template.</p> | |
2061 | <p>Replace: | |
2062 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">'formError'</span><span class="cp">}</span><span class="x"></span> | |
2063 | ||
2064 | <span class="cp">{</span><span class="nf">if</span> <span class="nv">$success</span><span class="o">|</span><span class="na">isset</span><span class="cp">}</span><span class="x"></span> | |
2065 | <span class="x"> <p class="success"></span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">wcf.global.success.</span><span class="cp">{</span><span class="nv">$action</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></p></span> | |
2066 | <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span> | |
2067 | </code></pre></div></p> | |
2068 | <p>With: | |
2069 | <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">include</span> <span class="na">file</span><span class="o">=</span><span class="s1">'formNotice'</span><span class="cp">}</span><span class="x"></span> | |
2070 | </code></pre></div></p> | |
2071 | </li> | |
2072 | <li> | |
2073 | <p>Expose <code>objectEditLink</code> to the template.</p> | |
2074 | <p>Example (<code>$object</code> being the newly created object): | |
2075 | <div class="highlight"><pre><span></span><code><span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-></span><span class="na">assign</span><span class="p">([</span> | |
2076 | <span class="s1">'success'</span> <span class="o">=></span> <span class="k">true</span><span class="p">,</span> | |
2077 | <span class="s1">'objectEditLink'</span> <span class="o">=></span> <span class="nx">LinkHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getControllerLink</span><span class="p">(</span><span class="nx">ObjectEditForm</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="p">[</span><span class="s1">'id'</span> <span class="o">=></span> <span class="nv">$object</span><span class="o">-></span><span class="na">objectID</span><span class="p">]),</span> | |
2078 | <span class="p">]);</span> | |
2079 | </code></pre></div></p> | |
2080 | </li> | |
2081 | </ol> | |
2082 | <h2 id="user-generated-links">User Generated Links<a class="headerlink" href="#user-generated-links" title="Permanent link">#</a></h2> | |
2083 | <p>It is <a href="https://support.google.com/webmasters/answer/96569">recommended by search engines</a> to mark up links within user generated content using the <code>rel="ugc"</code> attribute to indicate that they might be less trustworthy or spammy.</p> | |
2084 | <p>WoltLab Suite 5.3 will automatically sets that attribute on external links during message output processing. | |
2085 | Set the new <code>HtmlOutputProcessor::$enableUgc</code> property to <code>false</code> if the type of message is not user-generated content, but restricted to a set of trustworthy users. | |
2086 | An example of such a type of message would be official news articles.</p> | |
2087 | <p>If you manually generate links based off user input you need to specify the attribute yourself. | |
2088 | The <code>$isUgc</code> attribute was added to <a href="https://github.com/WoltLab/WCF/blob/af245d7b9bdb411a344f79c0a038350c1f103e70/wcfsetup/install/files/lib/util/StringUtil.class.php#L664-L673"><code>StringUtil::getAnchorTag(string, string, bool, bool): string</code></a>, allowing you to easily generate a correct anchor tag.</p> | |
2089 | <p>If you need to specify additional HTML attributes for the anchor tag you can use the new <a href="https://github.com/WoltLab/WCF/blob/af245d7b9bdb411a344f79c0a038350c1f103e70/wcfsetup/install/files/lib/util/StringUtil.class.php#L691-L699"><code>StringUtil::getAnchorTagAttributes(string, bool): string</code></a> method to generate the anchor attributes that are dependent on the target URL. | |
2090 | Specifically the attributes returned are the <code>class="externalURL"</code> attribute, the <code>rel="…"</code> attribute and the <code>target="…"</code> attribute.</p> | |
2091 | <p>Within the template the <a href="../../../view/template-plugins/#53-anchorattributes"><code>{anchorAttributes}</code></a> template plugin is newly available.</p> | |
2092 | <h2 id="resource-management-when-scaling-images">Resource Management When Scaling Images<a class="headerlink" href="#resource-management-when-scaling-images" title="Permanent link">#</a></h2> | |
2093 | <p>It was discovered that the code holds references to scaled image resources for an unnecessarily long time, taking up memory. | |
2094 | This becomes especially apparent when multiple images are scaled within a loop, reusing the same variable name for consecutive images. | |
2095 | Unless the destination variable is explicitely cleared before processing the next image up to two images will be stored in memory concurrently. | |
2096 | This possibly causes the request to exceed the memory limit or ImageMagick's internal resource limits, even if sufficient resources would have been available to scale the current image.</p> | |
2097 | <p>Starting with WoltLab Suite 5.3 it is recommended to clear image handles as early as possible. | |
2098 | The usual pattern of creating a thumbnail for an existing image would then look like this:</p> | |
2099 | <div class="highlight"><pre><span></span><code><span class="o"><?</span><span class="nx">php</span> | |
2100 | <span class="k">foreach</span> <span class="p">([</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">500</span> <span class="p">]</span> <span class="k">as</span> <span class="nv">$size</span><span class="p">)</span> <span class="p">{</span> | |
2101 | <span class="nv">$adapter</span> <span class="o">=</span> <span class="nx">ImageHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">getAdapter</span><span class="p">();</span> | |
2102 | <span class="nv">$adapter</span><span class="o">-></span><span class="na">loadFile</span><span class="p">(</span><span class="nv">$src</span><span class="p">);</span> | |
2103 | <span class="nv">$thumbnail</span> <span class="o">=</span> <span class="nv">$adapter</span><span class="o">-></span><span class="na">createThumbnail</span><span class="p">(</span> | |
2104 | <span class="nv">$size</span><span class="p">,</span> | |
2105 | <span class="nv">$size</span><span class="p">,</span> | |
2106 | <span class="k">true</span> | |
2107 | <span class="p">);</span> | |
2108 | <span class="nv">$adapter</span><span class="o">-></span><span class="na">writeImage</span><span class="p">(</span><span class="nv">$thumbnail</span><span class="p">,</span> <span class="nv">$destination</span><span class="p">);</span> | |
2109 | <span class="c1">// New: Clear thumbnail as soon as possible to free up the memory.</span> | |
2110 | <span class="nv">$thumbnail</span> <span class="o">=</span> <span class="k">null</span><span class="p">;</span> | |
2111 | <span class="p">}</span> | |
2112 | </code></pre></div> | |
0c5338dd TD |
2113 | <p>Refer to <a href="https://github.com/WoltLab/WCF/pull/3505">WoltLab/WCF#3505</a> for additional details.</p> |
2114 | <h2 id="toggle-for-accelerated-mobile-pages-amp">Toggle for Accelerated Mobile Pages (AMP)<a class="headerlink" href="#toggle-for-accelerated-mobile-pages-amp" title="Permanent link">#</a></h2> | |
2115 | <p>Controllers delivering AMP versions of pages have to check for the new option <code>MODULE_AMP</code> and the templates of the non-AMP versions have to also check if the option is enabled before outputting the <code><link rel="amphtml" /></code> element.</p> | |
2116 | ||
4a5c32e1 WG |
2117 | |
2118 | ||
2119 | ||
2120 | <hr> | |
2121 | <div class="md-source-date"> | |
2122 | <small> | |
2123 | ||
2124 | Last update: 2021-01-08 | |
2125 | ||
2126 | </small> | |
2127 | </div> | |
2128 | ||
2129 | ||
0c5338dd TD |
2130 | |
2131 | ||
2132 | ||
2133 | ||
2134 | ||
2135 | ||
2136 | </article> | |
2137 | </div> | |
2138 | </div> | |
fb962f09 | 2139 | |
0c5338dd TD |
2140 | </main> |
2141 | ||
2142 | ||
2143 | <footer class="md-footer"> | |
2144 | ||
2145 | <nav class="md-footer__inner md-grid" aria-label="Footer"> | |
2146 | ||
2147 | <a href="../../wsc53/libraries/" class="md-footer__link md-footer__link--prev" rel="prev"> | |
2148 | <div class="md-footer__button md-icon"> | |
2149 | <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> | |
2150 | </div> | |
2151 | <div class="md-footer__title"> | |
2152 | <div class="md-ellipsis"> | |
2153 | <span class="md-footer__direction"> | |
2154 | Previous | |
2155 | </span> | |
2156 | Third Party Libraries | |
2157 | </div> | |
2158 | </div> | |
2159 | </a> | |
2160 | ||
2161 | ||
2162 | <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next"> | |
2163 | <div class="md-footer__title"> | |
2164 | <div class="md-ellipsis"> | |
2165 | <span class="md-footer__direction"> | |
2166 | Next | |
2167 | </span> | |
2168 | Templates and Languages | |
2169 | </div> | |
2170 | </div> | |
2171 | <div class="md-footer__button md-icon"> | |
2172 | <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> | |
2173 | </div> | |
2174 | </a> | |
2175 | ||
2176 | </nav> | |
2177 | ||
2178 | <div class="md-footer-meta md-typeset"> | |
2179 | <div class="md-footer-meta__inner md-grid"> | |
2180 | <div class="md-footer-copyright"> | |
2181 | ||
2182 | <div class="md-footer-copyright__highlight"> | |
2183 | Copyright © 2020 WoltLab GmbH | |
2184 | </div> | |
2185 | ||
2186 | Made with | |
2187 | <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> | |
2188 | Material for MkDocs | |
2189 | </a> | |
fb88dc6e | 2190 | |
0c5338dd TD |
2191 | </div> |
2192 | <div class="md-footer-copyright"> | |
2193 | <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a> | |
2194 | <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a> | |
2195 | </div> | |
2196 | </div> | |
2197 | </div> | |
2198 | </footer> | |
2199 | ||
2200 | </div> | |
2201 | <div class="md-dialog" data-md-component="dialog"> | |
2202 | <div class="md-dialog__inner md-typeset"></div> | |
2203 | </div> | |
fb962f09 | 2204 | <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> |
0c5338dd TD |
2205 | |
2206 | ||
fb962f09 | 2207 | <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script> |
0c5338dd TD |
2208 | |
2209 | ||
2210 | </body> | |
2211 | </html> |