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