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