Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / migration / wsc53 / libraries / index.html
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
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
14
15
16
17 <title>Third Party Libraries - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#migrating-from-wsc-53-third-party-libraries" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
79
80 <header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
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 Third Party Libraries
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
110 <label class="md-header__button md-icon" for="__search">
111 <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>
112 </label>
113
114 <div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <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>
119 <label class="md-search__icon md-icon" for="__search">
120 <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>
121 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 </label>
123 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.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>
125 </button>
126 </form>
127 <div class="md-search__output">
128 <div class="md-search__scrollwrap" data-md-scrollfix>
129 <div class="md-search-result" data-md-component="search-result">
130 <div class="md-search-result__meta">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138 </div>
139
140
141 </nav>
142 </header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
154 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
155 <div class="md-sidebar__scrollwrap">
156 <div class="md-sidebar__inner">
157
158
159
160
161
162 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163 <label class="md-nav__title" for="__drawer">
164 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
165
166 <img src="../../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197 <li class="md-nav__item md-nav__item--nested">
198
199
200 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
201
202 <label class="md-nav__link" for="__nav_2">
203 PHP API
204 <span class="md-nav__icon md-icon"></span>
205 </label>
206 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
207 <label class="md-nav__title" for="__nav_2">
208 <span class="md-nav__icon md-icon"></span>
209 PHP API
210 </label>
211 <ul class="md-nav__list" data-md-scrollfix>
212
213
214
215
216
217 <li class="md-nav__item">
218 <a href="../../../php/pages/" class="md-nav__link">
219 Pages
220 </a>
221 </li>
222
223
224
225
226
227
228
229 <li class="md-nav__item">
230 <a href="../../../php/database-objects/" class="md-nav__link">
231 Database Objects
232 </a>
233 </li>
234
235
236
237
238
239
240
241 <li class="md-nav__item">
242 <a href="../../../php/database-access/" class="md-nav__link">
243 Database Access
244 </a>
245 </li>
246
247
248
249
250
251
252
253 <li class="md-nav__item">
254 <a href="../../../php/exceptions/" class="md-nav__link">
255 Exceptions
256 </a>
257 </li>
258
259
260
261
262
263
264
265
266 <li class="md-nav__item md-nav__item--nested">
267
268
269 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
270
271 <label class="md-nav__link" for="__nav_2_5">
272 API
273 <span class="md-nav__icon md-icon"></span>
274 </label>
275 <nav class="md-nav" aria-label="API" data-md-level="2">
276 <label class="md-nav__title" for="__nav_2_5">
277 <span class="md-nav__icon md-icon"></span>
278 API
279 </label>
280 <ul class="md-nav__list" data-md-scrollfix>
281
282
283
284
285
286 <li class="md-nav__item">
287 <a href="../../../php/api/caches/" class="md-nav__link">
288 Caches
289 </a>
290 </li>
291
292
293
294
295
296
297
298 <li class="md-nav__item">
299 <a href="../../../php/api/comments/" class="md-nav__link">
300 Comments
301 </a>
302 </li>
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/api/cronjobs/" class="md-nav__link">
312 Cronjobs
313 </a>
314 </li>
315
316
317
318
319
320
321
322 <li class="md-nav__item">
323 <a href="../../../php/api/events/" class="md-nav__link">
324 Events
325 </a>
326 </li>
327
328
329
330
331
332
333
334
335 <li class="md-nav__item md-nav__item--nested">
336
337
338 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
339
340 <label class="md-nav__link" for="__nav_2_5_5">
341 Form Builder
342 <span class="md-nav__icon md-icon"></span>
343 </label>
344 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
345 <label class="md-nav__title" for="__nav_2_5_5">
346 <span class="md-nav__icon md-icon"></span>
347 Form Builder
348 </label>
349 <ul class="md-nav__list" data-md-scrollfix>
350
351
352
353
354
355 <li class="md-nav__item">
356 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
357 Overview
358 </a>
359 </li>
360
361
362
363
364
365
366
367 <li class="md-nav__item">
368 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
369 Structure
370 </a>
371 </li>
372
373
374
375
376
377
378
379 <li class="md-nav__item">
380 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
381 Fields
382 </a>
383 </li>
384
385
386
387
388
389
390
391 <li class="md-nav__item">
392 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
393 Validation and Data
394 </a>
395 </li>
396
397
398
399
400
401
402
403 <li class="md-nav__item">
404 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
405 Dependencies
406 </a>
407 </li>
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421 <li class="md-nav__item">
422 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
423 Package Installation Plugins
424 </a>
425 </li>
426
427
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
435 User Activity Points
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../../../php/api/user_notifications/" class="md-nav__link">
447 User Notifications
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../../../php/api/sitemaps/" class="md-nav__link">
459 Sitemaps
460 </a>
461 </li>
462
463
464
465 </ul>
466 </nav>
467 </li>
468
469
470
471
472
473
474
475 <li class="md-nav__item">
476 <a href="../../../php/code-style/" class="md-nav__link">
477 Code Style
478 </a>
479 </li>
480
481
482
483
484
485
486
487 <li class="md-nav__item">
488 <a href="../../../php/apps/" class="md-nav__link">
489 Apps
490 </a>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../../../php/gdpr/" class="md-nav__link">
501 GDPR
502 </a>
503 </li>
504
505
506
507 </ul>
508 </nav>
509 </li>
510
511
512
513
514
515
516
517
518
519
520
521 <li class="md-nav__item md-nav__item--nested">
522
523
524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
525
526 <label class="md-nav__link" for="__nav_3">
527 Languages, Templates & CSS
528 <span class="md-nav__icon md-icon"></span>
529 </label>
530 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
531 <label class="md-nav__title" for="__nav_3">
532 <span class="md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
534 </label>
535 <ul class="md-nav__list" data-md-scrollfix>
536
537
538
539
540
541 <li class="md-nav__item">
542 <a href="../../../view/languages/" class="md-nav__link">
543 Languages
544 </a>
545 </li>
546
547
548
549
550
551
552
553 <li class="md-nav__item">
554 <a href="../../../view/templates/" class="md-nav__link">
555 Templates
556 </a>
557 </li>
558
559
560
561
562
563
564
565 <li class="md-nav__item">
566 <a href="../../../view/css/" class="md-nav__link">
567 CSS
568 </a>
569 </li>
570
571
572
573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item md-nav__item--nested">
588
589
590 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
591
592 <label class="md-nav__link" for="__nav_4">
593 JavaScript API
594 <span class="md-nav__icon md-icon"></span>
595 </label>
596 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
597 <label class="md-nav__title" for="__nav_4">
598 <span class="md-nav__icon md-icon"></span>
599 JavaScript API
600 </label>
601 <ul class="md-nav__list" data-md-scrollfix>
602
603
604
605
606
607 <li class="md-nav__item">
608 <a href="../../../javascript/general-usage/" class="md-nav__link">
609 General Usage
610 </a>
611 </li>
612
613
614
615
616
617
618
619
620 <li class="md-nav__item md-nav__item--nested">
621
622
623 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
624
625 <label class="md-nav__link" for="__nav_4_2">
626 New API
627 <span class="md-nav__icon md-icon"></span>
628 </label>
629 <nav class="md-nav" aria-label="New API" data-md-level="2">
630 <label class="md-nav__title" for="__nav_4_2">
631 <span class="md-nav__icon md-icon"></span>
632 New API
633 </label>
634 <ul class="md-nav__list" data-md-scrollfix>
635
636
637
638
639
640 <li class="md-nav__item">
641 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
642 Writing a module
643 </a>
644 </li>
645
646
647
648
649
650
651
652 <li class="md-nav__item">
653 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
654 Data Structures
655 </a>
656 </li>
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../javascript/new-api_core/" class="md-nav__link">
666 Core Functions
667 </a>
668 </li>
669
670
671
672
673
674
675
676 <li class="md-nav__item">
677 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
678 DOM
679 </a>
680 </li>
681
682
683
684
685
686
687
688 <li class="md-nav__item">
689 <a href="../../../javascript/new-api_events/" class="md-nav__link">
690 Event Handling
691 </a>
692 </li>
693
694
695
696
697
698
699
700 <li class="md-nav__item">
701 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
702 Ajax
703 </a>
704 </li>
705
706
707
708
709
710
711
712 <li class="md-nav__item">
713 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
714 Dialogs
715 </a>
716 </li>
717
718
719
720
721
722
723
724 <li class="md-nav__item">
725 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
726 Browser and Screen Sizes
727 </a>
728 </li>
729
730
731
732
733
734
735
736 <li class="md-nav__item">
737 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
738 User Interface
739 </a>
740 </li>
741
742
743
744 </ul>
745 </nav>
746 </li>
747
748
749
750
751
752
753
754 <li class="md-nav__item">
755 <a href="../../../javascript/legacy-api/" class="md-nav__link">
756 Legacy API
757 </a>
758 </li>
759
760
761
762
763
764
765
766 <li class="md-nav__item">
767 <a href="../../../javascript/helper-functions/" class="md-nav__link">
768 Helper Functions
769 </a>
770 </li>
771
772
773
774
775
776
777
778 <li class="md-nav__item">
779 <a href="../../../javascript/code-snippets/" class="md-nav__link">
780 Code Snippets
781 </a>
782 </li>
783
784
785
786 </ul>
787 </nav>
788 </li>
789
790
791
792
793
794
795
796
797
798
799
800 <li class="md-nav__item md-nav__item--nested">
801
802
803 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
804
805 <label class="md-nav__link" for="__nav_5">
806 Package Components
807 <span class="md-nav__icon md-icon"></span>
808 </label>
809 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
810 <label class="md-nav__title" for="__nav_5">
811 <span class="md-nav__icon md-icon"></span>
812 Package Components
813 </label>
814 <ul class="md-nav__list" data-md-scrollfix>
815
816
817
818
819
820 <li class="md-nav__item">
821 <a href="../../../package/package-xml/" class="md-nav__link">
822 package.xml
823 </a>
824 </li>
825
826
827
828
829
830
831
832
833 <li class="md-nav__item md-nav__item--nested">
834
835
836 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
837
838 <label class="md-nav__link" for="__nav_5_2">
839 PIPs
840 <span class="md-nav__icon md-icon"></span>
841 </label>
842 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
843 <label class="md-nav__title" for="__nav_5_2">
844 <span class="md-nav__icon md-icon"></span>
845 PIPs
846 </label>
847 <ul class="md-nav__list" data-md-scrollfix>
848
849
850
851
852
853 <li class="md-nav__item">
854 <a href="../../../package/pip/" class="md-nav__link">
855 Overview
856 </a>
857 </li>
858
859
860
861
862
863
864
865 <li class="md-nav__item">
866 <a href="../../../package/pip/acl-option/" class="md-nav__link">
867 aclOption
868 </a>
869 </li>
870
871
872
873
874
875
876
877 <li class="md-nav__item">
878 <a href="../../../package/pip/acp-menu/" class="md-nav__link">
879 acpMenu
880 </a>
881 </li>
882
883
884
885
886
887
888
889 <li class="md-nav__item">
890 <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
891 acpSearchProvider
892 </a>
893 </li>
894
895
896
897
898
899
900
901 <li class="md-nav__item">
902 <a href="../../../package/pip/acp-template/" class="md-nav__link">
903 acpTemplate
904 </a>
905 </li>
906
907
908
909
910
911
912
913 <li class="md-nav__item">
914 <a href="../../../package/pip/bbcode/" class="md-nav__link">
915 bbcode
916 </a>
917 </li>
918
919
920
921
922
923
924
925 <li class="md-nav__item">
926 <a href="../../../package/pip/box/" class="md-nav__link">
927 box
928 </a>
929 </li>
930
931
932
933
934
935
936
937 <li class="md-nav__item">
938 <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
939 clipboardAction
940 </a>
941 </li>
942
943
944
945
946
947
948
949 <li class="md-nav__item">
950 <a href="../../../package/pip/core-object/" class="md-nav__link">
951 coreObject
952 </a>
953 </li>
954
955
956
957
958
959
960
961 <li class="md-nav__item">
962 <a href="../../../package/pip/cronjob/" class="md-nav__link">
963 cronjob
964 </a>
965 </li>
966
967
968
969
970
971
972
973 <li class="md-nav__item">
974 <a href="../../../package/pip/event-listener/" class="md-nav__link">
975 eventListener
976 </a>
977 </li>
978
979
980
981
982
983
984
985 <li class="md-nav__item">
986 <a href="../../../package/pip/file/" class="md-nav__link">
987 file
988 </a>
989 </li>
990
991
992
993
994
995
996
997 <li class="md-nav__item">
998 <a href="../../../package/pip/language/" class="md-nav__link">
999 language
1000 </a>
1001 </li>
1002
1003
1004
1005
1006
1007
1008
1009 <li class="md-nav__item">
1010 <a href="../../../package/pip/media-provider/" class="md-nav__link">
1011 mediaProvider
1012 </a>
1013 </li>
1014
1015
1016
1017
1018
1019
1020
1021 <li class="md-nav__item">
1022 <a href="../../../package/pip/menu/" class="md-nav__link">
1023 menu
1024 </a>
1025 </li>
1026
1027
1028
1029
1030
1031
1032
1033 <li class="md-nav__item">
1034 <a href="../../../package/pip/menu-item/" class="md-nav__link">
1035 menuItem
1036 </a>
1037 </li>
1038
1039
1040
1041
1042
1043
1044
1045 <li class="md-nav__item">
1046 <a href="../../../package/pip/object-type/" class="md-nav__link">
1047 objectType
1048 </a>
1049 </li>
1050
1051
1052
1053
1054
1055
1056
1057 <li class="md-nav__item">
1058 <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1059 objectTypeDefinition
1060 </a>
1061 </li>
1062
1063
1064
1065
1066
1067
1068
1069 <li class="md-nav__item">
1070 <a href="../../../package/pip/option/" class="md-nav__link">
1071 option
1072 </a>
1073 </li>
1074
1075
1076
1077
1078
1079
1080
1081 <li class="md-nav__item">
1082 <a href="../../../package/pip/page/" class="md-nav__link">
1083 page
1084 </a>
1085 </li>
1086
1087
1088
1089
1090
1091
1092
1093 <li class="md-nav__item">
1094 <a href="../../../package/pip/pip/" class="md-nav__link">
1095 pip
1096 </a>
1097 </li>
1098
1099
1100
1101
1102
1103
1104
1105 <li class="md-nav__item">
1106 <a href="../../../package/pip/script/" class="md-nav__link">
1107 script
1108 </a>
1109 </li>
1110
1111
1112
1113
1114
1115
1116
1117 <li class="md-nav__item">
1118 <a href="../../../package/pip/smiley/" class="md-nav__link">
1119 smiley
1120 </a>
1121 </li>
1122
1123
1124
1125
1126
1127
1128
1129 <li class="md-nav__item">
1130 <a href="../../../package/pip/sql/" class="md-nav__link">
1131 sql
1132 </a>
1133 </li>
1134
1135
1136
1137
1138
1139
1140
1141 <li class="md-nav__item">
1142 <a href="../../../package/pip/style/" class="md-nav__link">
1143 style
1144 </a>
1145 </li>
1146
1147
1148
1149
1150
1151
1152
1153 <li class="md-nav__item">
1154 <a href="../../../package/pip/template/" class="md-nav__link">
1155 template
1156 </a>
1157 </li>
1158
1159
1160
1161
1162
1163
1164
1165 <li class="md-nav__item">
1166 <a href="../../../package/pip/template-listener/" class="md-nav__link">
1167 templateListener
1168 </a>
1169 </li>
1170
1171
1172
1173
1174
1175
1176
1177 <li class="md-nav__item">
1178 <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1179 userGroupOption
1180 </a>
1181 </li>
1182
1183
1184
1185
1186
1187
1188
1189 <li class="md-nav__item">
1190 <a href="../../../package/pip/user-menu/" class="md-nav__link">
1191 userMenu
1192 </a>
1193 </li>
1194
1195
1196
1197
1198
1199
1200
1201 <li class="md-nav__item">
1202 <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1203 userNotificationEvent
1204 </a>
1205 </li>
1206
1207
1208
1209
1210
1211
1212
1213 <li class="md-nav__item">
1214 <a href="../../../package/pip/user-option/" class="md-nav__link">
1215 userOption
1216 </a>
1217 </li>
1218
1219
1220
1221
1222
1223
1224
1225 <li class="md-nav__item">
1226 <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1227 userProfileMenu
1228 </a>
1229 </li>
1230
1231
1232
1233 </ul>
1234 </nav>
1235 </li>
1236
1237
1238
1239
1240
1241
1242
1243 <li class="md-nav__item">
1244 <a href="../../../package/database-php-api/" class="md-nav__link">
1245 Database PHP API
1246 </a>
1247 </li>
1248
1249
1250
1251 </ul>
1252 </nav>
1253 </li>
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1268
1269
1270 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1271
1272 <label class="md-nav__link" for="__nav_6">
1273 Migration
1274 <span class="md-nav__icon md-icon"></span>
1275 </label>
1276 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1277 <label class="md-nav__title" for="__nav_6">
1278 <span class="md-nav__icon md-icon"></span>
1279 Migration
1280 </label>
1281 <ul class="md-nav__list" data-md-scrollfix>
1282
1283
1284
1285
1286
1287
1288
1289
1290 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1291
1292
1293 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
1294
1295 <label class="md-nav__link" for="__nav_6_1">
1296 Migrating from WSC 5.3
1297 <span class="md-nav__icon md-icon"></span>
1298 </label>
1299 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1300 <label class="md-nav__title" for="__nav_6_1">
1301 <span class="md-nav__icon md-icon"></span>
1302 Migrating from WSC 5.3
1303 </label>
1304 <ul class="md-nav__list" data-md-scrollfix>
1305
1306
1307
1308
1309
1310 <li class="md-nav__item">
1311 <a href="../php/" class="md-nav__link">
1312 PHP API
1313 </a>
1314 </li>
1315
1316
1317
1318
1319
1320
1321
1322 <li class="md-nav__item">
1323 <a href="../session/" class="md-nav__link">
1324 Session Handling and Authentication
1325 </a>
1326 </li>
1327
1328
1329
1330
1331
1332
1333
1334 <li class="md-nav__item">
1335 <a href="../javascript/" class="md-nav__link">
1336 JavaScript
1337 </a>
1338 </li>
1339
1340
1341
1342
1343
1344
1345
1346 <li class="md-nav__item">
1347 <a href="../templates/" class="md-nav__link">
1348 Templates
1349 </a>
1350 </li>
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360 <li class="md-nav__item md-nav__item--active">
1361
1362 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1363
1364
1365
1366
1367 <label class="md-nav__link md-nav__link--active" for="__toc">
1368 Third Party Libraries
1369 <span class="md-nav__icon md-icon"></span>
1370 </label>
1371
1372 <a href="./" class="md-nav__link md-nav__link--active">
1373 Third Party Libraries
1374 </a>
1375
1376
1377 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1378
1379
1380
1381
1382
1383 <label class="md-nav__title" for="__toc">
1384 <span class="md-nav__icon md-icon"></span>
1385 Table of contents
1386 </label>
1387 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1388
1389 <li class="md-nav__item">
1390 <a href="#guzzle" class="md-nav__link">
1391 Guzzle
1392 </a>
1393
1394 </li>
1395
1396 <li class="md-nav__item">
1397 <a href="#emogrifier-css-inliner" class="md-nav__link">
1398 Emogrifier / CSS Inliner
1399 </a>
1400
1401 </li>
1402
1403 <li class="md-nav__item">
1404 <a href="#scssphp" class="md-nav__link">
1405 scssphp
1406 </a>
1407
1408 </li>
1409
1410 <li class="md-nav__item">
1411 <a href="#constant-time-encoder" class="md-nav__link">
1412 Constant Time Encoder
1413 </a>
1414
1415 </li>
1416
1417 </ul>
1418
1419 </nav>
1420
1421 </li>
1422
1423
1424
1425 </ul>
1426 </nav>
1427 </li>
1428
1429
1430
1431
1432
1433
1434
1435
1436 <li class="md-nav__item md-nav__item--nested">
1437
1438
1439 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1440
1441 <label class="md-nav__link" for="__nav_6_2">
1442 Migrating from WSC 5.2
1443 <span class="md-nav__icon md-icon"></span>
1444 </label>
1445 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1446 <label class="md-nav__title" for="__nav_6_2">
1447 <span class="md-nav__icon md-icon"></span>
1448 Migrating from WSC 5.2
1449 </label>
1450 <ul class="md-nav__list" data-md-scrollfix>
1451
1452
1453
1454
1455
1456 <li class="md-nav__item">
1457 <a href="../../wsc52/php/" class="md-nav__link">
1458 PHP API
1459 </a>
1460 </li>
1461
1462
1463
1464
1465
1466
1467
1468 <li class="md-nav__item">
1469 <a href="../../wsc52/templates/" class="md-nav__link">
1470 Templates and Languages
1471 </a>
1472 </li>
1473
1474
1475
1476
1477
1478
1479
1480 <li class="md-nav__item">
1481 <a href="../../wsc52/libraries/" class="md-nav__link">
1482 Third Party Libraries
1483 </a>
1484 </li>
1485
1486
1487
1488 </ul>
1489 </nav>
1490 </li>
1491
1492
1493
1494
1495
1496
1497
1498
1499 <li class="md-nav__item md-nav__item--nested">
1500
1501
1502 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1503
1504 <label class="md-nav__link" for="__nav_6_3">
1505 Migrating from WSC 3.1
1506 <span class="md-nav__icon md-icon"></span>
1507 </label>
1508 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1509 <label class="md-nav__title" for="__nav_6_3">
1510 <span class="md-nav__icon md-icon"></span>
1511 Migrating from WSC 3.1
1512 </label>
1513 <ul class="md-nav__list" data-md-scrollfix>
1514
1515
1516
1517
1518
1519 <li class="md-nav__item">
1520 <a href="../../wsc31/php/" class="md-nav__link">
1521 PHP API
1522 </a>
1523 </li>
1524
1525
1526
1527 </ul>
1528 </nav>
1529 </li>
1530
1531
1532
1533
1534
1535
1536
1537
1538 <li class="md-nav__item md-nav__item--nested">
1539
1540
1541 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1542
1543 <label class="md-nav__link" for="__nav_6_4">
1544 Migrating from WSC 3.0
1545 <span class="md-nav__icon md-icon"></span>
1546 </label>
1547 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1548 <label class="md-nav__title" for="__nav_6_4">
1549 <span class="md-nav__icon md-icon"></span>
1550 Migrating from WSC 3.0
1551 </label>
1552 <ul class="md-nav__list" data-md-scrollfix>
1553
1554
1555
1556
1557
1558 <li class="md-nav__item">
1559 <a href="../../wsc30/php/" class="md-nav__link">
1560 PHP API
1561 </a>
1562 </li>
1563
1564
1565
1566
1567
1568
1569
1570 <li class="md-nav__item">
1571 <a href="../../wsc30/javascript/" class="md-nav__link">
1572 JavaScript API
1573 </a>
1574 </li>
1575
1576
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../../wsc30/templates/" class="md-nav__link">
1584 Templates
1585 </a>
1586 </li>
1587
1588
1589
1590
1591
1592
1593
1594 <li class="md-nav__item">
1595 <a href="../../wsc30/css/" class="md-nav__link">
1596 CSS
1597 </a>
1598 </li>
1599
1600
1601
1602
1603
1604
1605
1606 <li class="md-nav__item">
1607 <a href="../../wsc30/package/" class="md-nav__link">
1608 Package Components
1609 </a>
1610 </li>
1611
1612
1613
1614 </ul>
1615 </nav>
1616 </li>
1617
1618
1619
1620
1621
1622
1623
1624
1625 <li class="md-nav__item md-nav__item--nested">
1626
1627
1628 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1629
1630 <label class="md-nav__link" for="__nav_6_5">
1631 Migrating from WCF 2.1
1632 <span class="md-nav__icon md-icon"></span>
1633 </label>
1634 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1635 <label class="md-nav__title" for="__nav_6_5">
1636 <span class="md-nav__icon md-icon"></span>
1637 Migrating from WCF 2.1
1638 </label>
1639 <ul class="md-nav__list" data-md-scrollfix>
1640
1641
1642
1643
1644
1645 <li class="md-nav__item">
1646 <a href="../../wcf21/php/" class="md-nav__link">
1647 PHP API
1648 </a>
1649 </li>
1650
1651
1652
1653
1654
1655
1656
1657 <li class="md-nav__item">
1658 <a href="../../wcf21/templates/" class="md-nav__link">
1659 Templates
1660 </a>
1661 </li>
1662
1663
1664
1665
1666
1667
1668
1669 <li class="md-nav__item">
1670 <a href="../../wcf21/css/" class="md-nav__link">
1671 CSS
1672 </a>
1673 </li>
1674
1675
1676
1677
1678
1679
1680
1681 <li class="md-nav__item">
1682 <a href="../../wcf21/package/" class="md-nav__link">
1683 Package Components
1684 </a>
1685 </li>
1686
1687
1688
1689 </ul>
1690 </nav>
1691 </li>
1692
1693
1694
1695 </ul>
1696 </nav>
1697 </li>
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709 <li class="md-nav__item md-nav__item--nested">
1710
1711
1712 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1713
1714 <label class="md-nav__link" for="__nav_7">
1715 Tutorials
1716 <span class="md-nav__icon md-icon"></span>
1717 </label>
1718 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1719 <label class="md-nav__title" for="__nav_7">
1720 <span class="md-nav__icon md-icon"></span>
1721 Tutorials
1722 </label>
1723 <ul class="md-nav__list" data-md-scrollfix>
1724
1725
1726
1727
1728
1729
1730 <li class="md-nav__item md-nav__item--nested">
1731
1732
1733 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1734
1735 <label class="md-nav__link" for="__nav_7_1">
1736 Tutorial Series
1737 <span class="md-nav__icon md-icon"></span>
1738 </label>
1739 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1740 <label class="md-nav__title" for="__nav_7_1">
1741 <span class="md-nav__icon md-icon"></span>
1742 Tutorial Series
1743 </label>
1744 <ul class="md-nav__list" data-md-scrollfix>
1745
1746
1747
1748
1749
1750 <li class="md-nav__item">
1751 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1752 Overview
1753 </a>
1754 </li>
1755
1756
1757
1758
1759
1760
1761
1762 <li class="md-nav__item">
1763 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1764 Part 1
1765 </a>
1766 </li>
1767
1768
1769
1770
1771
1772
1773
1774 <li class="md-nav__item">
1775 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1776 Part 2
1777 </a>
1778 </li>
1779
1780
1781
1782
1783
1784
1785
1786 <li class="md-nav__item">
1787 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1788 Part 3
1789 </a>
1790 </li>
1791
1792
1793
1794 </ul>
1795 </nav>
1796 </li>
1797
1798
1799
1800 </ul>
1801 </nav>
1802 </li>
1803
1804
1805
1806 </ul>
1807 </nav>
1808 </div>
1809 </div>
1810 </div>
1811
1812
1813
1814 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1815 <div class="md-sidebar__scrollwrap">
1816 <div class="md-sidebar__inner">
1817
1818 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1819
1820
1821
1822
1823
1824 <label class="md-nav__title" for="__toc">
1825 <span class="md-nav__icon md-icon"></span>
1826 Table of contents
1827 </label>
1828 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1829
1830 <li class="md-nav__item">
1831 <a href="#guzzle" class="md-nav__link">
1832 Guzzle
1833 </a>
1834
1835 </li>
1836
1837 <li class="md-nav__item">
1838 <a href="#emogrifier-css-inliner" class="md-nav__link">
1839 Emogrifier / CSS Inliner
1840 </a>
1841
1842 </li>
1843
1844 <li class="md-nav__item">
1845 <a href="#scssphp" class="md-nav__link">
1846 scssphp
1847 </a>
1848
1849 </li>
1850
1851 <li class="md-nav__item">
1852 <a href="#constant-time-encoder" class="md-nav__link">
1853 Constant Time Encoder
1854 </a>
1855
1856 </li>
1857
1858 </ul>
1859
1860 </nav>
1861 </div>
1862 </div>
1863 </div>
1864
1865
1866 <div class="md-content" data-md-component="content">
1867 <article class="md-content__inner md-typeset">
1868
1869
1870
1871 <h1 id="migrating-from-wsc-53-third-party-libraries">Migrating from WSC 5.3 - Third Party Libraries<a class="headerlink" href="#migrating-from-wsc-53-third-party-libraries" title="Permanent link">#</a></h1>
1872 <h2 id="guzzle">Guzzle<a class="headerlink" href="#guzzle" title="Permanent link">#</a></h2>
1873 <p>The bundled Guzzle version was updated to Guzzle 7.
1874 No breaking changes are expected for simple uses.
1875 A detailed <a href="https://github.com/guzzle/guzzle/blob/master/UPGRADING.md#60-to-70">Guzzle migration guide</a> can be found in the Guzzle documentation.</p>
1876 <p>The explicit <code>sink</code> that was recommended in the <a href="../../wsc52/libraries/#guzzle">migration guide for WSC 5.2</a> can now be removed, as <a href="https://github.com/guzzle/guzzle/issues/2735">the Guzzle issue #2735</a> was fixed in Guzzle 7.</p>
1877 <h2 id="emogrifier-css-inliner">Emogrifier / CSS Inliner<a class="headerlink" href="#emogrifier-css-inliner" title="Permanent link">#</a></h2>
1878 <p>The Emogrifier library was updated from version 2.2 to 5.0.
1879 This update comes with a breaking change, as the <code>Emogrifier</code> class was removed.
1880 With the updated Emogrifier library, the <code>CssInliner</code> class must be used instead.</p>
1881 <p>No compatibility layer was added for the <code>Emogrifier</code> class, as the Emogrifier library's purpose was to be used within the email subsystem of WoltLab Suite.
1882 In case you use Emogrifier directly within your own code, you will need to adjust the usage.
1883 Refer to the <a href="https://github.com/MyIntervals/emogrifier/blob/v5.0.0/CHANGELOG.md">Emogrifier CHANGELOG</a> and <a href="https://github.com/WoltLab/WCF/pull/3738">WoltLab/WCF #3738</a> if you need help making the necessary adjustments.</p>
1884 <p>If you only use Emogrifier indirectly by sending HTML mail via the email subsystem then you might notice unexpected visual changes due to the improved CSS support.
1885 Double check your CSS declarations and particularly the specificity of your selectors in these cases.</p>
1886 <h2 id="scssphp">scssphp<a class="headerlink" href="#scssphp" title="Permanent link">#</a></h2>
1887 <p>scssphp was updated from version 1.1 to 1.4.</p>
1888 <p>If you interact with scssphp only by deploying <code>.scss</code> files, then you should not experience any breaking changes, except when the improved SCSS compatibility interprets your SCSS code differently.</p>
1889 <p>If you happen to directly use scssphp in your PHP code, you should be aware that scssphp deprecated the use of output formatters in favor of a simple output style enum.</p>
1890 <p>Refer to <a href="https://github.com/WoltLab/WCF/pull/3851">WoltLab/WCF #3851</a> and the <a href="https://github.com/scssphp/scssphp/releases">scssphp releases</a> for details.</p>
1891 <h2 id="constant-time-encoder">Constant Time Encoder<a class="headerlink" href="#constant-time-encoder" title="Permanent link">#</a></h2>
1892 <p>WoltLab Suite 5.4 ships the <a href="https://github.com/paragonie/constant_time_encoding"><code>paragonie/constant_time_encoding</code> library</a>.
1893 It is recommended to use this library to perform encoding and decoding of secrets to prevent leaks via cache timing attacks.
1894 Refer to <a href="https://paragonie.com/blog/2016/06/constant-time-encoding-boring-cryptography-rfc-4648-and-you">the library author’s blog post</a> for more background detail.</p>
1895 <p>For the common case of encoding the bytes taken from a CSPRNG in hexadecimal form, the required change would look like the following:</p>
1896 <p>Previously:</p>
1897 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1898 <span class="nv">$encoded</span> <span class="o">=</span> <span class="nb">hex2bin</span><span class="p">(</span><span class="nx">random_bytes</span><span class="p">(</span><span class="mi">16</span><span class="p">));</span>
1899 </code></pre></div>
1900 <p>Now:</p>
1901 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1902 <span class="k">use</span> <span class="nx">ParagonIE\ConstantTime\Hex</span><span class="p">;</span>
1903
1904 <span class="c1">// For security reasons you should add the backslash</span>
1905 <span class="c1">// to ensure you refer to the `random_bytes` function</span>
1906 <span class="c1">// within the global namespace and not a function</span>
1907 <span class="c1">// defined in the current namespace.</span>
1908 <span class="nv">$encoded</span> <span class="o">=</span> <span class="nx">Hex</span><span class="o">::</span><span class="na">encode</span><span class="p">(</span><span class="nx">\random_bytes</span><span class="p">(</span><span class="mi">16</span><span class="p">));</span>
1909 </code></pre></div>
1910 <p>Please refer to the documentation and source code of the <code>paragonie/constant_time_encoding</code> library to learn how to use the library with different encodings (e.g. base64).</p>
1911
1912
1913
1914
1915
1916
1917
1918 </article>
1919 </div>
1920 </div>
1921 </main>
1922
1923
1924 <footer class="md-footer">
1925
1926 <nav class="md-footer__inner md-grid" aria-label="Footer">
1927
1928 <a href="../templates/" class="md-footer__link md-footer__link--prev" rel="prev">
1929 <div class="md-footer__button md-icon">
1930 <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>
1931 </div>
1932 <div class="md-footer__title">
1933 <div class="md-ellipsis">
1934 <span class="md-footer__direction">
1935 Previous
1936 </span>
1937 Templates
1938 </div>
1939 </div>
1940 </a>
1941
1942
1943 <a href="../../wsc52/php/" class="md-footer__link md-footer__link--next" rel="next">
1944 <div class="md-footer__title">
1945 <div class="md-ellipsis">
1946 <span class="md-footer__direction">
1947 Next
1948 </span>
1949 PHP API
1950 </div>
1951 </div>
1952 <div class="md-footer__button md-icon">
1953 <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>
1954 </div>
1955 </a>
1956
1957 </nav>
1958
1959 <div class="md-footer-meta md-typeset">
1960 <div class="md-footer-meta__inner md-grid">
1961 <div class="md-footer-copyright">
1962
1963 <div class="md-footer-copyright__highlight">
1964 Copyright © 2020 WoltLab GmbH
1965 </div>
1966
1967 Made with
1968 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1969 Material for MkDocs
1970 </a>
1971
1972 </div>
1973 <div class="md-footer-copyright">
1974 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
1975 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
1976 </div>
1977 </div>
1978 </div>
1979 </footer>
1980
1981 </div>
1982 <div class="md-dialog" data-md-component="dialog">
1983 <div class="md-dialog__inner md-typeset"></div>
1984 </div>
1985 <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.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
1986
1987
1988 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
1989
1990
1991 </body>
1992 </html>