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