6.1/php/api/package_installation_plugins/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         <link rel="canonical" href="https://docs.woltlab.com/6.1/php/api/package_installation_plugins/">
  12
  13
  14         <link rel="prev" href="../form_builder/dependencies/">
  15
  16
  17         <link rel="next" href="../user_activity_points/">
  18
  19
  20       <link rel="icon" href="../../../assets/default.favicon.ico">
  21       <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.4.2">
  22
  23
  24
  25         <title>Package Installation Plugins - WoltLab Suite Documentation</title>
  26
  27
  28
  29       <link rel="stylesheet" href="../../../assets/stylesheets/main.d451bc0e.min.css">
  30
  31
  32         <link rel="stylesheet" href="../../../assets/stylesheets/palette.a5377069.min.css">
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45       <link rel="stylesheet" href="../../../stylesheets/extra.css">
  46
  47     <script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  48
  49
  50
  51
  52
  53
  54   </head>
  55
  56
  57
  58
  59
  60
  61
  62     <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
  63
  64
  65
  66     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  67     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  68     <label class="md-overlay" for="__drawer"></label>
  69     <div data-md-component="skip">
  70
  71
  72         <a href="#package-installation-plugins" class="md-skip">
  73           Skip to content
  74         </a>
  75
  76     </div>
  77     <div data-md-component="announce">
  78
  79         <aside class="md-banner">
  80           <div class="md-banner__inner md-grid md-typeset">
  81
  82
  83     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  84
  85           </div>
  86
  87         </aside>
  88
  89     </div>
  90
  91       <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  92
  93       </div>
  94
  95
  96
  97
  98
  99
 100 <header class="md-header md-header--shadow" data-md-component="header">
 101   <nav class="md-header__inner md-grid" aria-label="Header">
 102     <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 103
 104   <img src="../../../assets/logo.png" alt="logo">
 105
 106     </a>
 107     <label class="md-header__button md-icon" for="__drawer">
 108
 109       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
 110     </label>
 111     <div class="md-header__title" data-md-component="header-title">
 112       <div class="md-header__ellipsis">
 113         <div class="md-header__topic">
 114           <span class="md-ellipsis">
 115             WoltLab Suite Documentation
 116           </span>
 117         </div>
 118         <div class="md-header__topic" data-md-component="header-topic">
 119           <span class="md-ellipsis">
 120
 121               Package Installation Plugins
 122
 123           </span>
 124         </div>
 125       </div>
 126     </div>
 127
 128
 129
 130
 131
 132       <label class="md-header__button md-icon" for="__search">
 133
 134         <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>
 135       </label>
 136       <div class="md-search" data-md-component="search" role="dialog">
 137   <label class="md-search__overlay" for="__search"></label>
 138   <div class="md-search__inner" role="search">
 139     <form class="md-search__form" name="search">
 140       <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" required>
 141       <label class="md-search__icon md-icon" for="__search">
 142
 143         <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>
 144
 145         <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>
 146       </label>
 147       <nav class="md-search__options" aria-label="Search">
 148
 149         <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
 150
 151           <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>
 152         </button>
 153       </nav>
 154
 155     </form>
 156     <div class="md-search__output">
 157       <div class="md-search__scrollwrap" data-md-scrollfix>
 158         <div class="md-search-result" data-md-component="search-result">
 159           <div class="md-search-result__meta">
 160             Initializing search
 161           </div>
 162           <ol class="md-search-result__list" role="presentation"></ol>
 163         </div>
 164       </div>
 165     </div>
 166   </div>
 167 </div>
 168
 169
 170       <div class="md-header__source">
 171         <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 172   <div class="md-source__icon md-icon">
 173
 174     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 175   </div>
 176   <div class="md-source__repository">
 177     GitHub
 178   </div>
 179 </a>
 180       </div>
 181
 182   </nav>
 183
 184 </header>
 185
 186     <div class="md-container" data-md-component="container">
 187
 188
 189
 190
 191
 192
 193       <main class="md-main" data-md-component="main">
 194         <div class="md-main__inner md-grid">
 195
 196
 197
 198               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 199                 <div class="md-sidebar__scrollwrap">
 200                   <div class="md-sidebar__inner">
 201
 202
 203
 204
 205 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 206   <label class="md-nav__title" for="__drawer">
 207     <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
 208
 209   <img src="../../../assets/logo.png" alt="logo">
 210
 211     </a>
 212     WoltLab Suite Documentation
 213   </label>
 214
 215     <div class="md-nav__source">
 216       <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 217   <div class="md-source__icon md-icon">
 218
 219     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
 220   </div>
 221   <div class="md-source__repository">
 222     GitHub
 223   </div>
 224 </a>
 225     </div>
 226
 227   <ul class="md-nav__list" data-md-scrollfix>
 228
 229
 230
 231
 232
 233
 234     <li class="md-nav__item">
 235       <a href="../../../getting-started/" class="md-nav__link">
 236
 237
 238   <span class="md-ellipsis">
 239     Getting Started
 240   </span>
 241
 242
 243       </a>
 244     </li>
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 261
 262
 263
 264
 265         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
 266
 267
 268           <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
 269
 270
 271   <span class="md-ellipsis">
 272     PHP API
 273   </span>
 274
 275
 276             <span class="md-nav__icon md-icon"></span>
 277           </label>
 278
 279         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
 280           <label class="md-nav__title" for="__nav_2">
 281             <span class="md-nav__icon md-icon"></span>
 282             PHP API
 283           </label>
 284           <ul class="md-nav__list" data-md-scrollfix>
 285
 286
 287
 288
 289
 290
 291     <li class="md-nav__item">
 292       <a href="../../pages/" class="md-nav__link">
 293
 294
 295   <span class="md-ellipsis">
 296     Pages
 297   </span>
 298
 299
 300       </a>
 301     </li>
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311     <li class="md-nav__item">
 312       <a href="../../database-objects/" class="md-nav__link">
 313
 314
 315   <span class="md-ellipsis">
 316     Database Objects
 317   </span>
 318
 319
 320       </a>
 321     </li>
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331     <li class="md-nav__item">
 332       <a href="../../database-access/" class="md-nav__link">
 333
 334
 335   <span class="md-ellipsis">
 336     Database Access
 337   </span>
 338
 339
 340       </a>
 341     </li>
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351     <li class="md-nav__item">
 352       <a href="../../exceptions/" class="md-nav__link">
 353
 354
 355   <span class="md-ellipsis">
 356     Exceptions
 357   </span>
 358
 359
 360       </a>
 361     </li>
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 379
 380
 381
 382
 383         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" checked>
 384
 385
 386           <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
 387
 388
 389   <span class="md-ellipsis">
 390     API
 391   </span>
 392
 393
 394             <span class="md-nav__icon md-icon"></span>
 395           </label>
 396
 397         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="true">
 398           <label class="md-nav__title" for="__nav_2_5">
 399             <span class="md-nav__icon md-icon"></span>
 400             API
 401           </label>
 402           <ul class="md-nav__list" data-md-scrollfix>
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414     <li class="md-nav__item md-nav__item--nested">
 415
 416
 417
 418
 419         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
 420
 421
 422           <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
 423
 424
 425   <span class="md-ellipsis">
 426     Caches
 427   </span>
 428
 429
 430             <span class="md-nav__icon md-icon"></span>
 431           </label>
 432
 433         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
 434           <label class="md-nav__title" for="__nav_2_5_1">
 435             <span class="md-nav__icon md-icon"></span>
 436             Caches
 437           </label>
 438           <ul class="md-nav__list" data-md-scrollfix>
 439
 440
 441
 442
 443
 444
 445     <li class="md-nav__item">
 446       <a href="../caches/" class="md-nav__link">
 447
 448
 449   <span class="md-ellipsis">
 450     Overview
 451   </span>
 452
 453
 454       </a>
 455     </li>
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465     <li class="md-nav__item">
 466       <a href="../caches_persistent-caches/" class="md-nav__link">
 467
 468
 469   <span class="md-ellipsis">
 470     Persistent Caches
 471   </span>
 472
 473
 474       </a>
 475     </li>
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485     <li class="md-nav__item">
 486       <a href="../caches_runtime-caches/" class="md-nav__link">
 487
 488
 489   <span class="md-ellipsis">
 490     Runtime Caches
 491   </span>
 492
 493
 494       </a>
 495     </li>
 496
 497
 498
 499
 500           </ul>
 501         </nav>
 502
 503     </li>
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513     <li class="md-nav__item">
 514       <a href="../comments/" class="md-nav__link">
 515
 516
 517   <span class="md-ellipsis">
 518     Comments
 519   </span>
 520
 521
 522       </a>
 523     </li>
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533     <li class="md-nav__item">
 534       <a href="../cronjobs/" class="md-nav__link">
 535
 536
 537   <span class="md-ellipsis">
 538     Cronjobs
 539   </span>
 540
 541
 542       </a>
 543     </li>
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553     <li class="md-nav__item">
 554       <a href="../events/" class="md-nav__link">
 555
 556
 557   <span class="md-ellipsis">
 558     Events
 559   </span>
 560
 561
 562       </a>
 563     </li>
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578     <li class="md-nav__item md-nav__item--nested">
 579
 580
 581
 582
 583         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
 584
 585
 586           <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
 587
 588
 589   <span class="md-ellipsis">
 590     Form Builder
 591   </span>
 592
 593
 594             <span class="md-nav__icon md-icon"></span>
 595           </label>
 596
 597         <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
 598           <label class="md-nav__title" for="__nav_2_5_5">
 599             <span class="md-nav__icon md-icon"></span>
 600             Form Builder
 601           </label>
 602           <ul class="md-nav__list" data-md-scrollfix>
 603
 604
 605
 606
 607
 608
 609     <li class="md-nav__item">
 610       <a href="../form_builder/overview/" class="md-nav__link">
 611
 612
 613   <span class="md-ellipsis">
 614     Overview
 615   </span>
 616
 617
 618       </a>
 619     </li>
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629     <li class="md-nav__item">
 630       <a href="../form_builder/structure/" class="md-nav__link">
 631
 632
 633   <span class="md-ellipsis">
 634     Structure
 635   </span>
 636
 637
 638       </a>
 639     </li>
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649     <li class="md-nav__item">
 650       <a href="../form_builder/form_fields/" class="md-nav__link">
 651
 652
 653   <span class="md-ellipsis">
 654     Fields
 655   </span>
 656
 657
 658       </a>
 659     </li>
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669     <li class="md-nav__item">
 670       <a href="../form_builder/validation_data/" class="md-nav__link">
 671
 672
 673   <span class="md-ellipsis">
 674     Validation and Data
 675   </span>
 676
 677
 678       </a>
 679     </li>
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689     <li class="md-nav__item">
 690       <a href="../form_builder/dependencies/" class="md-nav__link">
 691
 692
 693   <span class="md-ellipsis">
 694     Dependencies
 695   </span>
 696
 697
 698       </a>
 699     </li>
 700
 701
 702
 703
 704           </ul>
 705         </nav>
 706
 707     </li>
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719     <li class="md-nav__item md-nav__item--active">
 720
 721       <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
 722
 723
 724
 725
 726
 727         <label class="md-nav__link md-nav__link--active" for="__toc">
 728
 729
 730   <span class="md-ellipsis">
 731     Package Installation Plugins
 732   </span>
 733
 734
 735           <span class="md-nav__icon md-icon"></span>
 736         </label>
 737
 738       <a href="./" class="md-nav__link md-nav__link--active">
 739
 740
 741   <span class="md-ellipsis">
 742     Package Installation Plugins
 743   </span>
 744
 745
 746       </a>
 747
 748
 749
 750 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 751
 752
 753
 754
 755
 756
 757     <label class="md-nav__title" for="__toc">
 758       <span class="md-nav__icon md-icon"></span>
 759       Table of contents
 760     </label>
 761     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 762
 763         <li class="md-nav__item">
 764   <a href="#abstractpackageinstallationplugin" class="md-nav__link">
 765     AbstractPackageInstallationPlugin
 766   </a>
 767
 768     <nav class="md-nav" aria-label="AbstractPackageInstallationPlugin">
 769       <ul class="md-nav__list">
 770
 771           <li class="md-nav__item">
 772   <a href="#class-members" class="md-nav__link">
 773     Class Members
 774   </a>
 775
 776     <nav class="md-nav" aria-label="Class Members">
 777       <ul class="md-nav__list">
 778
 779           <li class="md-nav__item">
 780   <a href="#installation" class="md-nav__link">
 781     $installation
 782   </a>
 783
 784 </li>
 785
 786           <li class="md-nav__item">
 787   <a href="#application" class="md-nav__link">
 788     $application
 789   </a>
 790
 791 </li>
 792
 793       </ul>
 794     </nav>
 795
 796 </li>
 797
 798       </ul>
 799     </nav>
 800
 801 </li>
 802
 803         <li class="md-nav__item">
 804   <a href="#abstractxmlpackageinstallationplugin" class="md-nav__link">
 805     AbstractXMLPackageInstallationPlugin
 806   </a>
 807
 808     <nav class="md-nav" aria-label="AbstractXMLPackageInstallationPlugin">
 809       <ul class="md-nav__list">
 810
 811           <li class="md-nav__item">
 812   <a href="#class-members_1" class="md-nav__link">
 813     Class Members
 814   </a>
 815
 816     <nav class="md-nav" aria-label="Class Members">
 817       <ul class="md-nav__list">
 818
 819           <li class="md-nav__item">
 820   <a href="#classname" class="md-nav__link">
 821     $className
 822   </a>
 823
 824 </li>
 825
 826           <li class="md-nav__item">
 827   <a href="#tagname" class="md-nav__link">
 828     $tagName
 829   </a>
 830
 831 </li>
 832
 833           <li class="md-nav__item">
 834   <a href="#prepareimportarray-data" class="md-nav__link">
 835     prepareImport(array $data)
 836   </a>
 837
 838 </li>
 839
 840           <li class="md-nav__item">
 841   <a href="#validateimportarray-data" class="md-nav__link">
 842     validateImport(array $data)
 843   </a>
 844
 845 </li>
 846
 847           <li class="md-nav__item">
 848   <a href="#findexistingitemarray-data" class="md-nav__link">
 849     findExistingItem(array $data)
 850   </a>
 851
 852 </li>
 853
 854           <li class="md-nav__item">
 855   <a href="#example" class="md-nav__link">
 856     Example
 857   </a>
 858
 859 </li>
 860
 861           <li class="md-nav__item">
 862   <a href="#handledeletearray-items" class="md-nav__link">
 863     handleDelete(array $items)
 864   </a>
 865
 866 </li>
 867
 868           <li class="md-nav__item">
 869   <a href="#postimport" class="md-nav__link">
 870     postImport()
 871   </a>
 872
 873 </li>
 874
 875       </ul>
 876     </nav>
 877
 878 </li>
 879
 880       </ul>
 881     </nav>
 882
 883 </li>
 884
 885         <li class="md-nav__item">
 886   <a href="#abstractoptionpackageinstallationplugin" class="md-nav__link">
 887     AbstractOptionPackageInstallationPlugin
 888   </a>
 889
 890     <nav class="md-nav" aria-label="AbstractOptionPackageInstallationPlugin">
 891       <ul class="md-nav__list">
 892
 893           <li class="md-nav__item">
 894   <a href="#differences-to-abstractxmlpackageinstallationplugin" class="md-nav__link">
 895     Differences to AbstractXMLPackageInstallationPlugin
 896   </a>
 897
 898     <nav class="md-nav" aria-label="Differences to AbstractXMLPackageInstallationPlugin">
 899       <ul class="md-nav__list">
 900
 901           <li class="md-nav__item">
 902   <a href="#reservedtags" class="md-nav__link">
 903     $reservedTags
 904   </a>
 905
 906 </li>
 907
 908       </ul>
 909     </nav>
 910
 911 </li>
 912
 913       </ul>
 914     </nav>
 915
 916 </li>
 917
 918     </ul>
 919
 920 </nav>
 921
 922     </li>
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932     <li class="md-nav__item">
 933       <a href="../user_activity_points/" class="md-nav__link">
 934
 935
 936   <span class="md-ellipsis">
 937     User Activity Points
 938   </span>
 939
 940
 941       </a>
 942     </li>
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952     <li class="md-nav__item">
 953       <a href="../user_notifications/" class="md-nav__link">
 954
 955
 956   <span class="md-ellipsis">
 957     User Notifications
 958   </span>
 959
 960
 961       </a>
 962     </li>
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972     <li class="md-nav__item">
 973       <a href="../rss_feeds/" class="md-nav__link">
 974
 975
 976   <span class="md-ellipsis">
 977     RSS Feeds
 978   </span>
 979
 980
 981       </a>
 982     </li>
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992     <li class="md-nav__item">
 993       <a href="../sitemaps/" class="md-nav__link">
 994
 995
 996   <span class="md-ellipsis">
 997     Sitemaps
 998   </span>
 999
1000
1001       </a>
1002     </li>
1003
1004
1005
1006
1007           </ul>
1008         </nav>
1009
1010     </li>
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item">
1021       <a href="../../code-style/" class="md-nav__link">
1022
1023
1024   <span class="md-ellipsis">
1025     Code Style
1026   </span>
1027
1028
1029       </a>
1030     </li>
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040     <li class="md-nav__item">
1041       <a href="../../apps/" class="md-nav__link">
1042
1043
1044   <span class="md-ellipsis">
1045     Apps
1046   </span>
1047
1048
1049       </a>
1050     </li>
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060     <li class="md-nav__item">
1061       <a href="../../gdpr/" class="md-nav__link">
1062
1063
1064   <span class="md-ellipsis">
1065     GDPR
1066   </span>
1067
1068
1069       </a>
1070     </li>
1071
1072
1073
1074
1075           </ul>
1076         </nav>
1077
1078     </li>
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092     <li class="md-nav__item md-nav__item--nested">
1093
1094
1095
1096
1097         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
1098
1099
1100           <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
1101
1102
1103   <span class="md-ellipsis">
1104     Languages, Templates & CSS
1105   </span>
1106
1107
1108             <span class="md-nav__icon md-icon"></span>
1109           </label>
1110
1111         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
1112           <label class="md-nav__title" for="__nav_3">
1113             <span class="md-nav__icon md-icon"></span>
1114             Languages, Templates & CSS
1115           </label>
1116           <ul class="md-nav__list" data-md-scrollfix>
1117
1118
1119
1120
1121
1122
1123     <li class="md-nav__item">
1124       <a href="../../../view/languages/" class="md-nav__link">
1125
1126
1127   <span class="md-ellipsis">
1128     Languages
1129   </span>
1130
1131
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143     <li class="md-nav__item">
1144       <a href="../../../view/templates/" class="md-nav__link">
1145
1146
1147   <span class="md-ellipsis">
1148     Templates
1149   </span>
1150
1151
1152       </a>
1153     </li>
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163     <li class="md-nav__item">
1164       <a href="../../../view/template-modifiers/" class="md-nav__link">
1165
1166
1167   <span class="md-ellipsis">
1168     Template Modifiers
1169   </span>
1170
1171
1172       </a>
1173     </li>
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183     <li class="md-nav__item">
1184       <a href="../../../view/template-plugins/" class="md-nav__link">
1185
1186
1187   <span class="md-ellipsis">
1188     Template Plugins
1189   </span>
1190
1191
1192       </a>
1193     </li>
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203     <li class="md-nav__item">
1204       <a href="../../../view/css/" class="md-nav__link">
1205
1206
1207   <span class="md-ellipsis">
1208     CSS
1209   </span>
1210
1211
1212       </a>
1213     </li>
1214
1215
1216
1217
1218           </ul>
1219         </nav>
1220
1221     </li>
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235     <li class="md-nav__item md-nav__item--nested">
1236
1237
1238
1239
1240         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
1241
1242
1243           <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
1244
1245
1246   <span class="md-ellipsis">
1247     TypeScript and JavaScript API
1248   </span>
1249
1250
1251             <span class="md-nav__icon md-icon"></span>
1252           </label>
1253
1254         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
1255           <label class="md-nav__title" for="__nav_4">
1256             <span class="md-nav__icon md-icon"></span>
1257             TypeScript and JavaScript API
1258           </label>
1259           <ul class="md-nav__list" data-md-scrollfix>
1260
1261
1262
1263
1264
1265
1266     <li class="md-nav__item">
1267       <a href="../../../javascript/general-usage/" class="md-nav__link">
1268
1269
1270   <span class="md-ellipsis">
1271     General Usage
1272   </span>
1273
1274
1275       </a>
1276     </li>
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286     <li class="md-nav__item">
1287       <a href="../../../javascript/typescript/" class="md-nav__link">
1288
1289
1290   <span class="md-ellipsis">
1291     TypeScript
1292   </span>
1293
1294
1295       </a>
1296     </li>
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311     <li class="md-nav__item md-nav__item--nested">
1312
1313
1314
1315
1316         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
1317
1318
1319           <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
1320
1321
1322   <span class="md-ellipsis">
1323     Components
1324   </span>
1325
1326
1327             <span class="md-nav__icon md-icon"></span>
1328           </label>
1329
1330         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
1331           <label class="md-nav__title" for="__nav_4_3">
1332             <span class="md-nav__icon md-icon"></span>
1333             Components
1334           </label>
1335           <ul class="md-nav__list" data-md-scrollfix>
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../../../javascript/components_ckeditor5/" class="md-nav__link">
1344
1345
1346   <span class="md-ellipsis">
1347     CKEditor 5
1348   </span>
1349
1350
1351       </a>
1352     </li>
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362     <li class="md-nav__item">
1363       <a href="../../../javascript/components_confirmation/" class="md-nav__link">
1364
1365
1366   <span class="md-ellipsis">
1367     Confirmation
1368   </span>
1369
1370
1371       </a>
1372     </li>
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382     <li class="md-nav__item">
1383       <a href="../../../javascript/components_dialog/" class="md-nav__link">
1384
1385
1386   <span class="md-ellipsis">
1387     Dialog
1388   </span>
1389
1390
1391       </a>
1392     </li>
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402     <li class="md-nav__item">
1403       <a href="../../../javascript/components_google_maps/" class="md-nav__link">
1404
1405
1406   <span class="md-ellipsis">
1407     Google Maps
1408   </span>
1409
1410
1411       </a>
1412     </li>
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422     <li class="md-nav__item">
1423       <a href="../../../javascript/components_pagination/" class="md-nav__link">
1424
1425
1426   <span class="md-ellipsis">
1427     Pagination
1428   </span>
1429
1430
1431       </a>
1432     </li>
1433
1434
1435
1436
1437           </ul>
1438         </nav>
1439
1440     </li>
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455     <li class="md-nav__item md-nav__item--nested">
1456
1457
1458
1459
1460         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
1461
1462
1463           <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
1464
1465
1466   <span class="md-ellipsis">
1467     New API
1468   </span>
1469
1470
1471             <span class="md-nav__icon md-icon"></span>
1472           </label>
1473
1474         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
1475           <label class="md-nav__title" for="__nav_4_4">
1476             <span class="md-nav__icon md-icon"></span>
1477             New API
1478           </label>
1479           <ul class="md-nav__list" data-md-scrollfix>
1480
1481
1482
1483
1484
1485
1486     <li class="md-nav__item">
1487       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
1488
1489
1490   <span class="md-ellipsis">
1491     Writing a module
1492   </span>
1493
1494
1495       </a>
1496     </li>
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506     <li class="md-nav__item">
1507       <a href="../../../javascript/new-api_core/" class="md-nav__link">
1508
1509
1510   <span class="md-ellipsis">
1511     Core Functions
1512   </span>
1513
1514
1515       </a>
1516     </li>
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526     <li class="md-nav__item">
1527       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
1528
1529
1530   <span class="md-ellipsis">
1531     DOM
1532   </span>
1533
1534
1535       </a>
1536     </li>
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546     <li class="md-nav__item">
1547       <a href="../../../javascript/new-api_events/" class="md-nav__link">
1548
1549
1550   <span class="md-ellipsis">
1551     Event Handling
1552   </span>
1553
1554
1555       </a>
1556     </li>
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item">
1567       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
1568
1569
1570   <span class="md-ellipsis">
1571     Ajax
1572   </span>
1573
1574
1575       </a>
1576     </li>
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586     <li class="md-nav__item">
1587       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
1588
1589
1590   <span class="md-ellipsis">
1591     Dialogs
1592   </span>
1593
1594
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
1608
1609
1610   <span class="md-ellipsis">
1611     Browser and Screen Sizes
1612   </span>
1613
1614
1615       </a>
1616     </li>
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626     <li class="md-nav__item">
1627       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
1628
1629
1630   <span class="md-ellipsis">
1631     User Interface
1632   </span>
1633
1634
1635       </a>
1636     </li>
1637
1638
1639
1640
1641           </ul>
1642         </nav>
1643
1644     </li>
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654     <li class="md-nav__item">
1655       <a href="../../../javascript/legacy-api/" class="md-nav__link">
1656
1657
1658   <span class="md-ellipsis">
1659     Legacy API
1660   </span>
1661
1662
1663       </a>
1664     </li>
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674     <li class="md-nav__item">
1675       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1676
1677
1678   <span class="md-ellipsis">
1679     Code Snippets
1680   </span>
1681
1682
1683       </a>
1684     </li>
1685
1686
1687
1688
1689           </ul>
1690         </nav>
1691
1692     </li>
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706     <li class="md-nav__item md-nav__item--nested">
1707
1708
1709
1710
1711         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1712
1713
1714           <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
1715
1716
1717   <span class="md-ellipsis">
1718     Package Components
1719   </span>
1720
1721
1722             <span class="md-nav__icon md-icon"></span>
1723           </label>
1724
1725         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1726           <label class="md-nav__title" for="__nav_5">
1727             <span class="md-nav__icon md-icon"></span>
1728             Package Components
1729           </label>
1730           <ul class="md-nav__list" data-md-scrollfix>
1731
1732
1733
1734
1735
1736
1737     <li class="md-nav__item">
1738       <a href="../../../package/package-xml/" class="md-nav__link">
1739
1740
1741   <span class="md-ellipsis">
1742     package.xml
1743   </span>
1744
1745
1746       </a>
1747     </li>
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762     <li class="md-nav__item md-nav__item--nested">
1763
1764
1765
1766
1767         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1768
1769
1770           <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1771
1772
1773   <span class="md-ellipsis">
1774     PIPs
1775   </span>
1776
1777
1778             <span class="md-nav__icon md-icon"></span>
1779           </label>
1780
1781         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1782           <label class="md-nav__title" for="__nav_5_2">
1783             <span class="md-nav__icon md-icon"></span>
1784             PIPs
1785           </label>
1786           <ul class="md-nav__list" data-md-scrollfix>
1787
1788
1789
1790
1791
1792
1793     <li class="md-nav__item">
1794       <a href="../../../package/pip/" class="md-nav__link">
1795
1796
1797   <span class="md-ellipsis">
1798     Overview
1799   </span>
1800
1801
1802       </a>
1803     </li>
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813     <li class="md-nav__item">
1814       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1815
1816
1817   <span class="md-ellipsis">
1818     aclOption
1819   </span>
1820
1821
1822       </a>
1823     </li>
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item">
1834       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1835
1836
1837   <span class="md-ellipsis">
1838     acpMenu
1839   </span>
1840
1841
1842       </a>
1843     </li>
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853     <li class="md-nav__item">
1854       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1855
1856
1857   <span class="md-ellipsis">
1858     acpSearchProvider
1859   </span>
1860
1861
1862       </a>
1863     </li>
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873     <li class="md-nav__item">
1874       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1875
1876
1877   <span class="md-ellipsis">
1878     acpTemplate
1879   </span>
1880
1881
1882       </a>
1883     </li>
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893     <li class="md-nav__item">
1894       <a href="../../../package/pip/acp-template-delete/" class="md-nav__link">
1895
1896
1897   <span class="md-ellipsis">
1898     acpTemplateDelete
1899   </span>
1900
1901
1902       </a>
1903     </li>
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913     <li class="md-nav__item">
1914       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1915
1916
1917   <span class="md-ellipsis">
1918     bbcode
1919   </span>
1920
1921
1922       </a>
1923     </li>
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933     <li class="md-nav__item">
1934       <a href="../../../package/pip/box/" class="md-nav__link">
1935
1936
1937   <span class="md-ellipsis">
1938     box
1939   </span>
1940
1941
1942       </a>
1943     </li>
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953     <li class="md-nav__item">
1954       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1955
1956
1957   <span class="md-ellipsis">
1958     clipboardAction
1959   </span>
1960
1961
1962       </a>
1963     </li>
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973     <li class="md-nav__item">
1974       <a href="../../../package/pip/core-object/" class="md-nav__link">
1975
1976
1977   <span class="md-ellipsis">
1978     coreObject
1979   </span>
1980
1981
1982       </a>
1983     </li>
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993     <li class="md-nav__item">
1994       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1995
1996
1997   <span class="md-ellipsis">
1998     cronjob
1999   </span>
2000
2001
2002       </a>
2003     </li>
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013     <li class="md-nav__item">
2014       <a href="../../../package/pip/database/" class="md-nav__link">
2015
2016
2017   <span class="md-ellipsis">
2018     database
2019   </span>
2020
2021
2022       </a>
2023     </li>
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033     <li class="md-nav__item">
2034       <a href="../../../package/pip/event-listener/" class="md-nav__link">
2035
2036
2037   <span class="md-ellipsis">
2038     eventListener
2039   </span>
2040
2041
2042       </a>
2043     </li>
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053     <li class="md-nav__item">
2054       <a href="../../../package/pip/file/" class="md-nav__link">
2055
2056
2057   <span class="md-ellipsis">
2058     file
2059   </span>
2060
2061
2062       </a>
2063     </li>
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073     <li class="md-nav__item">
2074       <a href="../../../package/pip/file-delete/" class="md-nav__link">
2075
2076
2077   <span class="md-ellipsis">
2078     fileDelete
2079   </span>
2080
2081
2082       </a>
2083     </li>
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093     <li class="md-nav__item">
2094       <a href="../../../package/pip/language/" class="md-nav__link">
2095
2096
2097   <span class="md-ellipsis">
2098     language
2099   </span>
2100
2101
2102       </a>
2103     </li>
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113     <li class="md-nav__item">
2114       <a href="../../../package/pip/media-provider/" class="md-nav__link">
2115
2116
2117   <span class="md-ellipsis">
2118     mediaProvider
2119   </span>
2120
2121
2122       </a>
2123     </li>
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133     <li class="md-nav__item">
2134       <a href="../../../package/pip/menu/" class="md-nav__link">
2135
2136
2137   <span class="md-ellipsis">
2138     menu
2139   </span>
2140
2141
2142       </a>
2143     </li>
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153     <li class="md-nav__item">
2154       <a href="../../../package/pip/menu-item/" class="md-nav__link">
2155
2156
2157   <span class="md-ellipsis">
2158     menuItem
2159   </span>
2160
2161
2162       </a>
2163     </li>
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173     <li class="md-nav__item">
2174       <a href="../../../package/pip/object-type/" class="md-nav__link">
2175
2176
2177   <span class="md-ellipsis">
2178     objectType
2179   </span>
2180
2181
2182       </a>
2183     </li>
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193     <li class="md-nav__item">
2194       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
2195
2196
2197   <span class="md-ellipsis">
2198     objectTypeDefinition
2199   </span>
2200
2201
2202       </a>
2203     </li>
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213     <li class="md-nav__item">
2214       <a href="../../../package/pip/option/" class="md-nav__link">
2215
2216
2217   <span class="md-ellipsis">
2218     option
2219   </span>
2220
2221
2222       </a>
2223     </li>
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233     <li class="md-nav__item">
2234       <a href="../../../package/pip/page/" class="md-nav__link">
2235
2236
2237   <span class="md-ellipsis">
2238     page
2239   </span>
2240
2241
2242       </a>
2243     </li>
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253     <li class="md-nav__item">
2254       <a href="../../../package/pip/pip/" class="md-nav__link">
2255
2256
2257   <span class="md-ellipsis">
2258     pip
2259   </span>
2260
2261
2262       </a>
2263     </li>
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273     <li class="md-nav__item">
2274       <a href="../../../package/pip/script/" class="md-nav__link">
2275
2276
2277   <span class="md-ellipsis">
2278     script
2279   </span>
2280
2281
2282       </a>
2283     </li>
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293     <li class="md-nav__item">
2294       <a href="../../../package/pip/smiley/" class="md-nav__link">
2295
2296
2297   <span class="md-ellipsis">
2298     smiley
2299   </span>
2300
2301
2302       </a>
2303     </li>
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313     <li class="md-nav__item">
2314       <a href="../../../package/pip/sql/" class="md-nav__link">
2315
2316
2317   <span class="md-ellipsis">
2318     sql
2319   </span>
2320
2321
2322       </a>
2323     </li>
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333     <li class="md-nav__item">
2334       <a href="../../../package/pip/style/" class="md-nav__link">
2335
2336
2337   <span class="md-ellipsis">
2338     style
2339   </span>
2340
2341
2342       </a>
2343     </li>
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353     <li class="md-nav__item">
2354       <a href="../../../package/pip/template/" class="md-nav__link">
2355
2356
2357   <span class="md-ellipsis">
2358     template
2359   </span>
2360
2361
2362       </a>
2363     </li>
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373     <li class="md-nav__item">
2374       <a href="../../../package/pip/template-delete/" class="md-nav__link">
2375
2376
2377   <span class="md-ellipsis">
2378     templateDelete
2379   </span>
2380
2381
2382       </a>
2383     </li>
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393     <li class="md-nav__item">
2394       <a href="../../../package/pip/template-listener/" class="md-nav__link">
2395
2396
2397   <span class="md-ellipsis">
2398     templateListener
2399   </span>
2400
2401
2402       </a>
2403     </li>
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413     <li class="md-nav__item">
2414       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
2415
2416
2417   <span class="md-ellipsis">
2418     userGroupOption
2419   </span>
2420
2421
2422       </a>
2423     </li>
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433     <li class="md-nav__item">
2434       <a href="../../../package/pip/user-menu/" class="md-nav__link">
2435
2436
2437   <span class="md-ellipsis">
2438     userMenu
2439   </span>
2440
2441
2442       </a>
2443     </li>
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453     <li class="md-nav__item">
2454       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
2455
2456
2457   <span class="md-ellipsis">
2458     userNotificationEvent
2459   </span>
2460
2461
2462       </a>
2463     </li>
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473     <li class="md-nav__item">
2474       <a href="../../../package/pip/user-option/" class="md-nav__link">
2475
2476
2477   <span class="md-ellipsis">
2478     userOption
2479   </span>
2480
2481
2482       </a>
2483     </li>
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493     <li class="md-nav__item">
2494       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
2495
2496
2497   <span class="md-ellipsis">
2498     userProfileMenu
2499   </span>
2500
2501
2502       </a>
2503     </li>
2504
2505
2506
2507
2508           </ul>
2509         </nav>
2510
2511     </li>
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521     <li class="md-nav__item">
2522       <a href="../../../package/database-php-api/" class="md-nav__link">
2523
2524
2525   <span class="md-ellipsis">
2526     Database PHP API
2527   </span>
2528
2529
2530       </a>
2531     </li>
2532
2533
2534
2535
2536           </ul>
2537         </nav>
2538
2539     </li>
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553     <li class="md-nav__item md-nav__item--nested">
2554
2555
2556
2557
2558         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2559
2560
2561           <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
2562
2563
2564   <span class="md-ellipsis">
2565     Migration
2566   </span>
2567
2568
2569             <span class="md-nav__icon md-icon"></span>
2570           </label>
2571
2572         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2573           <label class="md-nav__title" for="__nav_6">
2574             <span class="md-nav__icon md-icon"></span>
2575             Migration
2576           </label>
2577           <ul class="md-nav__list" data-md-scrollfix>
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589     <li class="md-nav__item md-nav__item--nested">
2590
2591
2592
2593
2594         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" >
2595
2596
2597           <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
2598
2599
2600   <span class="md-ellipsis">
2601     From WoltLab Suite 6.0
2602   </span>
2603
2604
2605             <span class="md-nav__icon md-icon"></span>
2606           </label>
2607
2608         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
2609           <label class="md-nav__title" for="__nav_6_1">
2610             <span class="md-nav__icon md-icon"></span>
2611             From WoltLab Suite 6.0
2612           </label>
2613           <ul class="md-nav__list" data-md-scrollfix>
2614
2615
2616
2617
2618
2619
2620     <li class="md-nav__item">
2621       <a href="../../../migration/wsc60/php/" class="md-nav__link">
2622
2623
2624   <span class="md-ellipsis">
2625     PHP API
2626   </span>
2627
2628
2629       </a>
2630     </li>
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640     <li class="md-nav__item">
2641       <a href="../../../migration/wsc60/templates/" class="md-nav__link">
2642
2643
2644   <span class="md-ellipsis">
2645     Templates
2646   </span>
2647
2648
2649       </a>
2650     </li>
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660     <li class="md-nav__item">
2661       <a href="../../../migration/wsc60/deprecations_removals/" class="md-nav__link">
2662
2663
2664   <span class="md-ellipsis">
2665     Deprecations and Removals
2666   </span>
2667
2668
2669       </a>
2670     </li>
2671
2672
2673
2674
2675           </ul>
2676         </nav>
2677
2678     </li>
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693     <li class="md-nav__item md-nav__item--nested">
2694
2695
2696
2697
2698         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
2699
2700
2701           <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
2702
2703
2704   <span class="md-ellipsis">
2705     From WoltLab Suite 5.5
2706   </span>
2707
2708
2709             <span class="md-nav__icon md-icon"></span>
2710           </label>
2711
2712         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
2713           <label class="md-nav__title" for="__nav_6_2">
2714             <span class="md-nav__icon md-icon"></span>
2715             From WoltLab Suite 5.5
2716           </label>
2717           <ul class="md-nav__list" data-md-scrollfix>
2718
2719
2720
2721
2722
2723
2724     <li class="md-nav__item">
2725       <a href="../../../migration/wsc55/php/" class="md-nav__link">
2726
2727
2728   <span class="md-ellipsis">
2729     PHP API
2730   </span>
2731
2732
2733       </a>
2734     </li>
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744     <li class="md-nav__item">
2745       <a href="../../../migration/wsc55/javascript/" class="md-nav__link">
2746
2747
2748   <span class="md-ellipsis">
2749     TypeScript and JavaScript
2750   </span>
2751
2752
2753       </a>
2754     </li>
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764     <li class="md-nav__item">
2765       <a href="../../../migration/wsc55/templates/" class="md-nav__link">
2766
2767
2768   <span class="md-ellipsis">
2769     Templates
2770   </span>
2771
2772
2773       </a>
2774     </li>
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784     <li class="md-nav__item">
2785       <a href="../../../migration/wsc55/icons/" class="md-nav__link">
2786
2787
2788   <span class="md-ellipsis">
2789     Icons
2790   </span>
2791
2792
2793       </a>
2794     </li>
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804     <li class="md-nav__item">
2805       <a href="../../../migration/wsc55/dialogs/" class="md-nav__link">
2806
2807
2808   <span class="md-ellipsis">
2809     Dialogs
2810   </span>
2811
2812
2813       </a>
2814     </li>
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824     <li class="md-nav__item">
2825       <a href="../../../migration/wsc55/libraries/" class="md-nav__link">
2826
2827
2828   <span class="md-ellipsis">
2829     Third Party Libraries
2830   </span>
2831
2832
2833       </a>
2834     </li>
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844     <li class="md-nav__item">
2845       <a href="../../../migration/wsc55/deprecations_removals/" class="md-nav__link">
2846
2847
2848   <span class="md-ellipsis">
2849     Deprecations and Removals
2850   </span>
2851
2852
2853       </a>
2854     </li>
2855
2856
2857
2858
2859           </ul>
2860         </nav>
2861
2862     </li>
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877     <li class="md-nav__item md-nav__item--nested">
2878
2879
2880
2881
2882         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
2883
2884
2885           <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
2886
2887
2888   <span class="md-ellipsis">
2889     From WoltLab Suite 5.4
2890   </span>
2891
2892
2893             <span class="md-nav__icon md-icon"></span>
2894           </label>
2895
2896         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
2897           <label class="md-nav__title" for="__nav_6_3">
2898             <span class="md-nav__icon md-icon"></span>
2899             From WoltLab Suite 5.4
2900           </label>
2901           <ul class="md-nav__list" data-md-scrollfix>
2902
2903
2904
2905
2906
2907
2908     <li class="md-nav__item">
2909       <a href="../../../migration/wsc54/php/" class="md-nav__link">
2910
2911
2912   <span class="md-ellipsis">
2913     PHP API
2914   </span>
2915
2916
2917       </a>
2918     </li>
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928     <li class="md-nav__item">
2929       <a href="../../../migration/wsc54/javascript/" class="md-nav__link">
2930
2931
2932   <span class="md-ellipsis">
2933     TypeScript and JavaScript
2934   </span>
2935
2936
2937       </a>
2938     </li>
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948     <li class="md-nav__item">
2949       <a href="../../../migration/wsc54/templates/" class="md-nav__link">
2950
2951
2952   <span class="md-ellipsis">
2953     Templates
2954   </span>
2955
2956
2957       </a>
2958     </li>
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968     <li class="md-nav__item">
2969       <a href="../../../migration/wsc54/libraries/" class="md-nav__link">
2970
2971
2972   <span class="md-ellipsis">
2973     Third Party Libraries
2974   </span>
2975
2976
2977       </a>
2978     </li>
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988     <li class="md-nav__item">
2989       <a href="../../../migration/wsc54/deprecations_removals/" class="md-nav__link">
2990
2991
2992   <span class="md-ellipsis">
2993     Deprecations and Removals
2994   </span>
2995
2996
2997       </a>
2998     </li>
2999
3000
3001
3002
3003           </ul>
3004         </nav>
3005
3006     </li>
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021     <li class="md-nav__item md-nav__item--nested">
3022
3023
3024
3025
3026         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
3027
3028
3029           <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
3030
3031
3032   <span class="md-ellipsis">
3033     From WoltLab Suite 5.3
3034   </span>
3035
3036
3037             <span class="md-nav__icon md-icon"></span>
3038           </label>
3039
3040         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
3041           <label class="md-nav__title" for="__nav_6_4">
3042             <span class="md-nav__icon md-icon"></span>
3043             From WoltLab Suite 5.3
3044           </label>
3045           <ul class="md-nav__list" data-md-scrollfix>
3046
3047
3048
3049
3050
3051
3052     <li class="md-nav__item">
3053       <a href="../../../migration/wsc53/php/" class="md-nav__link">
3054
3055
3056   <span class="md-ellipsis">
3057     PHP API
3058   </span>
3059
3060
3061       </a>
3062     </li>
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072     <li class="md-nav__item">
3073       <a href="../../../migration/wsc53/session/" class="md-nav__link">
3074
3075
3076   <span class="md-ellipsis">
3077     Session Handling and Authentication
3078   </span>
3079
3080
3081       </a>
3082     </li>
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092     <li class="md-nav__item">
3093       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
3094
3095
3096   <span class="md-ellipsis">
3097     TypeScript and JavaScript
3098   </span>
3099
3100
3101       </a>
3102     </li>
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112     <li class="md-nav__item">
3113       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
3114
3115
3116   <span class="md-ellipsis">
3117     Templates
3118   </span>
3119
3120
3121       </a>
3122     </li>
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132     <li class="md-nav__item">
3133       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
3134
3135
3136   <span class="md-ellipsis">
3137     Third Party Libraries
3138   </span>
3139
3140
3141       </a>
3142     </li>
3143
3144
3145
3146
3147           </ul>
3148         </nav>
3149
3150     </li>
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165     <li class="md-nav__item md-nav__item--nested">
3166
3167
3168
3169
3170         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
3171
3172
3173           <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
3174
3175
3176   <span class="md-ellipsis">
3177     From WoltLab Suite 5.2
3178   </span>
3179
3180
3181             <span class="md-nav__icon md-icon"></span>
3182           </label>
3183
3184         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
3185           <label class="md-nav__title" for="__nav_6_5">
3186             <span class="md-nav__icon md-icon"></span>
3187             From WoltLab Suite 5.2
3188           </label>
3189           <ul class="md-nav__list" data-md-scrollfix>
3190
3191
3192
3193
3194
3195
3196     <li class="md-nav__item">
3197       <a href="../../../migration/wsc52/php/" class="md-nav__link">
3198
3199
3200   <span class="md-ellipsis">
3201     PHP API
3202   </span>
3203
3204
3205       </a>
3206     </li>
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216     <li class="md-nav__item">
3217       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
3218
3219
3220   <span class="md-ellipsis">
3221     Templates and Languages
3222   </span>
3223
3224
3225       </a>
3226     </li>
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236     <li class="md-nav__item">
3237       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
3238
3239
3240   <span class="md-ellipsis">
3241     Third Party Libraries
3242   </span>
3243
3244
3245       </a>
3246     </li>
3247
3248
3249
3250
3251           </ul>
3252         </nav>
3253
3254     </li>
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269     <li class="md-nav__item md-nav__item--nested">
3270
3271
3272
3273
3274         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
3275
3276
3277           <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
3278
3279
3280   <span class="md-ellipsis">
3281     From WoltLab Suite 3.1
3282   </span>
3283
3284
3285             <span class="md-nav__icon md-icon"></span>
3286           </label>
3287
3288         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
3289           <label class="md-nav__title" for="__nav_6_6">
3290             <span class="md-nav__icon md-icon"></span>
3291             From WoltLab Suite 3.1
3292           </label>
3293           <ul class="md-nav__list" data-md-scrollfix>
3294
3295
3296
3297
3298
3299
3300     <li class="md-nav__item">
3301       <a href="../../../migration/wsc31/php/" class="md-nav__link">
3302
3303
3304   <span class="md-ellipsis">
3305     PHP API
3306   </span>
3307
3308
3309       </a>
3310     </li>
3311
3312
3313
3314
3315           </ul>
3316         </nav>
3317
3318     </li>
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333     <li class="md-nav__item md-nav__item--nested">
3334
3335
3336
3337
3338         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
3339
3340
3341           <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
3342
3343
3344   <span class="md-ellipsis">
3345     From WoltLab Suite 3.0
3346   </span>
3347
3348
3349             <span class="md-nav__icon md-icon"></span>
3350           </label>
3351
3352         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
3353           <label class="md-nav__title" for="__nav_6_7">
3354             <span class="md-nav__icon md-icon"></span>
3355             From WoltLab Suite 3.0
3356           </label>
3357           <ul class="md-nav__list" data-md-scrollfix>
3358
3359
3360
3361
3362
3363
3364     <li class="md-nav__item">
3365       <a href="../../../migration/wsc30/php/" class="md-nav__link">
3366
3367
3368   <span class="md-ellipsis">
3369     PHP API
3370   </span>
3371
3372
3373       </a>
3374     </li>
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384     <li class="md-nav__item">
3385       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
3386
3387
3388   <span class="md-ellipsis">
3389     JavaScript API
3390   </span>
3391
3392
3393       </a>
3394     </li>
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404     <li class="md-nav__item">
3405       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
3406
3407
3408   <span class="md-ellipsis">
3409     Templates
3410   </span>
3411
3412
3413       </a>
3414     </li>
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424     <li class="md-nav__item">
3425       <a href="../../../migration/wsc30/css/" class="md-nav__link">
3426
3427
3428   <span class="md-ellipsis">
3429     CSS
3430   </span>
3431
3432
3433       </a>
3434     </li>
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444     <li class="md-nav__item">
3445       <a href="../../../migration/wsc30/package/" class="md-nav__link">
3446
3447
3448   <span class="md-ellipsis">
3449     Package Components
3450   </span>
3451
3452
3453       </a>
3454     </li>
3455
3456
3457
3458
3459           </ul>
3460         </nav>
3461
3462     </li>
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477     <li class="md-nav__item md-nav__item--nested">
3478
3479
3480
3481
3482         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_8" >
3483
3484
3485           <label class="md-nav__link" for="__nav_6_8" id="__nav_6_8_label" tabindex="0">
3486
3487
3488   <span class="md-ellipsis">
3489     From WCF 2.1
3490   </span>
3491
3492
3493             <span class="md-nav__icon md-icon"></span>
3494           </label>
3495
3496         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_8_label" aria-expanded="false">
3497           <label class="md-nav__title" for="__nav_6_8">
3498             <span class="md-nav__icon md-icon"></span>
3499             From WCF 2.1
3500           </label>
3501           <ul class="md-nav__list" data-md-scrollfix>
3502
3503
3504
3505
3506
3507
3508     <li class="md-nav__item">
3509       <a href="../../../migration/wcf21/php/" class="md-nav__link">
3510
3511
3512   <span class="md-ellipsis">
3513     PHP API
3514   </span>
3515
3516
3517       </a>
3518     </li>
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528     <li class="md-nav__item">
3529       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
3530
3531
3532   <span class="md-ellipsis">
3533     Templates
3534   </span>
3535
3536
3537       </a>
3538     </li>
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548     <li class="md-nav__item">
3549       <a href="../../../migration/wcf21/css/" class="md-nav__link">
3550
3551
3552   <span class="md-ellipsis">
3553     CSS
3554   </span>
3555
3556
3557       </a>
3558     </li>
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568     <li class="md-nav__item">
3569       <a href="../../../migration/wcf21/package/" class="md-nav__link">
3570
3571
3572   <span class="md-ellipsis">
3573     Package Components
3574   </span>
3575
3576
3577       </a>
3578     </li>
3579
3580
3581
3582
3583           </ul>
3584         </nav>
3585
3586     </li>
3587
3588
3589
3590
3591           </ul>
3592         </nav>
3593
3594     </li>
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608     <li class="md-nav__item md-nav__item--nested">
3609
3610
3611
3612
3613         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
3614
3615
3616           <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
3617
3618
3619   <span class="md-ellipsis">
3620     Tutorials
3621   </span>
3622
3623
3624             <span class="md-nav__icon md-icon"></span>
3625           </label>
3626
3627         <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
3628           <label class="md-nav__title" for="__nav_7">
3629             <span class="md-nav__icon md-icon"></span>
3630             Tutorials
3631           </label>
3632           <ul class="md-nav__list" data-md-scrollfix>
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644     <li class="md-nav__item md-nav__item--nested">
3645
3646
3647
3648
3649         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
3650
3651
3652           <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
3653
3654
3655   <span class="md-ellipsis">
3656     Tutorial Series
3657   </span>
3658
3659
3660             <span class="md-nav__icon md-icon"></span>
3661           </label>
3662
3663         <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
3664           <label class="md-nav__title" for="__nav_7_1">
3665             <span class="md-nav__icon md-icon"></span>
3666             Tutorial Series
3667           </label>
3668           <ul class="md-nav__list" data-md-scrollfix>
3669
3670
3671
3672
3673
3674
3675     <li class="md-nav__item">
3676       <a href="../../../tutorial/series/overview/" class="md-nav__link">
3677
3678
3679   <span class="md-ellipsis">
3680     Overview
3681   </span>
3682
3683
3684       </a>
3685     </li>
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695     <li class="md-nav__item">
3696       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
3697
3698
3699   <span class="md-ellipsis">
3700     Part 1
3701   </span>
3702
3703
3704       </a>
3705     </li>
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715     <li class="md-nav__item">
3716       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
3717
3718
3719   <span class="md-ellipsis">
3720     Part 2
3721   </span>
3722
3723
3724       </a>
3725     </li>
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735     <li class="md-nav__item">
3736       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
3737
3738
3739   <span class="md-ellipsis">
3740     Part 3
3741   </span>
3742
3743
3744       </a>
3745     </li>
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755     <li class="md-nav__item">
3756       <a href="../../../tutorial/series/part_4/" class="md-nav__link">
3757
3758
3759   <span class="md-ellipsis">
3760     Part 4
3761   </span>
3762
3763
3764       </a>
3765     </li>
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775     <li class="md-nav__item">
3776       <a href="../../../tutorial/series/part_5/" class="md-nav__link">
3777
3778
3779   <span class="md-ellipsis">
3780     Part 5
3781   </span>
3782
3783
3784       </a>
3785     </li>
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795     <li class="md-nav__item">
3796       <a href="../../../tutorial/series/part_6/" class="md-nav__link">
3797
3798
3799   <span class="md-ellipsis">
3800     Part 6
3801   </span>
3802
3803
3804       </a>
3805     </li>
3806
3807
3808
3809
3810           </ul>
3811         </nav>
3812
3813     </li>
3814
3815
3816
3817
3818           </ul>
3819         </nav>
3820
3821     </li>
3822
3823
3824
3825   </ul>
3826 </nav>
3827                   </div>
3828                 </div>
3829               </div>
3830
3831
3832
3833               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
3834                 <div class="md-sidebar__scrollwrap">
3835                   <div class="md-sidebar__inner">
3836
3837
3838 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
3839
3840
3841
3842
3843
3844
3845     <label class="md-nav__title" for="__toc">
3846       <span class="md-nav__icon md-icon"></span>
3847       Table of contents
3848     </label>
3849     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
3850
3851         <li class="md-nav__item">
3852   <a href="#abstractpackageinstallationplugin" class="md-nav__link">
3853     AbstractPackageInstallationPlugin
3854   </a>
3855
3856     <nav class="md-nav" aria-label="AbstractPackageInstallationPlugin">
3857       <ul class="md-nav__list">
3858
3859           <li class="md-nav__item">
3860   <a href="#class-members" class="md-nav__link">
3861     Class Members
3862   </a>
3863
3864     <nav class="md-nav" aria-label="Class Members">
3865       <ul class="md-nav__list">
3866
3867           <li class="md-nav__item">
3868   <a href="#installation" class="md-nav__link">
3869     $installation
3870   </a>
3871
3872 </li>
3873
3874           <li class="md-nav__item">
3875   <a href="#application" class="md-nav__link">
3876     $application
3877   </a>
3878
3879 </li>
3880
3881       </ul>
3882     </nav>
3883
3884 </li>
3885
3886       </ul>
3887     </nav>
3888
3889 </li>
3890
3891         <li class="md-nav__item">
3892   <a href="#abstractxmlpackageinstallationplugin" class="md-nav__link">
3893     AbstractXMLPackageInstallationPlugin
3894   </a>
3895
3896     <nav class="md-nav" aria-label="AbstractXMLPackageInstallationPlugin">
3897       <ul class="md-nav__list">
3898
3899           <li class="md-nav__item">
3900   <a href="#class-members_1" class="md-nav__link">
3901     Class Members
3902   </a>
3903
3904     <nav class="md-nav" aria-label="Class Members">
3905       <ul class="md-nav__list">
3906
3907           <li class="md-nav__item">
3908   <a href="#classname" class="md-nav__link">
3909     $className
3910   </a>
3911
3912 </li>
3913
3914           <li class="md-nav__item">
3915   <a href="#tagname" class="md-nav__link">
3916     $tagName
3917   </a>
3918
3919 </li>
3920
3921           <li class="md-nav__item">
3922   <a href="#prepareimportarray-data" class="md-nav__link">
3923     prepareImport(array $data)
3924   </a>
3925
3926 </li>
3927
3928           <li class="md-nav__item">
3929   <a href="#validateimportarray-data" class="md-nav__link">
3930     validateImport(array $data)
3931   </a>
3932
3933 </li>
3934
3935           <li class="md-nav__item">
3936   <a href="#findexistingitemarray-data" class="md-nav__link">
3937     findExistingItem(array $data)
3938   </a>
3939
3940 </li>
3941
3942           <li class="md-nav__item">
3943   <a href="#example" class="md-nav__link">
3944     Example
3945   </a>
3946
3947 </li>
3948
3949           <li class="md-nav__item">
3950   <a href="#handledeletearray-items" class="md-nav__link">
3951     handleDelete(array $items)
3952   </a>
3953
3954 </li>
3955
3956           <li class="md-nav__item">
3957   <a href="#postimport" class="md-nav__link">
3958     postImport()
3959   </a>
3960
3961 </li>
3962
3963       </ul>
3964     </nav>
3965
3966 </li>
3967
3968       </ul>
3969     </nav>
3970
3971 </li>
3972
3973         <li class="md-nav__item">
3974   <a href="#abstractoptionpackageinstallationplugin" class="md-nav__link">
3975     AbstractOptionPackageInstallationPlugin
3976   </a>
3977
3978     <nav class="md-nav" aria-label="AbstractOptionPackageInstallationPlugin">
3979       <ul class="md-nav__list">
3980
3981           <li class="md-nav__item">
3982   <a href="#differences-to-abstractxmlpackageinstallationplugin" class="md-nav__link">
3983     Differences to AbstractXMLPackageInstallationPlugin
3984   </a>
3985
3986     <nav class="md-nav" aria-label="Differences to AbstractXMLPackageInstallationPlugin">
3987       <ul class="md-nav__list">
3988
3989           <li class="md-nav__item">
3990   <a href="#reservedtags" class="md-nav__link">
3991     $reservedTags
3992   </a>
3993
3994 </li>
3995
3996       </ul>
3997     </nav>
3998
3999 </li>
4000
4001       </ul>
4002     </nav>
4003
4004 </li>
4005
4006     </ul>
4007
4008 </nav>
4009                   </div>
4010                 </div>
4011               </div>
4012
4013
4014
4015             <div class="md-content" data-md-component="content">
4016               <article class="md-content__inner md-typeset">
4017
4018
4019
4020
4021
4022
4023
4024 <h1 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h1>
4025 <p>A package installation plugin (PIP) defines the behavior to handle a specific <a href="../../../package/package-xml/#instruction">instruction</a> during package installation, update or uninstallation.</p>
4026 <h2 id="abstractpackageinstallationplugin"><code>AbstractPackageInstallationPlugin</code><a class="headerlink" href="#abstractpackageinstallationplugin" title="Permanent link">#</a></h2>
4027 <p>Any package installation plugin has to implement the <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/IPackageInstallationPlugin.class.php">IPackageInstallationPlugin</a> interface.
4028 It is recommended however, to extend the abstract implementation <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractPackageInstallationPlugin.class.php">AbstractPackageInstallationPlugin</a> of this interface instead of directly implementing the interface.
4029 The abstract implementation will always provide sane methods in case of any API changes.</p>
4030 <h3 id="class-members">Class Members<a class="headerlink" href="#class-members" title="Permanent link">#</a></h3>
4031 <p>Package Installation Plugins have a few notable class members easing your work:</p>
4032 <h4 id="installation"><code>$installation</code><a class="headerlink" href="#installation" title="Permanent link">#</a></h4>
4033 <p>This member contains an instance of <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php">PackageInstallationDispatcher</a> which provides you with all meta data related to the current package being processed.
4034 The most common usage is the retrieval of the package ID via <code>$this-&gt;installation-&gt;getPackageID()</code>.</p>
4035 <h4 id="application"><code>$application</code><a class="headerlink" href="#application" title="Permanent link">#</a></h4>
4036 <p>Represents the abbreviation of the target application, e.g. <code>wbb</code> (default value: <code>wcf</code>), used for the name of database table in which the installed data is stored.</p>
4037 <h2 id="abstractxmlpackageinstallationplugin"><code>AbstractXMLPackageInstallationPlugin</code><a class="headerlink" href="#abstractxmlpackageinstallationplugin" title="Permanent link">#</a></h2>
4038 <p><a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractPackageInstallationPlugin.class.php">AbstractPackageInstallationPlugin</a> is the default implementation for all package installation plugins based upon a single XML document.
4039 It handles the evaluation of the document and provide you an object-orientated approach to handle its data.</p>
4040 <h3 id="class-members_1">Class Members<a class="headerlink" href="#class-members_1" title="Permanent link">#</a></h3>
4041 <h4 id="classname"><code>$className</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h4>
4042 <p>Value must be the qualified name of a class deriving from <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/data/DatabaseObjectEditor.class.php">DatabaseObjectEditor</a> which is used to create and update objects.</p>
4043 <h4 id="tagname"><code>$tagName</code><a class="headerlink" href="#tagname" title="Permanent link">#</a></h4>
4044 <p>Specifies the tag name within a <code>&lt;import&gt;</code> or <code>&lt;delete&gt;</code> section of the XML document used for each installed object.</p>
4045 <h4 id="prepareimportarray-data"><code>prepareImport(array $data)</code><a class="headerlink" href="#prepareimportarray-data" title="Permanent link">#</a></h4>
4046 <p>The passed array <code>$data</code> contains the parsed value from each evaluated tag in the <code>&lt;import&gt;</code> section:</p>
4047 <ul>
4048 <li><code>$data['elements']</code> contains a list of tag names and their value.</li>
4049 <li><code>$data['attributes']</code> contains a list of attributes present on the tag identified by <a href="#tagname">$tagName</a>.</li>
4050 </ul>
4051 <p>This method should return an one-dimensional array, where each key maps to the corresponding database column name (key names are case-sensitive).
4052 It will be passed to either <code>DatabaseObjectEditor::create()</code> or <code>DatabaseObjectEditor::update()</code>.</p>
4053 <p>Example:</p>
4054 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
4055 <span class="normal">2</span>
4056 <span class="normal">3</span>
4057 <span class="normal">4</span>
4058 <span class="normal">5</span>
4059 <span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
4060 <span class="k">return</span> <span class="p">[</span>
4061     <span class="s1">&#39;environment&#39;</span> <span class="o">=&gt;</span> <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;elements&#39;</span><span class="p">][</span><span class="s1">&#39;environment&#39;</span><span class="p">],</span>
4062     <span class="s1">&#39;eventName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;elements&#39;</span><span class="p">][</span><span class="s1">&#39;eventname&#39;</span><span class="p">],</span>
4063     <span class="s1">&#39;name&#39;</span> <span class="o">=&gt;</span> <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;attributes&#39;</span><span class="p">][</span><span class="s1">&#39;name&#39;</span><span class="p">]</span>
4064 <span class="p">];</span>
4065 </code></pre></div></td></tr></table></div>
4066 <h4 id="validateimportarray-data"><code>validateImport(array $data)</code><a class="headerlink" href="#validateimportarray-data" title="Permanent link">#</a></h4>
4067 <p>The passed array <code>$data</code> equals the data returned by <a href="#prepareimportarray-data">prepareImport()</a>.
4068 This method has no return value, instead you should throw an exception if the passed data is invalid.</p>
4069 <h4 id="findexistingitemarray-data"><code>findExistingItem(array $data)</code><a class="headerlink" href="#findexistingitemarray-data" title="Permanent link">#</a></h4>
4070 <p>The passed array <code>$data</code> equals the data returned by <a href="#prepareimportarray-data">prepareImport()</a>.
4071 This method is expected to return an array with two keys:</p>
4072 <ul>
4073 <li><code>sql</code> contains the SQL query with placeholders.</li>
4074 <li><code>parameters</code> contains an array with values used for the SQL query.</li>
4075 </ul>
4076 <h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h4>
4077 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4078 <span class="normal"> 2</span>
4079 <span class="normal"> 3</span>
4080 <span class="normal"> 4</span>
4081 <span class="normal"> 5</span>
4082 <span class="normal"> 6</span>
4083 <span class="normal"> 7</span>
4084 <span class="normal"> 8</span>
4085 <span class="normal"> 9</span>
4086 <span class="normal">10</span>
4087 <span class="normal">11</span>
4088 <span class="normal">12</span>
4089 <span class="normal">13</span>
4090 <span class="normal">14</span>
4091 <span class="normal">15</span>
4092 <span class="normal">16</span>
4093 <span class="normal">17</span>
4094 <span class="normal">18</span>
4095 <span class="normal">19</span>
4096 <span class="normal">20</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
4097 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT  *</span>
4098 <span class="s2">    FROM    wcf&quot;</span><span class="o">.</span><span class="nx">WCF_N</span><span class="o">.</span><span class="s2">&quot;_&quot;</span><span class="o">.</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">tableName</span><span class="o">.</span><span class="s2">&quot;</span>
4099 <span class="s2">    WHERE   packageID = ?</span>
4100 <span class="s2">        AND name = ?</span>
4101 <span class="s2">        AND templateName = ?</span>
4102 <span class="s2">        AND eventName = ?</span>
4103 <span class="s2">        AND environment = ?&quot;</span><span class="p">;</span>
4104 <span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span>
4105     <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">installation</span><span class="o">-&gt;</span><span class="na">getPackageID</span><span class="p">(),</span>
4106     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
4107     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;templateName&#39;</span><span class="p">],</span>
4108     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;eventName&#39;</span><span class="p">],</span>
4109     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;environment&#39;</span><span class="p">]</span>
4110 <span class="p">];</span>
4111
4112 <span class="k">return</span> <span class="p">[</span>
4113     <span class="s1">&#39;sql&#39;</span> <span class="o">=&gt;</span> <span class="nv">$sql</span><span class="p">,</span>
4114     <span class="s1">&#39;parameters&#39;</span> <span class="o">=&gt;</span> <span class="nv">$parameters</span>
4115 <span class="p">];</span>
4116 </code></pre></div></td></tr></table></div>
4117 <h4 id="handledeletearray-items"><code>handleDelete(array $items)</code><a class="headerlink" href="#handledeletearray-items" title="Permanent link">#</a></h4>
4118 <p>The passed array <code>$items</code> contains the original node data, similar to <a href="#prepareimportarray-data">prepareImport()</a>.
4119 You should make use of this data to remove the matching element from database.</p>
4120 <p>Example:
4121 <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
4122 <span class="normal"> 2</span>
4123 <span class="normal"> 3</span>
4124 <span class="normal"> 4</span>
4125 <span class="normal"> 5</span>
4126 <span class="normal"> 6</span>
4127 <span class="normal"> 7</span>
4128 <span class="normal"> 8</span>
4129 <span class="normal"> 9</span>
4130 <span class="normal">10</span>
4131 <span class="normal">11</span>
4132 <span class="normal">12</span>
4133 <span class="normal">13</span>
4134 <span class="normal">14</span>
4135 <span class="normal">15</span>
4136 <span class="normal">16</span>
4137 <span class="normal">17</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
4138 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;DELETE FROM wcf1_</span><span class="si">{</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">tableName</span><span class="si">}</span>
4139 <span class="s2">    WHERE       packageID = ?</span>
4140 <span class="s2">            AND environment = ?</span>
4141 <span class="s2">            AND eventName = ?</span>
4142 <span class="s2">            AND name = ?</span>
4143 <span class="s2">            AND templateName = ?&quot;</span><span class="p">;</span>
4144 <span class="nv">$statement</span> <span class="o">=</span> <span class="nx">WCF</span><span class="o">::</span><span class="na">getDB</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">prepare</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
4145 <span class="k">foreach</span> <span class="p">(</span><span class="nv">$items</span> <span class="k">as</span> <span class="nv">$item</span><span class="p">)</span> <span class="p">{</span>
4146     <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span>
4147         <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">installation</span><span class="o">-&gt;</span><span class="na">getPackageID</span><span class="p">(),</span>
4148         <span class="nv">$item</span><span class="p">[</span><span class="s1">&#39;elements&#39;</span><span class="p">][</span><span class="s1">&#39;environment&#39;</span><span class="p">],</span>
4149         <span class="nv">$item</span><span class="p">[</span><span class="s1">&#39;elements&#39;</span><span class="p">][</span><span class="s1">&#39;eventname&#39;</span><span class="p">],</span>
4150         <span class="nv">$item</span><span class="p">[</span><span class="s1">&#39;attributes&#39;</span><span class="p">][</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
4151         <span class="nv">$item</span><span class="p">[</span><span class="s1">&#39;elements&#39;</span><span class="p">][</span><span class="s1">&#39;templatename&#39;</span><span class="p">]</span>
4152     <span class="p">]);</span>
4153 <span class="p">}</span>
4154 </code></pre></div></td></tr></table></div></p>
4155 <h4 id="postimport"><code>postImport()</code><a class="headerlink" href="#postimport" title="Permanent link">#</a></h4>
4156 <p>Allows you to (optionally) run additionally actions after all elements were processed.</p>
4157 <h2 id="abstractoptionpackageinstallationplugin"><code>AbstractOptionPackageInstallationPlugin</code><a class="headerlink" href="#abstractoptionpackageinstallationplugin" title="Permanent link">#</a></h2>
4158 <p><a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractOptionPackageInstallationPlugin.class.php">AbstractOptionPackageInstallationPlugin</a> is an abstract implementation for options, used for:</p>
4159 <ul>
4160 <li>ACL Options</li>
4161 <li>Options</li>
4162 <li>User Options</li>
4163 <li>User Group Options</li>
4164 </ul>
4165 <h3 id="differences-to-abstractxmlpackageinstallationplugin">Differences to <code>AbstractXMLPackageInstallationPlugin</code><a class="headerlink" href="#differences-to-abstractxmlpackageinstallationplugin" title="Permanent link">#</a></h3>
4166 <h4 id="reservedtags"><code>$reservedTags</code><a class="headerlink" href="#reservedtags" title="Permanent link">#</a></h4>
4167 <p><code>$reservedTags</code> is a list of reserved tag names so that any tag encountered but not listed here will be added to the database column <code>additionalData</code>.
4168 This allows options to store arbitrary data which can be accessed but were not initially part of the PIP specifications.</p>
4169
4170   <hr>
4171 <div class="md-source-file">
4172   <small>
4173
4174       Last update:
4175       2023-01-26
4176
4177   </small>
4178 </div>
4179
4180
4181
4182
4183
4184
4185               </article>
4186             </div>
4187
4188
4189         </div>
4190
4191       </main>
4192
4193         <footer class="md-footer">
4194
4195   <div class="md-footer-meta md-typeset">
4196     <div class="md-footer-meta__inner md-grid">
4197       <div class="md-copyright">
4198
4199     <div class="md-copyright__highlight">
4200       Copyright © 2020 WoltLab GmbH
4201     </div>
4202
4203
4204     Made with
4205     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
4206       Material for MkDocs
4207     </a>
4208
4209 </div>
4210
4211         <div class="md-copyright">
4212         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
4213         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
4214 </div>
4215
4216     </div>
4217   </div>
4218 </footer>
4219
4220     </div>
4221     <div class="md-dialog" data-md-component="dialog">
4222       <div class="md-dialog__inner md-typeset"></div>
4223     </div>
4224
4225     <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.a264c092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
4226
4227
4228       <script src="../../../assets/javascripts/bundle.726fbb30.min.js"></script>
4229
4230
4231   </body>
4232 </html>