latest/package/pip/object-type-definition/index.html

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