5.4/package/pip/file/index.html

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