5.4/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
  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>Package Installation Plugins - 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="#package-installation-plugins" 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               Package Installation Plugins
 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
 221
 222     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 223
 224
 225         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 226
 227       <label class="md-nav__link" for="__nav_2">
 228         PHP API
 229         <span class="md-nav__icon md-icon"></span>
 230       </label>
 231       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 232         <label class="md-nav__title" for="__nav_2">
 233           <span class="md-nav__icon md-icon"></span>
 234           PHP API
 235         </label>
 236         <ul class="md-nav__list" data-md-scrollfix>
 237
 238
 239
 240
 241
 242     <li class="md-nav__item">
 243       <a href="../../pages/" class="md-nav__link">
 244         Pages
 245       </a>
 246     </li>
 247
 248
 249
 250
 251
 252
 253
 254     <li class="md-nav__item">
 255       <a href="../../database-objects/" class="md-nav__link">
 256         Database Objects
 257       </a>
 258     </li>
 259
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item">
 267       <a href="../../database-access/" class="md-nav__link">
 268         Database Access
 269       </a>
 270     </li>
 271
 272
 273
 274
 275
 276
 277
 278     <li class="md-nav__item">
 279       <a href="../../exceptions/" class="md-nav__link">
 280         Exceptions
 281       </a>
 282     </li>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 294
 295
 296         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" checked>
 297
 298       <label class="md-nav__link" for="__nav_2_5">
 299         API
 300         <span class="md-nav__icon md-icon"></span>
 301       </label>
 302       <nav class="md-nav" aria-label="API" data-md-level="2">
 303         <label class="md-nav__title" for="__nav_2_5">
 304           <span class="md-nav__icon md-icon"></span>
 305           API
 306         </label>
 307         <ul class="md-nav__list" data-md-scrollfix>
 308
 309
 310
 311
 312
 313     <li class="md-nav__item">
 314       <a href="../caches/" class="md-nav__link">
 315         Caches
 316       </a>
 317     </li>
 318
 319
 320
 321
 322
 323
 324
 325     <li class="md-nav__item">
 326       <a href="../comments/" class="md-nav__link">
 327         Comments
 328       </a>
 329     </li>
 330
 331
 332
 333
 334
 335
 336
 337     <li class="md-nav__item">
 338       <a href="../cronjobs/" class="md-nav__link">
 339         Cronjobs
 340       </a>
 341     </li>
 342
 343
 344
 345
 346
 347
 348
 349     <li class="md-nav__item">
 350       <a href="../events/" class="md-nav__link">
 351         Events
 352       </a>
 353     </li>
 354
 355
 356
 357
 358
 359
 360
 361
 362     <li class="md-nav__item md-nav__item--nested">
 363
 364
 365         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 366
 367       <label class="md-nav__link" for="__nav_2_5_5">
 368         Form Builder
 369         <span class="md-nav__icon md-icon"></span>
 370       </label>
 371       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 372         <label class="md-nav__title" for="__nav_2_5_5">
 373           <span class="md-nav__icon md-icon"></span>
 374           Form Builder
 375         </label>
 376         <ul class="md-nav__list" data-md-scrollfix>
 377
 378
 379
 380
 381
 382     <li class="md-nav__item">
 383       <a href="../form_builder/overview/" class="md-nav__link">
 384         Overview
 385       </a>
 386     </li>
 387
 388
 389
 390
 391
 392
 393
 394     <li class="md-nav__item">
 395       <a href="../form_builder/structure/" class="md-nav__link">
 396         Structure
 397       </a>
 398     </li>
 399
 400
 401
 402
 403
 404
 405
 406     <li class="md-nav__item">
 407       <a href="../form_builder/form_fields/" class="md-nav__link">
 408         Fields
 409       </a>
 410     </li>
 411
 412
 413
 414
 415
 416
 417
 418     <li class="md-nav__item">
 419       <a href="../form_builder/validation_data/" class="md-nav__link">
 420         Validation and Data
 421       </a>
 422     </li>
 423
 424
 425
 426
 427
 428
 429
 430     <li class="md-nav__item">
 431       <a href="../form_builder/dependencies/" class="md-nav__link">
 432         Dependencies
 433       </a>
 434     </li>
 435
 436
 437
 438         </ul>
 439       </nav>
 440     </li>
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450     <li class="md-nav__item md-nav__item--active">
 451
 452       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 453
 454
 455
 456
 457         <label class="md-nav__link md-nav__link--active" for="__toc">
 458           Package Installation Plugins
 459           <span class="md-nav__icon md-icon"></span>
 460         </label>
 461
 462       <a href="./" class="md-nav__link md-nav__link--active">
 463         Package Installation Plugins
 464       </a>
 465
 466
 467 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 468
 469
 470
 471
 472
 473     <label class="md-nav__title" for="__toc">
 474       <span class="md-nav__icon md-icon"></span>
 475       Table of contents
 476     </label>
 477     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 478
 479         <li class="md-nav__item">
 480   <a href="#abstractpackageinstallationplugin" class="md-nav__link">
 481     AbstractPackageInstallationPlugin
 482   </a>
 483
 484     <nav class="md-nav" aria-label="AbstractPackageInstallationPlugin">
 485       <ul class="md-nav__list">
 486
 487           <li class="md-nav__item">
 488   <a href="#class-members" class="md-nav__link">
 489     Class Members
 490   </a>
 491
 492     <nav class="md-nav" aria-label="Class Members">
 493       <ul class="md-nav__list">
 494
 495           <li class="md-nav__item">
 496   <a href="#installation" class="md-nav__link">
 497     $installation
 498   </a>
 499
 500 </li>
 501
 502           <li class="md-nav__item">
 503   <a href="#application" class="md-nav__link">
 504     $application
 505   </a>
 506
 507 </li>
 508
 509       </ul>
 510     </nav>
 511
 512 </li>
 513
 514       </ul>
 515     </nav>
 516
 517 </li>
 518
 519         <li class="md-nav__item">
 520   <a href="#abstractxmlpackageinstallationplugin" class="md-nav__link">
 521     AbstractXMLPackageInstallationPlugin
 522   </a>
 523
 524     <nav class="md-nav" aria-label="AbstractXMLPackageInstallationPlugin">
 525       <ul class="md-nav__list">
 526
 527           <li class="md-nav__item">
 528   <a href="#class-members_1" class="md-nav__link">
 529     Class Members
 530   </a>
 531
 532     <nav class="md-nav" aria-label="Class Members">
 533       <ul class="md-nav__list">
 534
 535           <li class="md-nav__item">
 536   <a href="#classname" class="md-nav__link">
 537     $className
 538   </a>
 539
 540 </li>
 541
 542           <li class="md-nav__item">
 543   <a href="#tagname" class="md-nav__link">
 544     $tagName
 545   </a>
 546
 547 </li>
 548
 549           <li class="md-nav__item">
 550   <a href="#prepareimportarray-data" class="md-nav__link">
 551     prepareImport(array $data)
 552   </a>
 553
 554 </li>
 555
 556           <li class="md-nav__item">
 557   <a href="#validateimportarray-data" class="md-nav__link">
 558     validateImport(array $data)
 559   </a>
 560
 561 </li>
 562
 563           <li class="md-nav__item">
 564   <a href="#findexistingitemarray-data" class="md-nav__link">
 565     findExistingItem(array $data)
 566   </a>
 567
 568 </li>
 569
 570           <li class="md-nav__item">
 571   <a href="#253-example" class="md-nav__link">
 572     2.5.3. Example
 573   </a>
 574
 575 </li>
 576
 577           <li class="md-nav__item">
 578   <a href="#handledeletearray-items" class="md-nav__link">
 579     handleDelete(array $items)
 580   </a>
 581
 582 </li>
 583
 584           <li class="md-nav__item">
 585   <a href="#postimport" class="md-nav__link">
 586     postImport()
 587   </a>
 588
 589 </li>
 590
 591       </ul>
 592     </nav>
 593
 594 </li>
 595
 596       </ul>
 597     </nav>
 598
 599 </li>
 600
 601         <li class="md-nav__item">
 602   <a href="#abstractoptionpackageinstallationplugin" class="md-nav__link">
 603     AbstractOptionPackageInstallationPlugin
 604   </a>
 605
 606     <nav class="md-nav" aria-label="AbstractOptionPackageInstallationPlugin">
 607       <ul class="md-nav__list">
 608
 609           <li class="md-nav__item">
 610   <a href="#differences-to-abstractxmlpackageinstallationplugin" class="md-nav__link">
 611     Differences to AbstractXMLPackageInstallationPlugin
 612   </a>
 613
 614     <nav class="md-nav" aria-label="Differences to AbstractXMLPackageInstallationPlugin">
 615       <ul class="md-nav__list">
 616
 617           <li class="md-nav__item">
 618   <a href="#reservedtags" class="md-nav__link">
 619     $reservedTags
 620   </a>
 621
 622 </li>
 623
 624       </ul>
 625     </nav>
 626
 627 </li>
 628
 629       </ul>
 630     </nav>
 631
 632 </li>
 633
 634     </ul>
 635
 636 </nav>
 637
 638     </li>
 639
 640
 641
 642
 643
 644
 645
 646     <li class="md-nav__item">
 647       <a href="../user_activity_points/" class="md-nav__link">
 648         User Activity Points
 649       </a>
 650     </li>
 651
 652
 653
 654
 655
 656
 657
 658     <li class="md-nav__item">
 659       <a href="../user_notifications/" class="md-nav__link">
 660         User Notifications
 661       </a>
 662     </li>
 663
 664
 665
 666
 667
 668
 669
 670     <li class="md-nav__item">
 671       <a href="../sitemaps/" class="md-nav__link">
 672         Sitemaps
 673       </a>
 674     </li>
 675
 676
 677
 678         </ul>
 679       </nav>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688     <li class="md-nav__item">
 689       <a href="../../code-style/" class="md-nav__link">
 690         Code Style
 691       </a>
 692     </li>
 693
 694
 695
 696
 697
 698
 699
 700     <li class="md-nav__item">
 701       <a href="../../apps/" class="md-nav__link">
 702         Apps
 703       </a>
 704     </li>
 705
 706
 707
 708
 709
 710
 711
 712     <li class="md-nav__item">
 713       <a href="../../gdpr/" class="md-nav__link">
 714         GDPR
 715       </a>
 716     </li>
 717
 718
 719
 720         </ul>
 721       </nav>
 722     </li>
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734     <li class="md-nav__item md-nav__item--nested">
 735
 736
 737         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 738
 739       <label class="md-nav__link" for="__nav_3">
 740         Languages, Templates & CSS
 741         <span class="md-nav__icon md-icon"></span>
 742       </label>
 743       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 744         <label class="md-nav__title" for="__nav_3">
 745           <span class="md-nav__icon md-icon"></span>
 746           Languages, Templates & CSS
 747         </label>
 748         <ul class="md-nav__list" data-md-scrollfix>
 749
 750
 751
 752
 753
 754     <li class="md-nav__item">
 755       <a href="../../../view/languages/" class="md-nav__link">
 756         Languages
 757       </a>
 758     </li>
 759
 760
 761
 762
 763
 764
 765
 766     <li class="md-nav__item">
 767       <a href="../../../view/templates/" class="md-nav__link">
 768         Templates
 769       </a>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../../../view/css/" class="md-nav__link">
 780         CSS
 781       </a>
 782     </li>
 783
 784
 785
 786         </ul>
 787       </nav>
 788     </li>
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item md-nav__item--nested">
 801
 802
 803         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 804
 805       <label class="md-nav__link" for="__nav_4">
 806         TypeScript and JavaScript API
 807         <span class="md-nav__icon md-icon"></span>
 808       </label>
 809       <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
 810         <label class="md-nav__title" for="__nav_4">
 811           <span class="md-nav__icon md-icon"></span>
 812           TypeScript and JavaScript API
 813         </label>
 814         <ul class="md-nav__list" data-md-scrollfix>
 815
 816
 817
 818
 819
 820     <li class="md-nav__item">
 821       <a href="../../../javascript/general-usage/" class="md-nav__link">
 822         General Usage
 823       </a>
 824     </li>
 825
 826
 827
 828
 829
 830
 831
 832     <li class="md-nav__item">
 833       <a href="../../../javascript/typescript/" class="md-nav__link">
 834         TypeScript
 835       </a>
 836     </li>
 837
 838
 839
 840
 841
 842
 843
 844
 845     <li class="md-nav__item md-nav__item--nested">
 846
 847
 848         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
 849
 850       <label class="md-nav__link" for="__nav_4_3">
 851         New API
 852         <span class="md-nav__icon md-icon"></span>
 853       </label>
 854       <nav class="md-nav" aria-label="New API" data-md-level="2">
 855         <label class="md-nav__title" for="__nav_4_3">
 856           <span class="md-nav__icon md-icon"></span>
 857           New API
 858         </label>
 859         <ul class="md-nav__list" data-md-scrollfix>
 860
 861
 862
 863
 864
 865     <li class="md-nav__item">
 866       <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
 867         Writing a module
 868       </a>
 869     </li>
 870
 871
 872
 873
 874
 875
 876
 877     <li class="md-nav__item">
 878       <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
 879         Data Structures
 880       </a>
 881     </li>
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../../../javascript/new-api_core/" class="md-nav__link">
 891         Core Functions
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../../javascript/new-api_dom/" class="md-nav__link">
 903         DOM
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913     <li class="md-nav__item">
 914       <a href="../../../javascript/new-api_events/" class="md-nav__link">
 915         Event Handling
 916       </a>
 917     </li>
 918
 919
 920
 921
 922
 923
 924
 925     <li class="md-nav__item">
 926       <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
 927         Ajax
 928       </a>
 929     </li>
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item">
 938       <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
 939         Dialogs
 940       </a>
 941     </li>
 942
 943
 944
 945
 946
 947
 948
 949     <li class="md-nav__item">
 950       <a href="../../../javascript/new-api_browser/" class="md-nav__link">
 951         Browser and Screen Sizes
 952       </a>
 953     </li>
 954
 955
 956
 957
 958
 959
 960
 961     <li class="md-nav__item">
 962       <a href="../../../javascript/new-api_ui/" class="md-nav__link">
 963         User Interface
 964       </a>
 965     </li>
 966
 967
 968
 969         </ul>
 970       </nav>
 971     </li>
 972
 973
 974
 975
 976
 977
 978
 979     <li class="md-nav__item">
 980       <a href="../../../javascript/legacy-api/" class="md-nav__link">
 981         Legacy API
 982       </a>
 983     </li>
 984
 985
 986
 987
 988
 989
 990
 991     <li class="md-nav__item">
 992       <a href="../../../javascript/helper-functions/" class="md-nav__link">
 993         Helper Functions
 994       </a>
 995     </li>
 996
 997
 998
 999
1000
1001
1002
1003     <li class="md-nav__item">
1004       <a href="../../../javascript/code-snippets/" class="md-nav__link">
1005         Code Snippets
1006       </a>
1007     </li>
1008
1009
1010
1011         </ul>
1012       </nav>
1013     </li>
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025     <li class="md-nav__item md-nav__item--nested">
1026
1027
1028         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
1029
1030       <label class="md-nav__link" for="__nav_5">
1031         Package Components
1032         <span class="md-nav__icon md-icon"></span>
1033       </label>
1034       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
1035         <label class="md-nav__title" for="__nav_5">
1036           <span class="md-nav__icon md-icon"></span>
1037           Package Components
1038         </label>
1039         <ul class="md-nav__list" data-md-scrollfix>
1040
1041
1042
1043
1044
1045     <li class="md-nav__item">
1046       <a href="../../../package/package-xml/" class="md-nav__link">
1047         package.xml
1048       </a>
1049     </li>
1050
1051
1052
1053
1054
1055
1056
1057
1058     <li class="md-nav__item md-nav__item--nested">
1059
1060
1061         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1062
1063       <label class="md-nav__link" for="__nav_5_2">
1064         PIPs
1065         <span class="md-nav__icon md-icon"></span>
1066       </label>
1067       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1068         <label class="md-nav__title" for="__nav_5_2">
1069           <span class="md-nav__icon md-icon"></span>
1070           PIPs
1071         </label>
1072         <ul class="md-nav__list" data-md-scrollfix>
1073
1074
1075
1076
1077
1078     <li class="md-nav__item">
1079       <a href="../../../package/pip/" class="md-nav__link">
1080         Overview
1081       </a>
1082     </li>
1083
1084
1085
1086
1087
1088
1089
1090     <li class="md-nav__item">
1091       <a href="../../../package/pip/acl-option/" class="md-nav__link">
1092         aclOption
1093       </a>
1094     </li>
1095
1096
1097
1098
1099
1100
1101
1102     <li class="md-nav__item">
1103       <a href="../../../package/pip/acp-menu/" class="md-nav__link">
1104         acpMenu
1105       </a>
1106     </li>
1107
1108
1109
1110
1111
1112
1113
1114     <li class="md-nav__item">
1115       <a href="../../../package/pip/acp-search-provider/" class="md-nav__link">
1116         acpSearchProvider
1117       </a>
1118     </li>
1119
1120
1121
1122
1123
1124
1125
1126     <li class="md-nav__item">
1127       <a href="../../../package/pip/acp-template/" class="md-nav__link">
1128         acpTemplate
1129       </a>
1130     </li>
1131
1132
1133
1134
1135
1136
1137
1138     <li class="md-nav__item">
1139       <a href="../../../package/pip/bbcode/" class="md-nav__link">
1140         bbcode
1141       </a>
1142     </li>
1143
1144
1145
1146
1147
1148
1149
1150     <li class="md-nav__item">
1151       <a href="../../../package/pip/box/" class="md-nav__link">
1152         box
1153       </a>
1154     </li>
1155
1156
1157
1158
1159
1160
1161
1162     <li class="md-nav__item">
1163       <a href="../../../package/pip/clipboard-action/" class="md-nav__link">
1164         clipboardAction
1165       </a>
1166     </li>
1167
1168
1169
1170
1171
1172
1173
1174     <li class="md-nav__item">
1175       <a href="../../../package/pip/core-object/" class="md-nav__link">
1176         coreObject
1177       </a>
1178     </li>
1179
1180
1181
1182
1183
1184
1185
1186     <li class="md-nav__item">
1187       <a href="../../../package/pip/cronjob/" class="md-nav__link">
1188         cronjob
1189       </a>
1190     </li>
1191
1192
1193
1194
1195
1196
1197
1198     <li class="md-nav__item">
1199       <a href="../../../package/pip/event-listener/" class="md-nav__link">
1200         eventListener
1201       </a>
1202     </li>
1203
1204
1205
1206
1207
1208
1209
1210     <li class="md-nav__item">
1211       <a href="../../../package/pip/file/" class="md-nav__link">
1212         file
1213       </a>
1214     </li>
1215
1216
1217
1218
1219
1220
1221
1222     <li class="md-nav__item">
1223       <a href="../../../package/pip/language/" class="md-nav__link">
1224         language
1225       </a>
1226     </li>
1227
1228
1229
1230
1231
1232
1233
1234     <li class="md-nav__item">
1235       <a href="../../../package/pip/media-provider/" class="md-nav__link">
1236         mediaProvider
1237       </a>
1238     </li>
1239
1240
1241
1242
1243
1244
1245
1246     <li class="md-nav__item">
1247       <a href="../../../package/pip/menu/" class="md-nav__link">
1248         menu
1249       </a>
1250     </li>
1251
1252
1253
1254
1255
1256
1257
1258     <li class="md-nav__item">
1259       <a href="../../../package/pip/menu-item/" class="md-nav__link">
1260         menuItem
1261       </a>
1262     </li>
1263
1264
1265
1266
1267
1268
1269
1270     <li class="md-nav__item">
1271       <a href="../../../package/pip/object-type/" class="md-nav__link">
1272         objectType
1273       </a>
1274     </li>
1275
1276
1277
1278
1279
1280
1281
1282     <li class="md-nav__item">
1283       <a href="../../../package/pip/object-type-definition/" class="md-nav__link">
1284         objectTypeDefinition
1285       </a>
1286     </li>
1287
1288
1289
1290
1291
1292
1293
1294     <li class="md-nav__item">
1295       <a href="../../../package/pip/option/" class="md-nav__link">
1296         option
1297       </a>
1298     </li>
1299
1300
1301
1302
1303
1304
1305
1306     <li class="md-nav__item">
1307       <a href="../../../package/pip/page/" class="md-nav__link">
1308         page
1309       </a>
1310     </li>
1311
1312
1313
1314
1315
1316
1317
1318     <li class="md-nav__item">
1319       <a href="../../../package/pip/pip/" class="md-nav__link">
1320         pip
1321       </a>
1322     </li>
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../../../package/pip/script/" class="md-nav__link">
1332         script
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../../../package/pip/smiley/" class="md-nav__link">
1344         smiley
1345       </a>
1346     </li>
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../../package/pip/sql/" class="md-nav__link">
1356         sql
1357       </a>
1358     </li>
1359
1360
1361
1362
1363
1364
1365
1366     <li class="md-nav__item">
1367       <a href="../../../package/pip/style/" class="md-nav__link">
1368         style
1369       </a>
1370     </li>
1371
1372
1373
1374
1375
1376
1377
1378     <li class="md-nav__item">
1379       <a href="../../../package/pip/template/" class="md-nav__link">
1380         template
1381       </a>
1382     </li>
1383
1384
1385
1386
1387
1388
1389
1390     <li class="md-nav__item">
1391       <a href="../../../package/pip/template-listener/" class="md-nav__link">
1392         templateListener
1393       </a>
1394     </li>
1395
1396
1397
1398
1399
1400
1401
1402     <li class="md-nav__item">
1403       <a href="../../../package/pip/user-group-option/" class="md-nav__link">
1404         userGroupOption
1405       </a>
1406     </li>
1407
1408
1409
1410
1411
1412
1413
1414     <li class="md-nav__item">
1415       <a href="../../../package/pip/user-menu/" class="md-nav__link">
1416         userMenu
1417       </a>
1418     </li>
1419
1420
1421
1422
1423
1424
1425
1426     <li class="md-nav__item">
1427       <a href="../../../package/pip/user-notification-event/" class="md-nav__link">
1428         userNotificationEvent
1429       </a>
1430     </li>
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item">
1439       <a href="../../../package/pip/user-option/" class="md-nav__link">
1440         userOption
1441       </a>
1442     </li>
1443
1444
1445
1446
1447
1448
1449
1450     <li class="md-nav__item">
1451       <a href="../../../package/pip/user-profile-menu/" class="md-nav__link">
1452         userProfileMenu
1453       </a>
1454     </li>
1455
1456
1457
1458         </ul>
1459       </nav>
1460     </li>
1461
1462
1463
1464
1465
1466
1467
1468     <li class="md-nav__item">
1469       <a href="../../../package/database-php-api/" class="md-nav__link">
1470         Database PHP API
1471       </a>
1472     </li>
1473
1474
1475
1476         </ul>
1477       </nav>
1478     </li>
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490     <li class="md-nav__item md-nav__item--nested">
1491
1492
1493         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1494
1495       <label class="md-nav__link" for="__nav_6">
1496         Migration
1497         <span class="md-nav__icon md-icon"></span>
1498       </label>
1499       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1500         <label class="md-nav__title" for="__nav_6">
1501           <span class="md-nav__icon md-icon"></span>
1502           Migration
1503         </label>
1504         <ul class="md-nav__list" data-md-scrollfix>
1505
1506
1507
1508
1509
1510
1511     <li class="md-nav__item md-nav__item--nested">
1512
1513
1514         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1515
1516       <label class="md-nav__link" for="__nav_6_1">
1517         Migrating from WSC 5.3
1518         <span class="md-nav__icon md-icon"></span>
1519       </label>
1520       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1521         <label class="md-nav__title" for="__nav_6_1">
1522           <span class="md-nav__icon md-icon"></span>
1523           Migrating from WSC 5.3
1524         </label>
1525         <ul class="md-nav__list" data-md-scrollfix>
1526
1527
1528
1529
1530
1531     <li class="md-nav__item">
1532       <a href="../../../migration/wsc53/php/" class="md-nav__link">
1533         PHP API
1534       </a>
1535     </li>
1536
1537
1538
1539
1540
1541
1542
1543     <li class="md-nav__item">
1544       <a href="../../../migration/wsc53/session/" class="md-nav__link">
1545         Session Handling and Authentication
1546       </a>
1547     </li>
1548
1549
1550
1551
1552
1553
1554
1555     <li class="md-nav__item">
1556       <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1557         TypeScript and JavaScript
1558       </a>
1559     </li>
1560
1561
1562
1563
1564
1565
1566
1567     <li class="md-nav__item">
1568       <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1569         Templates
1570       </a>
1571     </li>
1572
1573
1574
1575
1576
1577
1578
1579     <li class="md-nav__item">
1580       <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1581         Third Party Libraries
1582       </a>
1583     </li>
1584
1585
1586
1587         </ul>
1588       </nav>
1589     </li>
1590
1591
1592
1593
1594
1595
1596
1597
1598     <li class="md-nav__item md-nav__item--nested">
1599
1600
1601         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1602
1603       <label class="md-nav__link" for="__nav_6_2">
1604         Migrating from WSC 5.2
1605         <span class="md-nav__icon md-icon"></span>
1606       </label>
1607       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1608         <label class="md-nav__title" for="__nav_6_2">
1609           <span class="md-nav__icon md-icon"></span>
1610           Migrating from WSC 5.2
1611         </label>
1612         <ul class="md-nav__list" data-md-scrollfix>
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../../../migration/wsc52/php/" class="md-nav__link">
1620         PHP API
1621       </a>
1622     </li>
1623
1624
1625
1626
1627
1628
1629
1630     <li class="md-nav__item">
1631       <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1632         Templates and Languages
1633       </a>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642     <li class="md-nav__item">
1643       <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1644         Third Party Libraries
1645       </a>
1646     </li>
1647
1648
1649
1650         </ul>
1651       </nav>
1652     </li>
1653
1654
1655
1656
1657
1658
1659
1660
1661     <li class="md-nav__item md-nav__item--nested">
1662
1663
1664         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1665
1666       <label class="md-nav__link" for="__nav_6_3">
1667         Migrating from WSC 3.1
1668         <span class="md-nav__icon md-icon"></span>
1669       </label>
1670       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1671         <label class="md-nav__title" for="__nav_6_3">
1672           <span class="md-nav__icon md-icon"></span>
1673           Migrating from WSC 3.1
1674         </label>
1675         <ul class="md-nav__list" data-md-scrollfix>
1676
1677
1678
1679
1680
1681     <li class="md-nav__item">
1682       <a href="../../../migration/wsc31/php/" class="md-nav__link">
1683         PHP API
1684       </a>
1685     </li>
1686
1687
1688
1689         </ul>
1690       </nav>
1691     </li>
1692
1693
1694
1695
1696
1697
1698
1699
1700     <li class="md-nav__item md-nav__item--nested">
1701
1702
1703         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1704
1705       <label class="md-nav__link" for="__nav_6_4">
1706         Migrating from WSC 3.0
1707         <span class="md-nav__icon md-icon"></span>
1708       </label>
1709       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1710         <label class="md-nav__title" for="__nav_6_4">
1711           <span class="md-nav__icon md-icon"></span>
1712           Migrating from WSC 3.0
1713         </label>
1714         <ul class="md-nav__list" data-md-scrollfix>
1715
1716
1717
1718
1719
1720     <li class="md-nav__item">
1721       <a href="../../../migration/wsc30/php/" class="md-nav__link">
1722         PHP API
1723       </a>
1724     </li>
1725
1726
1727
1728
1729
1730
1731
1732     <li class="md-nav__item">
1733       <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1734         JavaScript API
1735       </a>
1736     </li>
1737
1738
1739
1740
1741
1742
1743
1744     <li class="md-nav__item">
1745       <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1746         Templates
1747       </a>
1748     </li>
1749
1750
1751
1752
1753
1754
1755
1756     <li class="md-nav__item">
1757       <a href="../../../migration/wsc30/css/" class="md-nav__link">
1758         CSS
1759       </a>
1760     </li>
1761
1762
1763
1764
1765
1766
1767
1768     <li class="md-nav__item">
1769       <a href="../../../migration/wsc30/package/" class="md-nav__link">
1770         Package Components
1771       </a>
1772     </li>
1773
1774
1775
1776         </ul>
1777       </nav>
1778     </li>
1779
1780
1781
1782
1783
1784
1785
1786
1787     <li class="md-nav__item md-nav__item--nested">
1788
1789
1790         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1791
1792       <label class="md-nav__link" for="__nav_6_5">
1793         Migrating from WCF 2.1
1794         <span class="md-nav__icon md-icon"></span>
1795       </label>
1796       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1797         <label class="md-nav__title" for="__nav_6_5">
1798           <span class="md-nav__icon md-icon"></span>
1799           Migrating from WCF 2.1
1800         </label>
1801         <ul class="md-nav__list" data-md-scrollfix>
1802
1803
1804
1805
1806
1807     <li class="md-nav__item">
1808       <a href="../../../migration/wcf21/php/" class="md-nav__link">
1809         PHP API
1810       </a>
1811     </li>
1812
1813
1814
1815
1816
1817
1818
1819     <li class="md-nav__item">
1820       <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1821         Templates
1822       </a>
1823     </li>
1824
1825
1826
1827
1828
1829
1830
1831     <li class="md-nav__item">
1832       <a href="../../../migration/wcf21/css/" class="md-nav__link">
1833         CSS
1834       </a>
1835     </li>
1836
1837
1838
1839
1840
1841
1842
1843     <li class="md-nav__item">
1844       <a href="../../../migration/wcf21/package/" class="md-nav__link">
1845         Package Components
1846       </a>
1847     </li>
1848
1849
1850
1851         </ul>
1852       </nav>
1853     </li>
1854
1855
1856
1857         </ul>
1858       </nav>
1859     </li>
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871     <li class="md-nav__item md-nav__item--nested">
1872
1873
1874         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1875
1876       <label class="md-nav__link" for="__nav_7">
1877         Tutorials
1878         <span class="md-nav__icon md-icon"></span>
1879       </label>
1880       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1881         <label class="md-nav__title" for="__nav_7">
1882           <span class="md-nav__icon md-icon"></span>
1883           Tutorials
1884         </label>
1885         <ul class="md-nav__list" data-md-scrollfix>
1886
1887
1888
1889
1890
1891
1892     <li class="md-nav__item md-nav__item--nested">
1893
1894
1895         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1896
1897       <label class="md-nav__link" for="__nav_7_1">
1898         Tutorial Series
1899         <span class="md-nav__icon md-icon"></span>
1900       </label>
1901       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1902         <label class="md-nav__title" for="__nav_7_1">
1903           <span class="md-nav__icon md-icon"></span>
1904           Tutorial Series
1905         </label>
1906         <ul class="md-nav__list" data-md-scrollfix>
1907
1908
1909
1910
1911
1912     <li class="md-nav__item">
1913       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1914         Overview
1915       </a>
1916     </li>
1917
1918
1919
1920
1921
1922
1923
1924     <li class="md-nav__item">
1925       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1926         Part 1
1927       </a>
1928     </li>
1929
1930
1931
1932
1933
1934
1935
1936     <li class="md-nav__item">
1937       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1938         Part 2
1939       </a>
1940     </li>
1941
1942
1943
1944
1945
1946
1947
1948     <li class="md-nav__item">
1949       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1950         Part 3
1951       </a>
1952     </li>
1953
1954
1955
1956         </ul>
1957       </nav>
1958     </li>
1959
1960
1961
1962         </ul>
1963       </nav>
1964     </li>
1965
1966
1967
1968   </ul>
1969 </nav>
1970                   </div>
1971                 </div>
1972               </div>
1973
1974
1975
1976               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1977                 <div class="md-sidebar__scrollwrap">
1978                   <div class="md-sidebar__inner">
1979
1980 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1981
1982
1983
1984
1985
1986     <label class="md-nav__title" for="__toc">
1987       <span class="md-nav__icon md-icon"></span>
1988       Table of contents
1989     </label>
1990     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1991
1992         <li class="md-nav__item">
1993   <a href="#abstractpackageinstallationplugin" class="md-nav__link">
1994     AbstractPackageInstallationPlugin
1995   </a>
1996
1997     <nav class="md-nav" aria-label="AbstractPackageInstallationPlugin">
1998       <ul class="md-nav__list">
1999
2000           <li class="md-nav__item">
2001   <a href="#class-members" class="md-nav__link">
2002     Class Members
2003   </a>
2004
2005     <nav class="md-nav" aria-label="Class Members">
2006       <ul class="md-nav__list">
2007
2008           <li class="md-nav__item">
2009   <a href="#installation" class="md-nav__link">
2010     $installation
2011   </a>
2012
2013 </li>
2014
2015           <li class="md-nav__item">
2016   <a href="#application" class="md-nav__link">
2017     $application
2018   </a>
2019
2020 </li>
2021
2022       </ul>
2023     </nav>
2024
2025 </li>
2026
2027       </ul>
2028     </nav>
2029
2030 </li>
2031
2032         <li class="md-nav__item">
2033   <a href="#abstractxmlpackageinstallationplugin" class="md-nav__link">
2034     AbstractXMLPackageInstallationPlugin
2035   </a>
2036
2037     <nav class="md-nav" aria-label="AbstractXMLPackageInstallationPlugin">
2038       <ul class="md-nav__list">
2039
2040           <li class="md-nav__item">
2041   <a href="#class-members_1" class="md-nav__link">
2042     Class Members
2043   </a>
2044
2045     <nav class="md-nav" aria-label="Class Members">
2046       <ul class="md-nav__list">
2047
2048           <li class="md-nav__item">
2049   <a href="#classname" class="md-nav__link">
2050     $className
2051   </a>
2052
2053 </li>
2054
2055           <li class="md-nav__item">
2056   <a href="#tagname" class="md-nav__link">
2057     $tagName
2058   </a>
2059
2060 </li>
2061
2062           <li class="md-nav__item">
2063   <a href="#prepareimportarray-data" class="md-nav__link">
2064     prepareImport(array $data)
2065   </a>
2066
2067 </li>
2068
2069           <li class="md-nav__item">
2070   <a href="#validateimportarray-data" class="md-nav__link">
2071     validateImport(array $data)
2072   </a>
2073
2074 </li>
2075
2076           <li class="md-nav__item">
2077   <a href="#findexistingitemarray-data" class="md-nav__link">
2078     findExistingItem(array $data)
2079   </a>
2080
2081 </li>
2082
2083           <li class="md-nav__item">
2084   <a href="#253-example" class="md-nav__link">
2085     2.5.3. Example
2086   </a>
2087
2088 </li>
2089
2090           <li class="md-nav__item">
2091   <a href="#handledeletearray-items" class="md-nav__link">
2092     handleDelete(array $items)
2093   </a>
2094
2095 </li>
2096
2097           <li class="md-nav__item">
2098   <a href="#postimport" class="md-nav__link">
2099     postImport()
2100   </a>
2101
2102 </li>
2103
2104       </ul>
2105     </nav>
2106
2107 </li>
2108
2109       </ul>
2110     </nav>
2111
2112 </li>
2113
2114         <li class="md-nav__item">
2115   <a href="#abstractoptionpackageinstallationplugin" class="md-nav__link">
2116     AbstractOptionPackageInstallationPlugin
2117   </a>
2118
2119     <nav class="md-nav" aria-label="AbstractOptionPackageInstallationPlugin">
2120       <ul class="md-nav__list">
2121
2122           <li class="md-nav__item">
2123   <a href="#differences-to-abstractxmlpackageinstallationplugin" class="md-nav__link">
2124     Differences to AbstractXMLPackageInstallationPlugin
2125   </a>
2126
2127     <nav class="md-nav" aria-label="Differences to AbstractXMLPackageInstallationPlugin">
2128       <ul class="md-nav__list">
2129
2130           <li class="md-nav__item">
2131   <a href="#reservedtags" class="md-nav__link">
2132     $reservedTags
2133   </a>
2134
2135 </li>
2136
2137       </ul>
2138     </nav>
2139
2140 </li>
2141
2142       </ul>
2143     </nav>
2144
2145 </li>
2146
2147     </ul>
2148
2149 </nav>
2150                   </div>
2151                 </div>
2152               </div>
2153
2154
2155           <div class="md-content" data-md-component="content">
2156             <article class="md-content__inner md-typeset">
2157
2158
2159                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/package_installation_plugins.md" title="Edit this page" class="md-content__button md-icon">
2160                     <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>
2161                   </a>
2162
2163
2164                 <h1 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h1>
2165 <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>
2166 <h2 id="abstractpackageinstallationplugin"><code>AbstractPackageInstallationPlugin</code><a class="headerlink" href="#abstractpackageinstallationplugin" title="Permanent link">#</a></h2>
2167 <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.
2168 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.
2169 The abstract implementation will always provide sane methods in case of any API changes.</p>
2170 <h3 id="class-members">Class Members<a class="headerlink" href="#class-members" title="Permanent link">#</a></h3>
2171 <p>Package Installation Plugins have a few notable class members easing your work:</p>
2172 <h4 id="installation"><code>$installation</code><a class="headerlink" href="#installation" title="Permanent link">#</a></h4>
2173 <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.
2174 The most common usage is the retrieval of the package ID via <code>$this-&gt;installation-&gt;getPackageID()</code>.</p>
2175 <h4 id="application"><code>$application</code><a class="headerlink" href="#application" title="Permanent link">#</a></h4>
2176 <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>
2177 <h2 id="abstractxmlpackageinstallationplugin"><code>AbstractXMLPackageInstallationPlugin</code><a class="headerlink" href="#abstractxmlpackageinstallationplugin" title="Permanent link">#</a></h2>
2178 <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.
2179 It handles the evaluation of the document and provide you an object-orientated approach to handle its data.</p>
2180 <h3 id="class-members_1">Class Members<a class="headerlink" href="#class-members_1" title="Permanent link">#</a></h3>
2181 <h4 id="classname"><code>$className</code><a class="headerlink" href="#classname" title="Permanent link">#</a></h4>
2182 <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>
2183 <h4 id="tagname"><code>$tagName</code><a class="headerlink" href="#tagname" title="Permanent link">#</a></h4>
2184 <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>
2185 <h4 id="prepareimportarray-data"><code>prepareImport(array $data)</code><a class="headerlink" href="#prepareimportarray-data" title="Permanent link">#</a></h4>
2186 <p>The passed array <code>$data</code> contains the parsed value from each evaluated tag in the <code>&lt;import&gt;</code> section:</p>
2187 <ul>
2188 <li><code>$data['elements']</code> contains a list of tag names and their value.</li>
2189 <li><code>$data['attributes']</code> contains a list of attributes present on the tag identified by <a href="#tagname">$tagName</a>.</li>
2190 </ul>
2191 <p>This method should return an one-dimensional array, where each key maps to the corresponding database column name (key names are case-sensitive).
2192 It will be passed to either <code>DatabaseObjectEditor::create()</code> or <code>DatabaseObjectEditor::update()</code>.</p>
2193 <p>Example:</p>
2194 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2195 <span class="k">return</span> <span class="p">[</span>
2196     <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="o">.</span><span class="nx">md</span><span class="p">],</span>
2197     <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="o">.</span><span class="nx">md</span><span class="p">],</span>
2198     <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="o">.</span><span class="nx">md</span><span class="p">]</span>
2199 <span class="p">];</span>
2200 </code></pre></div>
2201 <h4 id="validateimportarray-data"><code>validateImport(array $data)</code><a class="headerlink" href="#validateimportarray-data" title="Permanent link">#</a></h4>
2202 <p>The passed array <code>$data</code> equals the data returned by <a href="#prepareimportarray-data">prepareImport()</a>.
2203 This method has no return value, instead you should throw an exception if the passed data is invalid.</p>
2204 <h4 id="findexistingitemarray-data"><code>findExistingItem(array $data)</code><a class="headerlink" href="#findexistingitemarray-data" title="Permanent link">#</a></h4>
2205 <p>The passed array <code>$data</code> equals the data returned by <a href="#prepareimportarray-data">prepareImport()</a>.
2206 This method is expected to return an array with two keys:</p>
2207 <ul>
2208 <li><code>sql</code> contains the SQL query with placeholders.</li>
2209 <li><code>parameters</code> contains an array with values used for the SQL query.</li>
2210 </ul>
2211 <h4 id="253-example">2.5.3. Example<a class="headerlink" href="#253-example" title="Permanent link">#</a></h4>
2212 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2213 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;SELECT  *</span>
2214 <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>
2215 <span class="s2">    WHERE   packageID = ?</span>
2216 <span class="s2">        AND name = ?</span>
2217 <span class="s2">        AND templateName = ?</span>
2218 <span class="s2">        AND eventName = ?</span>
2219 <span class="s2">        AND environment = ?&quot;</span><span class="p">;</span>
2220 <span class="nv">$parameters</span> <span class="o">=</span> <span class="p">[</span>
2221     <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>
2222     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
2223     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;templateName&#39;</span><span class="p">],</span>
2224     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;eventName&#39;</span><span class="p">],</span>
2225     <span class="nv">$data</span><span class="p">[</span><span class="s1">&#39;environment&#39;</span><span class="p">]</span>
2226 <span class="p">];</span>
2227
2228 <span class="k">return</span> <span class="p">[</span>
2229     <span class="s1">&#39;sql&#39;</span> <span class="o">=&gt;</span> <span class="nv">$sql</span><span class="p">,</span>
2230     <span class="s1">&#39;parameters&#39;</span> <span class="o">=&gt;</span> <span class="nv">$parameters</span>
2231 <span class="p">];</span>
2232 </code></pre></div>
2233 <h4 id="handledeletearray-items"><code>handleDelete(array $items)</code><a class="headerlink" href="#handledeletearray-items" title="Permanent link">#</a></h4>
2234 <p>The passed array <code>$items</code> contains the original node data, similar to <a href="#prepareimportarray-data">prepareImport()</a>.
2235 You should make use of this data to remove the matching element from database.</p>
2236 <p>Example:
2237 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2238 <span class="nv">$sql</span> <span class="o">=</span> <span class="s2">&quot;DELETE 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>
2239 <span class="s2">    WHERE       packageID = ?</span>
2240 <span class="s2">            AND environment = ?</span>
2241 <span class="s2">            AND eventName = ?</span>
2242 <span class="s2">            AND name = ?</span>
2243 <span class="s2">            AND templateName = ?&quot;</span><span class="p">;</span>
2244 <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">prepareStatement</span><span class="p">(</span><span class="nv">$sql</span><span class="p">);</span>
2245 <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>
2246     <span class="nv">$statement</span><span class="o">-&gt;</span><span class="na">execute</span><span class="p">([</span>
2247         <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>
2248         <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="o">.</span><span class="nx">md</span><span class="p">],</span>
2249         <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="o">.</span><span class="nx">md</span><span class="p">],</span>
2250         <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="o">.</span><span class="nx">md</span><span class="p">],</span>
2251         <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="o">.</span><span class="nx">md</span><span class="p">]</span>
2252     <span class="p">]);</span>
2253 <span class="p">}</span>
2254 </code></pre></div></p>
2255 <h4 id="postimport"><code>postImport()</code><a class="headerlink" href="#postimport" title="Permanent link">#</a></h4>
2256 <p>Allows you to (optionally) run additionally actions after all elements were processed.</p>
2257 <h2 id="abstractoptionpackageinstallationplugin"><code>AbstractOptionPackageInstallationPlugin</code><a class="headerlink" href="#abstractoptionpackageinstallationplugin" title="Permanent link">#</a></h2>
2258 <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>
2259 <ul>
2260 <li>ACL Options</li>
2261 <li>Options</li>
2262 <li>User Options</li>
2263 <li>User Group Options</li>
2264 </ul>
2265 <h3 id="differences-to-abstractxmlpackageinstallationplugin">Differences to <code>AbstractXMLPackageInstallationPlugin</code><a class="headerlink" href="#differences-to-abstractxmlpackageinstallationplugin" title="Permanent link">#</a></h3>
2266 <h4 id="reservedtags"><code>$reservedTags</code><a class="headerlink" href="#reservedtags" title="Permanent link">#</a></h4>
2267 <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>.
2268 This allows options to store arbitrary data which can be accessed but were not initially part of the PIP specifications.</p>
2269
2270
2271
2272
2273 <hr>
2274 <div class="md-source-date">
2275   <small>
2276
2277       Last update: 2021-01-08
2278
2279   </small>
2280 </div>
2281
2282
2283
2284
2285
2286
2287
2288
2289             </article>
2290           </div>
2291         </div>
2292
2293       </main>
2294
2295
2296 <footer class="md-footer">
2297
2298     <nav class="md-footer__inner md-grid" aria-label="Footer">
2299
2300         <a href="../form_builder/dependencies/" class="md-footer__link md-footer__link--prev" rel="prev">
2301           <div class="md-footer__button md-icon">
2302             <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>
2303           </div>
2304           <div class="md-footer__title">
2305             <div class="md-ellipsis">
2306               <span class="md-footer__direction">
2307                 Previous
2308               </span>
2309               Dependencies
2310             </div>
2311           </div>
2312         </a>
2313
2314
2315         <a href="../user_activity_points/" class="md-footer__link md-footer__link--next" rel="next">
2316           <div class="md-footer__title">
2317             <div class="md-ellipsis">
2318               <span class="md-footer__direction">
2319                 Next
2320               </span>
2321               User Activity Points
2322             </div>
2323           </div>
2324           <div class="md-footer__button md-icon">
2325             <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>
2326           </div>
2327         </a>
2328
2329     </nav>
2330
2331   <div class="md-footer-meta md-typeset">
2332     <div class="md-footer-meta__inner md-grid">
2333       <div class="md-footer-copyright">
2334
2335           <div class="md-footer-copyright__highlight">
2336             Copyright © 2020 WoltLab GmbH
2337           </div>
2338
2339         Made with
2340         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2341           Material for MkDocs
2342         </a>
2343
2344       </div>
2345       <div class="md-footer-copyright">
2346         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2347         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2348 </div>
2349     </div>
2350   </div>
2351 </footer>
2352
2353     </div>
2354     <div class="md-dialog" data-md-component="dialog">
2355       <div class="md-dialog__inner md-typeset"></div>
2356     </div>
2357     <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>
2358
2359
2360       <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2361
2362
2363   </body>
2364 </html>