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