Deployed e3be2c0 to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / 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 <li class="md-nav__item">
310 <a href="../../../php/api/caches/" class="md-nav__link">
311 Caches
312 </a>
313 </li>
314
315
316
317
318
319
320
321 <li class="md-nav__item">
322 <a href="../../../php/api/comments/" class="md-nav__link">
323 Comments
324 </a>
325 </li>
326
327
328
329
330
331
332
333 <li class="md-nav__item">
334 <a href="../../../php/api/cronjobs/" class="md-nav__link">
335 Cronjobs
336 </a>
337 </li>
338
339
340
341
342
343
344
345 <li class="md-nav__item">
346 <a href="../../../php/api/events/" class="md-nav__link">
347 Events
348 </a>
349 </li>
350
351
352
353
354
355
356
357
358 <li class="md-nav__item md-nav__item--nested">
359
360
361 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
362
363 <label class="md-nav__link" for="__nav_2_5_5">
364 Form Builder
365 <span class="md-nav__icon md-icon"></span>
366 </label>
367 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
368 <label class="md-nav__title" for="__nav_2_5_5">
369 <span class="md-nav__icon md-icon"></span>
370 Form Builder
371 </label>
372 <ul class="md-nav__list" data-md-scrollfix>
373
374
375
376
377
378 <li class="md-nav__item">
379 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
380 Overview
381 </a>
382 </li>
383
384
385
386
387
388
389
390 <li class="md-nav__item">
391 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
392 Structure
393 </a>
394 </li>
395
396
397
398
399
400
401
402 <li class="md-nav__item">
403 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
404 Fields
405 </a>
406 </li>
407
408
409
410
411
412
413
414 <li class="md-nav__item">
415 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
416 Validation and Data
417 </a>
418 </li>
419
420
421
422
423
424
425
426 <li class="md-nav__item">
427 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
428 Dependencies
429 </a>
430 </li>
431
432
433
434 </ul>
435 </nav>
436 </li>
437
438
439
440
441
442
443
444 <li class="md-nav__item">
445 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
446 Package Installation Plugins
447 </a>
448 </li>
449
450
451
452
453
454
455
456 <li class="md-nav__item">
457 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
458 User Activity Points
459 </a>
460 </li>
461
462
463
464
465
466
467
468 <li class="md-nav__item">
469 <a href="../../../php/api/user_notifications/" class="md-nav__link">
470 User Notifications
471 </a>
472 </li>
473
474
475
476
477
478
479
480 <li class="md-nav__item">
481 <a href="../../../php/api/sitemaps/" class="md-nav__link">
482 Sitemaps
483 </a>
484 </li>
485
486
487
488 </ul>
489 </nav>
490 </li>
491
492
493
494
495
496
497
498 <li class="md-nav__item">
499 <a href="../../../php/code-style/" class="md-nav__link">
500 Code Style
501 </a>
502 </li>
503
504
505
506
507
508
509
510 <li class="md-nav__item">
511 <a href="../../../php/apps/" class="md-nav__link">
512 Apps
513 </a>
514 </li>
515
516
517
518
519
520
521
522 <li class="md-nav__item">
523 <a href="../../../php/gdpr/" class="md-nav__link">
524 GDPR
525 </a>
526 </li>
527
528
529
530 </ul>
531 </nav>
532 </li>
533
534
535
536
537
538
539
540
541
542
543
544 <li class="md-nav__item md-nav__item--nested">
545
546
547 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
548
549 <label class="md-nav__link" for="__nav_3">
550 Languages, Templates & CSS
551 <span class="md-nav__icon md-icon"></span>
552 </label>
553 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
554 <label class="md-nav__title" for="__nav_3">
555 <span class="md-nav__icon md-icon"></span>
556 Languages, Templates & CSS
557 </label>
558 <ul class="md-nav__list" data-md-scrollfix>
559
560
561
562
563
564 <li class="md-nav__item">
565 <a href="../../../view/languages/" class="md-nav__link">
566 Languages
567 </a>
568 </li>
569
570
571
572
573
574
575
576 <li class="md-nav__item">
577 <a href="../../../view/templates/" class="md-nav__link">
578 Templates
579 </a>
580 </li>
581
582
583
584
585
586
587
588 <li class="md-nav__item">
589 <a href="../../../view/css/" class="md-nav__link">
590 CSS
591 </a>
592 </li>
593
594
595
596 </ul>
597 </nav>
598 </li>
599
600
601
602
603
604
605
606
607
608
609
610 <li class="md-nav__item md-nav__item--nested">
611
612
613 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
614
615 <label class="md-nav__link" for="__nav_4">
616 JavaScript API
617 <span class="md-nav__icon md-icon"></span>
618 </label>
619 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
620 <label class="md-nav__title" for="__nav_4">
621 <span class="md-nav__icon md-icon"></span>
622 JavaScript API
623 </label>
624 <ul class="md-nav__list" data-md-scrollfix>
625
626
627
628
629
630 <li class="md-nav__item">
631 <a href="../../../javascript/general-usage/" class="md-nav__link">
632 General Usage
633 </a>
634 </li>
635
636
637
638
639
640
641
642
643 <li class="md-nav__item md-nav__item--nested">
644
645
646 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
647
648 <label class="md-nav__link" for="__nav_4_2">
649 New API
650 <span class="md-nav__icon md-icon"></span>
651 </label>
652 <nav class="md-nav" aria-label="New API" data-md-level="2">
653 <label class="md-nav__title" for="__nav_4_2">
654 <span class="md-nav__icon md-icon"></span>
655 New API
656 </label>
657 <ul class="md-nav__list" data-md-scrollfix>
658
659
660
661
662
663 <li class="md-nav__item">
664 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
665 Writing a module
666 </a>
667 </li>
668
669
670
671
672
673
674
675 <li class="md-nav__item">
676 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
677 Data Structures
678 </a>
679 </li>
680
681
682
683
684
685
686
687 <li class="md-nav__item">
688 <a href="../../../javascript/new-api_core/" class="md-nav__link">
689 Core Functions
690 </a>
691 </li>
692
693
694
695
696
697
698
699 <li class="md-nav__item">
700 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
701 DOM
702 </a>
703 </li>
704
705
706
707
708
709
710
711 <li class="md-nav__item">
712 <a href="../../../javascript/new-api_events/" class="md-nav__link">
713 Event Handling
714 </a>
715 </li>
716
717
718
719
720
721
722
723 <li class="md-nav__item">
724 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
725 Ajax
726 </a>
727 </li>
728
729
730
731
732
733
734
735 <li class="md-nav__item">
736 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
737 Dialogs
738 </a>
739 </li>
740
741
742
743
744
745
746
747 <li class="md-nav__item">
748 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
749 Browser and Screen Sizes
750 </a>
751 </li>
752
753
754
755
756
757
758
759 <li class="md-nav__item">
760 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
761 User Interface
762 </a>
763 </li>
764
765
766
767 </ul>
768 </nav>
769 </li>
770
771
772
773
774
775
776
777 <li class="md-nav__item">
778 <a href="../../../javascript/legacy-api/" class="md-nav__link">
779 Legacy API
780 </a>
781 </li>
782
783
784
785
786
787
788
789 <li class="md-nav__item">
790 <a href="../../../javascript/helper-functions/" class="md-nav__link">
791 Helper Functions
792 </a>
793 </li>
794
795
796
797
798
799
800
801 <li class="md-nav__item">
802 <a href="../../../javascript/code-snippets/" class="md-nav__link">
803 Code Snippets
804 </a>
805 </li>
806
807
808
809 </ul>
810 </nav>
811 </li>
812
813
814
815
816
817
818
819
820
821
822
823
824
825 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
826
827
828 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
829
830 <label class="md-nav__link" for="__nav_5">
831 Package Components
832 <span class="md-nav__icon md-icon"></span>
833 </label>
834 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
835 <label class="md-nav__title" for="__nav_5">
836 <span class="md-nav__icon md-icon"></span>
837 Package Components
838 </label>
839 <ul class="md-nav__list" data-md-scrollfix>
840
841
842
843
844
845 <li class="md-nav__item">
846 <a href="../../package-xml/" class="md-nav__link">
847 package.xml
848 </a>
849 </li>
850
851
852
853
854
855
856
857
858
859
860 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
861
862
863 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
864
865 <label class="md-nav__link" for="__nav_5_2">
866 PIPs
867 <span class="md-nav__icon md-icon"></span>
868 </label>
869 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
870 <label class="md-nav__title" for="__nav_5_2">
871 <span class="md-nav__icon md-icon"></span>
872 PIPs
873 </label>
874 <ul class="md-nav__list" data-md-scrollfix>
875
876
877
878
879
880 <li class="md-nav__item">
881 <a href="../" class="md-nav__link">
882 Overview
883 </a>
884 </li>
885
886
887
888
889
890
891
892 <li class="md-nav__item">
893 <a href="../acl-option/" class="md-nav__link">
894 aclOption
895 </a>
896 </li>
897
898
899
900
901
902
903
904 <li class="md-nav__item">
905 <a href="../acp-menu/" class="md-nav__link">
906 acpMenu
907 </a>
908 </li>
909
910
911
912
913
914
915
916 <li class="md-nav__item">
917 <a href="../acp-search-provider/" class="md-nav__link">
918 acpSearchProvider
919 </a>
920 </li>
921
922
923
924
925
926
927
928 <li class="md-nav__item">
929 <a href="../acp-template/" class="md-nav__link">
930 acpTemplate
931 </a>
932 </li>
933
934
935
936
937
938
939
940 <li class="md-nav__item">
941 <a href="../bbcode/" class="md-nav__link">
942 bbcode
943 </a>
944 </li>
945
946
947
948
949
950
951
952 <li class="md-nav__item">
953 <a href="../box/" class="md-nav__link">
954 box
955 </a>
956 </li>
957
958
959
960
961
962
963
964 <li class="md-nav__item">
965 <a href="../clipboard-action/" class="md-nav__link">
966 clipboardAction
967 </a>
968 </li>
969
970
971
972
973
974
975
976
977
978 <li class="md-nav__item md-nav__item--active">
979
980 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
981
982
983
984
985 <label class="md-nav__link md-nav__link--active" for="__toc">
986 coreObject
987 <span class="md-nav__icon md-icon"></span>
988 </label>
989
990 <a href="./" class="md-nav__link md-nav__link--active">
991 coreObject
992 </a>
993
994
995 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
996
997
998
999
1000
1001 <label class="md-nav__title" for="__toc">
1002 <span class="md-nav__icon md-icon"></span>
1003 Table of contents
1004 </label>
1005 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1006
1007 <li class="md-nav__item">
1008 <a href="#components" class="md-nav__link">
1009 Components
1010 </a>
1011
1012 <nav class="md-nav" aria-label="Components">
1013 <ul class="md-nav__list">
1014
1015 <li class="md-nav__item">
1016 <a href="#objectname" class="md-nav__link">
1017 &lt;objectname&gt;
1018 </a>
1019
1020 </li>
1021
1022 </ul>
1023 </nav>
1024
1025 </li>
1026
1027 <li class="md-nav__item">
1028 <a href="#example" class="md-nav__link">
1029 Example
1030 </a>
1031
1032 </li>
1033
1034 </ul>
1035
1036 </nav>
1037
1038 </li>
1039
1040
1041
1042
1043
1044
1045
1046 <li class="md-nav__item">
1047 <a href="../cronjob/" class="md-nav__link">
1048 cronjob
1049 </a>
1050 </li>
1051
1052
1053
1054
1055
1056
1057
1058 <li class="md-nav__item">
1059 <a href="../event-listener/" class="md-nav__link">
1060 eventListener
1061 </a>
1062 </li>
1063
1064
1065
1066
1067
1068
1069
1070 <li class="md-nav__item">
1071 <a href="../file/" class="md-nav__link">
1072 file
1073 </a>
1074 </li>
1075
1076
1077
1078
1079
1080
1081
1082 <li class="md-nav__item">
1083 <a href="../language/" class="md-nav__link">
1084 language
1085 </a>
1086 </li>
1087
1088
1089
1090
1091
1092
1093
1094 <li class="md-nav__item">
1095 <a href="../media-provider/" class="md-nav__link">
1096 mediaProvider
1097 </a>
1098 </li>
1099
1100
1101
1102
1103
1104
1105
1106 <li class="md-nav__item">
1107 <a href="../menu/" class="md-nav__link">
1108 menu
1109 </a>
1110 </li>
1111
1112
1113
1114
1115
1116
1117
1118 <li class="md-nav__item">
1119 <a href="../menu-item/" class="md-nav__link">
1120 menuItem
1121 </a>
1122 </li>
1123
1124
1125
1126
1127
1128
1129
1130 <li class="md-nav__item">
1131 <a href="../object-type/" class="md-nav__link">
1132 objectType
1133 </a>
1134 </li>
1135
1136
1137
1138
1139
1140
1141
1142 <li class="md-nav__item">
1143 <a href="../object-type-definition/" class="md-nav__link">
1144 objectTypeDefinition
1145 </a>
1146 </li>
1147
1148
1149
1150
1151
1152
1153
1154 <li class="md-nav__item">
1155 <a href="../option/" class="md-nav__link">
1156 option
1157 </a>
1158 </li>
1159
1160
1161
1162
1163
1164
1165
1166 <li class="md-nav__item">
1167 <a href="../page/" class="md-nav__link">
1168 page
1169 </a>
1170 </li>
1171
1172
1173
1174
1175
1176
1177
1178 <li class="md-nav__item">
1179 <a href="../pip/" class="md-nav__link">
1180 pip
1181 </a>
1182 </li>
1183
1184
1185
1186
1187
1188
1189
1190 <li class="md-nav__item">
1191 <a href="../script/" class="md-nav__link">
1192 script
1193 </a>
1194 </li>
1195
1196
1197
1198
1199
1200
1201
1202 <li class="md-nav__item">
1203 <a href="../smiley/" class="md-nav__link">
1204 smiley
1205 </a>
1206 </li>
1207
1208
1209
1210
1211
1212
1213
1214 <li class="md-nav__item">
1215 <a href="../sql/" class="md-nav__link">
1216 sql
1217 </a>
1218 </li>
1219
1220
1221
1222
1223
1224
1225
1226 <li class="md-nav__item">
1227 <a href="../style/" class="md-nav__link">
1228 style
1229 </a>
1230 </li>
1231
1232
1233
1234
1235
1236
1237
1238 <li class="md-nav__item">
1239 <a href="../template/" class="md-nav__link">
1240 template
1241 </a>
1242 </li>
1243
1244
1245
1246
1247
1248
1249
1250 <li class="md-nav__item">
1251 <a href="../template-listener/" class="md-nav__link">
1252 templateListener
1253 </a>
1254 </li>
1255
1256
1257
1258
1259
1260
1261
1262 <li class="md-nav__item">
1263 <a href="../user-group-option/" class="md-nav__link">
1264 userGroupOption
1265 </a>
1266 </li>
1267
1268
1269
1270
1271
1272
1273
1274 <li class="md-nav__item">
1275 <a href="../user-menu/" class="md-nav__link">
1276 userMenu
1277 </a>
1278 </li>
1279
1280
1281
1282
1283
1284
1285
1286 <li class="md-nav__item">
1287 <a href="../user-notification-event/" class="md-nav__link">
1288 userNotificationEvent
1289 </a>
1290 </li>
1291
1292
1293
1294
1295
1296
1297
1298 <li class="md-nav__item">
1299 <a href="../user-option/" class="md-nav__link">
1300 userOption
1301 </a>
1302 </li>
1303
1304
1305
1306
1307
1308
1309
1310 <li class="md-nav__item">
1311 <a href="../user-profile-menu/" class="md-nav__link">
1312 userProfileMenu
1313 </a>
1314 </li>
1315
1316
1317
1318 </ul>
1319 </nav>
1320 </li>
1321
1322
1323
1324
1325
1326
1327
1328 <li class="md-nav__item">
1329 <a href="../../database-php-api/" class="md-nav__link">
1330 Database PHP API
1331 </a>
1332 </li>
1333
1334
1335
1336 </ul>
1337 </nav>
1338 </li>
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350 <li class="md-nav__item md-nav__item--nested">
1351
1352
1353 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1354
1355 <label class="md-nav__link" for="__nav_6">
1356 Migration
1357 <span class="md-nav__icon md-icon"></span>
1358 </label>
1359 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1360 <label class="md-nav__title" for="__nav_6">
1361 <span class="md-nav__icon md-icon"></span>
1362 Migration
1363 </label>
1364 <ul class="md-nav__list" data-md-scrollfix>
1365
1366
1367
1368
1369
1370
1371 <li class="md-nav__item md-nav__item--nested">
1372
1373
1374 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1375
1376 <label class="md-nav__link" for="__nav_6_1">
1377 Migrating from WSC 5.3
1378 <span class="md-nav__icon md-icon"></span>
1379 </label>
1380 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1381 <label class="md-nav__title" for="__nav_6_1">
1382 <span class="md-nav__icon md-icon"></span>
1383 Migrating from WSC 5.3
1384 </label>
1385 <ul class="md-nav__list" data-md-scrollfix>
1386
1387
1388
1389
1390
1391 <li class="md-nav__item">
1392 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1393 PHP API
1394 </a>
1395 </li>
1396
1397
1398
1399
1400
1401
1402
1403 <li class="md-nav__item">
1404 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1405 Session Handling and Authentication
1406 </a>
1407 </li>
1408
1409
1410
1411
1412
1413
1414
1415 <li class="md-nav__item">
1416 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1417 JavaScript
1418 </a>
1419 </li>
1420
1421
1422
1423
1424
1425
1426
1427 <li class="md-nav__item">
1428 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1429 Templates
1430 </a>
1431 </li>
1432
1433
1434
1435
1436
1437
1438
1439 <li class="md-nav__item">
1440 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1441 Third Party Libraries
1442 </a>
1443 </li>
1444
1445
1446
1447 </ul>
1448 </nav>
1449 </li>
1450
1451
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_2" type="checkbox" id="__nav_6_2" >
1462
1463 <label class="md-nav__link" for="__nav_6_2">
1464 Migrating from WSC 5.2
1465 <span class="md-nav__icon md-icon"></span>
1466 </label>
1467 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1468 <label class="md-nav__title" for="__nav_6_2">
1469 <span class="md-nav__icon md-icon"></span>
1470 Migrating from WSC 5.2
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/wsc52/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/wsc52/templates/" class="md-nav__link">
1492 Templates and Languages
1493 </a>
1494 </li>
1495
1496
1497
1498
1499
1500
1501
1502 <li class="md-nav__item">
1503 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1504 Third Party Libraries
1505 </a>
1506 </li>
1507
1508
1509
1510 </ul>
1511 </nav>
1512 </li>
1513
1514
1515
1516
1517
1518
1519
1520
1521 <li class="md-nav__item md-nav__item--nested">
1522
1523
1524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1525
1526 <label class="md-nav__link" for="__nav_6_3">
1527 Migrating from WSC 3.1
1528 <span class="md-nav__icon md-icon"></span>
1529 </label>
1530 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1531 <label class="md-nav__title" for="__nav_6_3">
1532 <span class="md-nav__icon md-icon"></span>
1533 Migrating from WSC 3.1
1534 </label>
1535 <ul class="md-nav__list" data-md-scrollfix>
1536
1537
1538
1539
1540
1541 <li class="md-nav__item">
1542 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1543 PHP API
1544 </a>
1545 </li>
1546
1547
1548
1549 </ul>
1550 </nav>
1551 </li>
1552
1553
1554
1555
1556
1557
1558
1559
1560 <li class="md-nav__item md-nav__item--nested">
1561
1562
1563 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1564
1565 <label class="md-nav__link" for="__nav_6_4">
1566 Migrating from WSC 3.0
1567 <span class="md-nav__icon md-icon"></span>
1568 </label>
1569 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1570 <label class="md-nav__title" for="__nav_6_4">
1571 <span class="md-nav__icon md-icon"></span>
1572 Migrating from WSC 3.0
1573 </label>
1574 <ul class="md-nav__list" data-md-scrollfix>
1575
1576
1577
1578
1579
1580 <li class="md-nav__item">
1581 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1582 PHP API
1583 </a>
1584 </li>
1585
1586
1587
1588
1589
1590
1591
1592 <li class="md-nav__item">
1593 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1594 JavaScript API
1595 </a>
1596 </li>
1597
1598
1599
1600
1601
1602
1603
1604 <li class="md-nav__item">
1605 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1606 Templates
1607 </a>
1608 </li>
1609
1610
1611
1612
1613
1614
1615
1616 <li class="md-nav__item">
1617 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1618 CSS
1619 </a>
1620 </li>
1621
1622
1623
1624
1625
1626
1627
1628 <li class="md-nav__item">
1629 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1630 Package Components
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_5" type="checkbox" id="__nav_6_5" >
1651
1652 <label class="md-nav__link" for="__nav_6_5">
1653 Migrating from WCF 2.1
1654 <span class="md-nav__icon md-icon"></span>
1655 </label>
1656 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1657 <label class="md-nav__title" for="__nav_6_5">
1658 <span class="md-nav__icon md-icon"></span>
1659 Migrating from WCF 2.1
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/wcf21/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/wcf21/templates/" class="md-nav__link">
1681 Templates
1682 </a>
1683 </li>
1684
1685
1686
1687
1688
1689
1690
1691 <li class="md-nav__item">
1692 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1693 CSS
1694 </a>
1695 </li>
1696
1697
1698
1699
1700
1701
1702
1703 <li class="md-nav__item">
1704 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1705 Package Components
1706 </a>
1707 </li>
1708
1709
1710
1711 </ul>
1712 </nav>
1713 </li>
1714
1715
1716
1717 </ul>
1718 </nav>
1719 </li>
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731 <li class="md-nav__item md-nav__item--nested">
1732
1733
1734 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1735
1736 <label class="md-nav__link" for="__nav_7">
1737 Tutorials
1738 <span class="md-nav__icon md-icon"></span>
1739 </label>
1740 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1741 <label class="md-nav__title" for="__nav_7">
1742 <span class="md-nav__icon md-icon"></span>
1743 Tutorials
1744 </label>
1745 <ul class="md-nav__list" data-md-scrollfix>
1746
1747
1748
1749
1750
1751
1752 <li class="md-nav__item md-nav__item--nested">
1753
1754
1755 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1756
1757 <label class="md-nav__link" for="__nav_7_1">
1758 Tutorial Series
1759 <span class="md-nav__icon md-icon"></span>
1760 </label>
1761 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1762 <label class="md-nav__title" for="__nav_7_1">
1763 <span class="md-nav__icon md-icon"></span>
1764 Tutorial Series
1765 </label>
1766 <ul class="md-nav__list" data-md-scrollfix>
1767
1768
1769
1770
1771
1772 <li class="md-nav__item">
1773 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1774 Overview
1775 </a>
1776 </li>
1777
1778
1779
1780
1781
1782
1783
1784 <li class="md-nav__item">
1785 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1786 Part 1
1787 </a>
1788 </li>
1789
1790
1791
1792
1793
1794
1795
1796 <li class="md-nav__item">
1797 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1798 Part 2
1799 </a>
1800 </li>
1801
1802
1803
1804
1805
1806
1807
1808 <li class="md-nav__item">
1809 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1810 Part 3
1811 </a>
1812 </li>
1813
1814
1815
1816 </ul>
1817 </nav>
1818 </li>
1819
1820
1821
1822 </ul>
1823 </nav>
1824 </li>
1825
1826
1827
1828 </ul>
1829 </nav>
1830 </div>
1831 </div>
1832 </div>
1833
1834
1835
1836 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1837 <div class="md-sidebar__scrollwrap">
1838 <div class="md-sidebar__inner">
1839
1840 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1841
1842
1843
1844
1845
1846 <label class="md-nav__title" for="__toc">
1847 <span class="md-nav__icon md-icon"></span>
1848 Table of contents
1849 </label>
1850 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1851
1852 <li class="md-nav__item">
1853 <a href="#components" class="md-nav__link">
1854 Components
1855 </a>
1856
1857 <nav class="md-nav" aria-label="Components">
1858 <ul class="md-nav__list">
1859
1860 <li class="md-nav__item">
1861 <a href="#objectname" class="md-nav__link">
1862 &lt;objectname&gt;
1863 </a>
1864
1865 </li>
1866
1867 </ul>
1868 </nav>
1869
1870 </li>
1871
1872 <li class="md-nav__item">
1873 <a href="#example" class="md-nav__link">
1874 Example
1875 </a>
1876
1877 </li>
1878
1879 </ul>
1880
1881 </nav>
1882 </div>
1883 </div>
1884 </div>
1885
1886
1887 <div class="md-content" data-md-component="content">
1888 <article class="md-content__inner md-typeset">
1889
1890
1891 <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">
1892 <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>
1893 </a>
1894
1895
1896 <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>
1897 <p>Registers <code>wcf\system\SingletonFactory</code> objects to be accessible in templates.</p>
1898 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1899 <p>Each item is described as a <code>&lt;coreobject&gt;</code> element with the mandatory element <code>objectname</code>.</p>
1900 <h3 id="objectname"><code>&lt;objectname&gt;</code><a class="headerlink" href="#objectname" title="Permanent link">#</a></h3>
1901 <p>The fully qualified class name of the class.</p>
1902 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
1903 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
1904 <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>
1905 <span class="nt">&lt;import&gt;</span>
1906 <span class="nt">&lt;coreobject&gt;</span>
1907 <span class="nt">&lt;objectname&gt;</span>wcf\system\example\ExampleHandler<span class="nt">&lt;/objectname&gt;</span>
1908 <span class="nt">&lt;/coreobject&gt;</span>
1909 <span class="nt">&lt;/import&gt;</span>
1910 <span class="nt">&lt;/data&gt;</span>
1911 </code></pre></div>
1912 <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>
1913
1914
1915
1916
1917 <hr>
1918 <div class="md-source-date">
1919 <small>
1920
1921 Last update: 2021-01-08
1922
1923 </small>
1924 </div>
1925
1926
1927
1928
1929
1930
1931
1932
1933 </article>
1934 </div>
1935 </div>
1936
1937 </main>
1938
1939
1940 <footer class="md-footer">
1941
1942 <nav class="md-footer__inner md-grid" aria-label="Footer">
1943
1944 <a href="../clipboard-action/" class="md-footer__link md-footer__link--prev" rel="prev">
1945 <div class="md-footer__button md-icon">
1946 <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>
1947 </div>
1948 <div class="md-footer__title">
1949 <div class="md-ellipsis">
1950 <span class="md-footer__direction">
1951 Previous
1952 </span>
1953 clipboardAction
1954 </div>
1955 </div>
1956 </a>
1957
1958
1959 <a href="../cronjob/" class="md-footer__link md-footer__link--next" rel="next">
1960 <div class="md-footer__title">
1961 <div class="md-ellipsis">
1962 <span class="md-footer__direction">
1963 Next
1964 </span>
1965 cronjob
1966 </div>
1967 </div>
1968 <div class="md-footer__button md-icon">
1969 <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>
1970 </div>
1971 </a>
1972
1973 </nav>
1974
1975 <div class="md-footer-meta md-typeset">
1976 <div class="md-footer-meta__inner md-grid">
1977 <div class="md-footer-copyright">
1978
1979 <div class="md-footer-copyright__highlight">
1980 Copyright © 2020 WoltLab GmbH
1981 </div>
1982
1983 Made with
1984 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1985 Material for MkDocs
1986 </a>
1987
1988 </div>
1989 <div class="md-footer-copyright">
1990 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
1991 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
1992 </div>
1993 </div>
1994 </div>
1995 </footer>
1996
1997 </div>
1998 <div class="md-dialog" data-md-component="dialog">
1999 <div class="md-dialog__inner md-typeset"></div>
2000 </div>
2001 <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>
2002
2003
2004 <script src="../../../assets/javascripts/bundle.d892486b.min.js"></script>
2005
2006
2007 </body>
2008 </html>