5.4/view/template-plugins/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.3">
  14
  15
  16
  17         <title>Template Plugins - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.1655a90d.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       <link rel="stylesheet" href="../../stylesheets/extra.css">
  38
  39
  40
  41
  42
  43   </head>
  44
  45
  46
  47
  48
  49
  50
  51     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  52
  53
  54
  55     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  56     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  57     <label class="md-overlay" for="__drawer"></label>
  58     <div data-md-component="skip">
  59
  60
  61         <a href="#template-plugins" class="md-skip">
  62           Skip to content
  63         </a>
  64
  65     </div>
  66     <div data-md-component="announce">
  67
  68         <aside class="md-announce">
  69           <div class="md-announce__inner md-grid md-typeset">
  70
  71     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  72
  73           </div>
  74         </aside>
  75
  76     </div>
  77
  78
  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">
  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               Template Plugins
 101
 102           </span>
 103         </div>
 104       </div>
 105     </div>
 106     <div class="md-header__options">
 107
 108     </div>
 109
 110       <label class="md-header__button md-icon" for="__search">
 111         <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>
 112       </label>
 113
 114 <div class="md-search" data-md-component="search" role="dialog">
 115   <label class="md-search__overlay" for="__search"></label>
 116   <div class="md-search__inner" role="search">
 117     <form class="md-search__form" name="search">
 118       <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>
 119       <label class="md-search__icon md-icon" for="__search">
 120         <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>
 121         <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>
 122       </label>
 123       <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
 124         <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>
 125       </button>
 126     </form>
 127     <div class="md-search__output">
 128       <div class="md-search__scrollwrap" data-md-scrollfix>
 129         <div class="md-search-result" data-md-component="search-result">
 130           <div class="md-search-result__meta">
 131             Initializing search
 132           </div>
 133           <ol class="md-search-result__list"></ol>
 134         </div>
 135       </div>
 136     </div>
 137   </div>
 138 </div>
 139
 140
 141   </nav>
 142 </header>
 143
 144     <div class="md-container" data-md-component="container">
 145
 146
 147
 148
 149       <main class="md-main" data-md-component="main">
 150         <div class="md-main__inner md-grid">
 151
 152
 153
 154               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 155                 <div class="md-sidebar__scrollwrap">
 156                   <div class="md-sidebar__inner">
 157
 158
 159
 160
 161
 162 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 163   <label class="md-nav__title" for="__drawer">
 164     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 165
 166   <img src="../../assets/logo.png" alt="logo">
 167
 168     </a>
 169     WoltLab Suite Documentation
 170   </label>
 171
 172   <ul class="md-nav__list" data-md-scrollfix>
 173
 174
 175
 176
 177
 178
 179
 180
 181     <li class="md-nav__item">
 182       <a href="../../getting-started/" class="md-nav__link">
 183         Getting Started
 184       </a>
 185     </li>
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197     <li class="md-nav__item md-nav__item--nested">
 198
 199
 200         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
 201
 202       <label class="md-nav__link" for="__nav_2">
 203         PHP API
 204         <span class="md-nav__icon md-icon"></span>
 205       </label>
 206       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 207         <label class="md-nav__title" for="__nav_2">
 208           <span class="md-nav__icon md-icon"></span>
 209           PHP API
 210         </label>
 211         <ul class="md-nav__list" data-md-scrollfix>
 212
 213
 214
 215
 216
 217     <li class="md-nav__item">
 218       <a href="../../php/pages/" class="md-nav__link">
 219         Pages
 220       </a>
 221     </li>
 222
 223
 224
 225
 226
 227
 228
 229     <li class="md-nav__item">
 230       <a href="../../php/database-objects/" class="md-nav__link">
 231         Database Objects
 232       </a>
 233     </li>
 234
 235
 236
 237
 238
 239
 240
 241     <li class="md-nav__item">
 242       <a href="../../php/database-access/" class="md-nav__link">
 243         Database Access
 244       </a>
 245     </li>
 246
 247
 248
 249
 250
 251
 252
 253     <li class="md-nav__item">
 254       <a href="../../php/exceptions/" class="md-nav__link">
 255         Exceptions
 256       </a>
 257     </li>
 258
 259
 260
 261
 262
 263
 264
 265
 266     <li class="md-nav__item md-nav__item--nested">
 267
 268
 269         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 270
 271       <label class="md-nav__link" for="__nav_2_5">
 272         API
 273         <span class="md-nav__icon md-icon"></span>
 274       </label>
 275       <nav class="md-nav" aria-label="API" data-md-level="2">
 276         <label class="md-nav__title" for="__nav_2_5">
 277           <span class="md-nav__icon md-icon"></span>
 278           API
 279         </label>
 280         <ul class="md-nav__list" data-md-scrollfix>
 281
 282
 283
 284
 285
 286     <li class="md-nav__item">
 287       <a href="../../php/api/caches/" class="md-nav__link">
 288         Caches
 289       </a>
 290     </li>
 291
 292
 293
 294
 295
 296
 297
 298     <li class="md-nav__item">
 299       <a href="../../php/api/comments/" class="md-nav__link">
 300         Comments
 301       </a>
 302     </li>
 303
 304
 305
 306
 307
 308
 309
 310     <li class="md-nav__item">
 311       <a href="../../php/api/cronjobs/" class="md-nav__link">
 312         Cronjobs
 313       </a>
 314     </li>
 315
 316
 317
 318
 319
 320
 321
 322     <li class="md-nav__item">
 323       <a href="../../php/api/events/" class="md-nav__link">
 324         Events
 325       </a>
 326     </li>
 327
 328
 329
 330
 331
 332
 333
 334
 335     <li class="md-nav__item md-nav__item--nested">
 336
 337
 338         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 339
 340       <label class="md-nav__link" for="__nav_2_5_5">
 341         Form Builder
 342         <span class="md-nav__icon md-icon"></span>
 343       </label>
 344       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 345         <label class="md-nav__title" for="__nav_2_5_5">
 346           <span class="md-nav__icon md-icon"></span>
 347           Form Builder
 348         </label>
 349         <ul class="md-nav__list" data-md-scrollfix>
 350
 351
 352
 353
 354
 355     <li class="md-nav__item">
 356       <a href="../../php/api/form_builder/overview/" class="md-nav__link">
 357         Overview
 358       </a>
 359     </li>
 360
 361
 362
 363
 364
 365
 366
 367     <li class="md-nav__item">
 368       <a href="../../php/api/form_builder/structure/" class="md-nav__link">
 369         Structure
 370       </a>
 371     </li>
 372
 373
 374
 375
 376
 377
 378
 379     <li class="md-nav__item">
 380       <a href="../../php/api/form_builder/form_fields/" class="md-nav__link">
 381         Fields
 382       </a>
 383     </li>
 384
 385
 386
 387
 388
 389
 390
 391     <li class="md-nav__item">
 392       <a href="../../php/api/form_builder/validation_data/" class="md-nav__link">
 393         Validation and Data
 394       </a>
 395     </li>
 396
 397
 398
 399
 400
 401
 402
 403     <li class="md-nav__item">
 404       <a href="../../php/api/form_builder/dependencies/" class="md-nav__link">
 405         Dependencies
 406       </a>
 407     </li>
 408
 409
 410
 411         </ul>
 412       </nav>
 413     </li>
 414
 415
 416
 417
 418
 419
 420
 421     <li class="md-nav__item">
 422       <a href="../../php/api/package_installation_plugins/" class="md-nav__link">
 423         Package Installation Plugins
 424       </a>
 425     </li>
 426
 427
 428
 429
 430
 431
 432
 433     <li class="md-nav__item">
 434       <a href="../../php/api/user_activity_points/" class="md-nav__link">
 435         User Activity Points
 436       </a>
 437     </li>
 438
 439
 440
 441
 442
 443
 444
 445     <li class="md-nav__item">
 446       <a href="../../php/api/user_notifications/" class="md-nav__link">
 447         User Notifications
 448       </a>
 449     </li>
 450
 451
 452
 453
 454
 455
 456
 457     <li class="md-nav__item">
 458       <a href="../../php/api/sitemaps/" class="md-nav__link">
 459         Sitemaps
 460       </a>
 461     </li>
 462
 463
 464
 465         </ul>
 466       </nav>
 467     </li>
 468
 469
 470
 471
 472
 473
 474
 475     <li class="md-nav__item">
 476       <a href="../../php/code-style/" class="md-nav__link">
 477         Code Style
 478       </a>
 479     </li>
 480
 481
 482
 483
 484
 485
 486
 487     <li class="md-nav__item">
 488       <a href="../../php/apps/" class="md-nav__link">
 489         Apps
 490       </a>
 491     </li>
 492
 493
 494
 495
 496
 497
 498
 499     <li class="md-nav__item">
 500       <a href="../../php/gdpr/" class="md-nav__link">
 501         GDPR
 502       </a>
 503     </li>
 504
 505
 506
 507         </ul>
 508       </nav>
 509     </li>
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521     <li class="md-nav__item md-nav__item--nested">
 522
 523
 524         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 525
 526       <label class="md-nav__link" for="__nav_3">
 527         Languages, Templates & CSS
 528         <span class="md-nav__icon md-icon"></span>
 529       </label>
 530       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 531         <label class="md-nav__title" for="__nav_3">
 532           <span class="md-nav__icon md-icon"></span>
 533           Languages, Templates & CSS
 534         </label>
 535         <ul class="md-nav__list" data-md-scrollfix>
 536
 537
 538
 539
 540
 541     <li class="md-nav__item">
 542       <a href="../languages/" class="md-nav__link">
 543         Languages
 544       </a>
 545     </li>
 546
 547
 548
 549
 550
 551
 552
 553     <li class="md-nav__item">
 554       <a href="../templates/" class="md-nav__link">
 555         Templates
 556       </a>
 557     </li>
 558
 559
 560
 561
 562
 563
 564
 565     <li class="md-nav__item">
 566       <a href="../css/" class="md-nav__link">
 567         CSS
 568       </a>
 569     </li>
 570
 571
 572
 573         </ul>
 574       </nav>
 575     </li>
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587     <li class="md-nav__item md-nav__item--nested">
 588
 589
 590         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 591
 592       <label class="md-nav__link" for="__nav_4">
 593         JavaScript API
 594         <span class="md-nav__icon md-icon"></span>
 595       </label>
 596       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 597         <label class="md-nav__title" for="__nav_4">
 598           <span class="md-nav__icon md-icon"></span>
 599           JavaScript API
 600         </label>
 601         <ul class="md-nav__list" data-md-scrollfix>
 602
 603
 604
 605
 606
 607     <li class="md-nav__item">
 608       <a href="../../javascript/general-usage/" class="md-nav__link">
 609         General Usage
 610       </a>
 611     </li>
 612
 613
 614
 615
 616
 617
 618
 619
 620     <li class="md-nav__item md-nav__item--nested">
 621
 622
 623         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 624
 625       <label class="md-nav__link" for="__nav_4_2">
 626         New API
 627         <span class="md-nav__icon md-icon"></span>
 628       </label>
 629       <nav class="md-nav" aria-label="New API" data-md-level="2">
 630         <label class="md-nav__title" for="__nav_4_2">
 631           <span class="md-nav__icon md-icon"></span>
 632           New API
 633         </label>
 634         <ul class="md-nav__list" data-md-scrollfix>
 635
 636
 637
 638
 639
 640     <li class="md-nav__item">
 641       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 642         Writing a module
 643       </a>
 644     </li>
 645
 646
 647
 648
 649
 650
 651
 652     <li class="md-nav__item">
 653       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 654         Data Structures
 655       </a>
 656     </li>
 657
 658
 659
 660
 661
 662
 663
 664     <li class="md-nav__item">
 665       <a href="../../javascript/new-api_core/" class="md-nav__link">
 666         Core Functions
 667       </a>
 668     </li>
 669
 670
 671
 672
 673
 674
 675
 676     <li class="md-nav__item">
 677       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 678         DOM
 679       </a>
 680     </li>
 681
 682
 683
 684
 685
 686
 687
 688     <li class="md-nav__item">
 689       <a href="../../javascript/new-api_events/" class="md-nav__link">
 690         Event Handling
 691       </a>
 692     </li>
 693
 694
 695
 696
 697
 698
 699
 700     <li class="md-nav__item">
 701       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 702         Ajax
 703       </a>
 704     </li>
 705
 706
 707
 708
 709
 710
 711
 712     <li class="md-nav__item">
 713       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 714         Dialogs
 715       </a>
 716     </li>
 717
 718
 719
 720
 721
 722
 723
 724     <li class="md-nav__item">
 725       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 726         Browser and Screen Sizes
 727       </a>
 728     </li>
 729
 730
 731
 732
 733
 734
 735
 736     <li class="md-nav__item">
 737       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 738         User Interface
 739       </a>
 740     </li>
 741
 742
 743
 744         </ul>
 745       </nav>
 746     </li>
 747
 748
 749
 750
 751
 752
 753
 754     <li class="md-nav__item">
 755       <a href="../../javascript/legacy-api/" class="md-nav__link">
 756         Legacy API
 757       </a>
 758     </li>
 759
 760
 761
 762
 763
 764
 765
 766     <li class="md-nav__item">
 767       <a href="../../javascript/helper-functions/" class="md-nav__link">
 768         Helper Functions
 769       </a>
 770     </li>
 771
 772
 773
 774
 775
 776
 777
 778     <li class="md-nav__item">
 779       <a href="../../javascript/code-snippets/" class="md-nav__link">
 780         Code Snippets
 781       </a>
 782     </li>
 783
 784
 785
 786         </ul>
 787       </nav>
 788     </li>
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800     <li class="md-nav__item md-nav__item--nested">
 801
 802
 803         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 804
 805       <label class="md-nav__link" for="__nav_5">
 806         Package Components
 807         <span class="md-nav__icon md-icon"></span>
 808       </label>
 809       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 810         <label class="md-nav__title" for="__nav_5">
 811           <span class="md-nav__icon md-icon"></span>
 812           Package Components
 813         </label>
 814         <ul class="md-nav__list" data-md-scrollfix>
 815
 816
 817
 818
 819
 820     <li class="md-nav__item">
 821       <a href="../../package/package-xml/" class="md-nav__link">
 822         package.xml
 823       </a>
 824     </li>
 825
 826
 827
 828
 829
 830
 831
 832
 833     <li class="md-nav__item md-nav__item--nested">
 834
 835
 836         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
 837
 838       <label class="md-nav__link" for="__nav_5_2">
 839         PIPs
 840         <span class="md-nav__icon md-icon"></span>
 841       </label>
 842       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
 843         <label class="md-nav__title" for="__nav_5_2">
 844           <span class="md-nav__icon md-icon"></span>
 845           PIPs
 846         </label>
 847         <ul class="md-nav__list" data-md-scrollfix>
 848
 849
 850
 851
 852
 853     <li class="md-nav__item">
 854       <a href="../../package/pip/" class="md-nav__link">
 855         Overview
 856       </a>
 857     </li>
 858
 859
 860
 861
 862
 863
 864
 865     <li class="md-nav__item">
 866       <a href="../../package/pip/acl-option/" class="md-nav__link">
 867         aclOption
 868       </a>
 869     </li>
 870
 871
 872
 873
 874
 875
 876
 877     <li class="md-nav__item">
 878       <a href="../../package/pip/acp-menu/" class="md-nav__link">
 879         acpMenu
 880       </a>
 881     </li>
 882
 883
 884
 885
 886
 887
 888
 889     <li class="md-nav__item">
 890       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
 891         acpSearchProvider
 892       </a>
 893     </li>
 894
 895
 896
 897
 898
 899
 900
 901     <li class="md-nav__item">
 902       <a href="../../package/pip/acp-template/" class="md-nav__link">
 903         acpTemplate
 904       </a>
 905     </li>
 906
 907
 908
 909
 910
 911
 912
 913     <li class="md-nav__item">
 914       <a href="../../package/pip/bbcode/" class="md-nav__link">
 915         bbcode
 916       </a>
 917     </li>
 918
 919
 920
 921
 922
 923
 924
 925     <li class="md-nav__item">
 926       <a href="../../package/pip/box/" class="md-nav__link">
 927         box
 928       </a>
 929     </li>
 930
 931
 932
 933
 934
 935
 936
 937     <li class="md-nav__item">
 938       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
 939         clipboardAction
 940       </a>
 941     </li>
 942
 943
 944
 945
 946
 947
 948
 949     <li class="md-nav__item">
 950       <a href="../../package/pip/core-object/" class="md-nav__link">
 951         coreObject
 952       </a>
 953     </li>
 954
 955
 956
 957
 958
 959
 960
 961     <li class="md-nav__item">
 962       <a href="../../package/pip/cronjob/" class="md-nav__link">
 963         cronjob
 964       </a>
 965     </li>
 966
 967
 968
 969
 970
 971
 972
 973     <li class="md-nav__item">
 974       <a href="../../package/pip/event-listener/" class="md-nav__link">
 975         eventListener
 976       </a>
 977     </li>
 978
 979
 980
 981
 982
 983
 984
 985     <li class="md-nav__item">
 986       <a href="../../package/pip/file/" class="md-nav__link">
 987         file
 988       </a>
 989     </li>
 990
 991
 992
 993
 994
 995
 996
 997     <li class="md-nav__item">
 998       <a href="../../package/pip/language/" class="md-nav__link">
 999         language
1000       </a>
1001     </li>
1002
1003
1004
1005
1006
1007
1008
1009     <li class="md-nav__item">
1010       <a href="../../package/pip/media-provider/" class="md-nav__link">
1011         mediaProvider
1012       </a>
1013     </li>
1014
1015
1016
1017
1018
1019
1020
1021     <li class="md-nav__item">
1022       <a href="../../package/pip/menu/" class="md-nav__link">
1023         menu
1024       </a>
1025     </li>
1026
1027
1028
1029
1030
1031
1032
1033     <li class="md-nav__item">
1034       <a href="../../package/pip/menu-item/" class="md-nav__link">
1035         menuItem
1036       </a>
1037     </li>
1038
1039
1040
1041
1042
1043
1044
1045     <li class="md-nav__item">
1046       <a href="../../package/pip/object-type/" class="md-nav__link">
1047         objectType
1048       </a>
1049     </li>
1050
1051
1052
1053
1054
1055
1056
1057     <li class="md-nav__item">
1058       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1059         objectTypeDefinition
1060       </a>
1061     </li>
1062
1063
1064
1065
1066
1067
1068
1069     <li class="md-nav__item">
1070       <a href="../../package/pip/option/" class="md-nav__link">
1071         option
1072       </a>
1073     </li>
1074
1075
1076
1077
1078
1079
1080
1081     <li class="md-nav__item">
1082       <a href="../../package/pip/page/" class="md-nav__link">
1083         page
1084       </a>
1085     </li>
1086
1087
1088
1089
1090
1091
1092
1093     <li class="md-nav__item">
1094       <a href="../../package/pip/pip/" class="md-nav__link">
1095         pip
1096       </a>
1097     </li>
1098
1099
1100
1101
1102
1103
1104
1105     <li class="md-nav__item">
1106       <a href="../../package/pip/script/" class="md-nav__link">
1107         script
1108       </a>
1109     </li>
1110
1111
1112
1113
1114
1115
1116
1117     <li class="md-nav__item">
1118       <a href="../../package/pip/smiley/" class="md-nav__link">
1119         smiley
1120       </a>
1121     </li>
1122
1123
1124
1125
1126
1127
1128
1129     <li class="md-nav__item">
1130       <a href="../../package/pip/sql/" class="md-nav__link">
1131         sql
1132       </a>
1133     </li>
1134
1135
1136
1137
1138
1139
1140
1141     <li class="md-nav__item">
1142       <a href="../../package/pip/style/" class="md-nav__link">
1143         style
1144       </a>
1145     </li>
1146
1147
1148
1149
1150
1151
1152
1153     <li class="md-nav__item">
1154       <a href="../../package/pip/template/" class="md-nav__link">
1155         template
1156       </a>
1157     </li>
1158
1159
1160
1161
1162
1163
1164
1165     <li class="md-nav__item">
1166       <a href="../../package/pip/template-listener/" class="md-nav__link">
1167         templateListener
1168       </a>
1169     </li>
1170
1171
1172
1173
1174
1175
1176
1177     <li class="md-nav__item">
1178       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1179         userGroupOption
1180       </a>
1181     </li>
1182
1183
1184
1185
1186
1187
1188
1189     <li class="md-nav__item">
1190       <a href="../../package/pip/user-menu/" class="md-nav__link">
1191         userMenu
1192       </a>
1193     </li>
1194
1195
1196
1197
1198
1199
1200
1201     <li class="md-nav__item">
1202       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1203         userNotificationEvent
1204       </a>
1205     </li>
1206
1207
1208
1209
1210
1211
1212
1213     <li class="md-nav__item">
1214       <a href="../../package/pip/user-option/" class="md-nav__link">
1215         userOption
1216       </a>
1217     </li>
1218
1219
1220
1221
1222
1223
1224
1225     <li class="md-nav__item">
1226       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1227         userProfileMenu
1228       </a>
1229     </li>
1230
1231
1232
1233         </ul>
1234       </nav>
1235     </li>
1236
1237
1238
1239
1240
1241
1242
1243     <li class="md-nav__item">
1244       <a href="../../package/database-php-api/" class="md-nav__link">
1245         Database PHP API
1246       </a>
1247     </li>
1248
1249
1250
1251         </ul>
1252       </nav>
1253     </li>
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265     <li class="md-nav__item md-nav__item--nested">
1266
1267
1268         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1269
1270       <label class="md-nav__link" for="__nav_6">
1271         Migration
1272         <span class="md-nav__icon md-icon"></span>
1273       </label>
1274       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1275         <label class="md-nav__title" for="__nav_6">
1276           <span class="md-nav__icon md-icon"></span>
1277           Migration
1278         </label>
1279         <ul class="md-nav__list" data-md-scrollfix>
1280
1281
1282
1283
1284
1285
1286     <li class="md-nav__item md-nav__item--nested">
1287
1288
1289         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1290
1291       <label class="md-nav__link" for="__nav_6_1">
1292         Migrating from WSC 5.3
1293         <span class="md-nav__icon md-icon"></span>
1294       </label>
1295       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1296         <label class="md-nav__title" for="__nav_6_1">
1297           <span class="md-nav__icon md-icon"></span>
1298           Migrating from WSC 5.3
1299         </label>
1300         <ul class="md-nav__list" data-md-scrollfix>
1301
1302
1303
1304
1305
1306     <li class="md-nav__item">
1307       <a href="../../migration/wsc53/php/" class="md-nav__link">
1308         PHP API
1309       </a>
1310     </li>
1311
1312
1313
1314
1315
1316
1317
1318     <li class="md-nav__item">
1319       <a href="../../migration/wsc53/session/" class="md-nav__link">
1320         Session Handling and Authentication
1321       </a>
1322     </li>
1323
1324
1325
1326
1327
1328
1329
1330     <li class="md-nav__item">
1331       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1332         JavaScript
1333       </a>
1334     </li>
1335
1336
1337
1338
1339
1340
1341
1342     <li class="md-nav__item">
1343       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1344         Templates
1345       </a>
1346     </li>
1347
1348
1349
1350
1351
1352
1353
1354     <li class="md-nav__item">
1355       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1356         Third Party Libraries
1357       </a>
1358     </li>
1359
1360
1361
1362         </ul>
1363       </nav>
1364     </li>
1365
1366
1367
1368
1369
1370
1371
1372
1373     <li class="md-nav__item md-nav__item--nested">
1374
1375
1376         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1377
1378       <label class="md-nav__link" for="__nav_6_2">
1379         Migrating from WSC 5.2
1380         <span class="md-nav__icon md-icon"></span>
1381       </label>
1382       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1383         <label class="md-nav__title" for="__nav_6_2">
1384           <span class="md-nav__icon md-icon"></span>
1385           Migrating from WSC 5.2
1386         </label>
1387         <ul class="md-nav__list" data-md-scrollfix>
1388
1389
1390
1391
1392
1393     <li class="md-nav__item">
1394       <a href="../../migration/wsc52/php/" class="md-nav__link">
1395         PHP API
1396       </a>
1397     </li>
1398
1399
1400
1401
1402
1403
1404
1405     <li class="md-nav__item">
1406       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1407         Templates and Languages
1408       </a>
1409     </li>
1410
1411
1412
1413
1414
1415
1416
1417     <li class="md-nav__item">
1418       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1419         Third Party Libraries
1420       </a>
1421     </li>
1422
1423
1424
1425         </ul>
1426       </nav>
1427     </li>
1428
1429
1430
1431
1432
1433
1434
1435
1436     <li class="md-nav__item md-nav__item--nested">
1437
1438
1439         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1440
1441       <label class="md-nav__link" for="__nav_6_3">
1442         Migrating from WSC 3.1
1443         <span class="md-nav__icon md-icon"></span>
1444       </label>
1445       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1446         <label class="md-nav__title" for="__nav_6_3">
1447           <span class="md-nav__icon md-icon"></span>
1448           Migrating from WSC 3.1
1449         </label>
1450         <ul class="md-nav__list" data-md-scrollfix>
1451
1452
1453
1454
1455
1456     <li class="md-nav__item">
1457       <a href="../../migration/wsc31/php/" class="md-nav__link">
1458         PHP API
1459       </a>
1460     </li>
1461
1462
1463
1464         </ul>
1465       </nav>
1466     </li>
1467
1468
1469
1470
1471
1472
1473
1474
1475     <li class="md-nav__item md-nav__item--nested">
1476
1477
1478         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1479
1480       <label class="md-nav__link" for="__nav_6_4">
1481         Migrating from WSC 3.0
1482         <span class="md-nav__icon md-icon"></span>
1483       </label>
1484       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1485         <label class="md-nav__title" for="__nav_6_4">
1486           <span class="md-nav__icon md-icon"></span>
1487           Migrating from WSC 3.0
1488         </label>
1489         <ul class="md-nav__list" data-md-scrollfix>
1490
1491
1492
1493
1494
1495     <li class="md-nav__item">
1496       <a href="../../migration/wsc30/php/" class="md-nav__link">
1497         PHP API
1498       </a>
1499     </li>
1500
1501
1502
1503
1504
1505
1506
1507     <li class="md-nav__item">
1508       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1509         JavaScript API
1510       </a>
1511     </li>
1512
1513
1514
1515
1516
1517
1518
1519     <li class="md-nav__item">
1520       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1521         Templates
1522       </a>
1523     </li>
1524
1525
1526
1527
1528
1529
1530
1531     <li class="md-nav__item">
1532       <a href="../../migration/wsc30/css/" class="md-nav__link">
1533         CSS
1534       </a>
1535     </li>
1536
1537
1538
1539
1540
1541
1542
1543     <li class="md-nav__item">
1544       <a href="../../migration/wsc30/package/" class="md-nav__link">
1545         Package Components
1546       </a>
1547     </li>
1548
1549
1550
1551         </ul>
1552       </nav>
1553     </li>
1554
1555
1556
1557
1558
1559
1560
1561
1562     <li class="md-nav__item md-nav__item--nested">
1563
1564
1565         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1566
1567       <label class="md-nav__link" for="__nav_6_5">
1568         Migrating from WCF 2.1
1569         <span class="md-nav__icon md-icon"></span>
1570       </label>
1571       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1572         <label class="md-nav__title" for="__nav_6_5">
1573           <span class="md-nav__icon md-icon"></span>
1574           Migrating from WCF 2.1
1575         </label>
1576         <ul class="md-nav__list" data-md-scrollfix>
1577
1578
1579
1580
1581
1582     <li class="md-nav__item">
1583       <a href="../../migration/wcf21/php/" class="md-nav__link">
1584         PHP API
1585       </a>
1586     </li>
1587
1588
1589
1590
1591
1592
1593
1594     <li class="md-nav__item">
1595       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1596         Templates
1597       </a>
1598     </li>
1599
1600
1601
1602
1603
1604
1605
1606     <li class="md-nav__item">
1607       <a href="../../migration/wcf21/css/" class="md-nav__link">
1608         CSS
1609       </a>
1610     </li>
1611
1612
1613
1614
1615
1616
1617
1618     <li class="md-nav__item">
1619       <a href="../../migration/wcf21/package/" class="md-nav__link">
1620         Package Components
1621       </a>
1622     </li>
1623
1624
1625
1626         </ul>
1627       </nav>
1628     </li>
1629
1630
1631
1632         </ul>
1633       </nav>
1634     </li>
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646     <li class="md-nav__item md-nav__item--nested">
1647
1648
1649         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1650
1651       <label class="md-nav__link" for="__nav_7">
1652         Tutorials
1653         <span class="md-nav__icon md-icon"></span>
1654       </label>
1655       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1656         <label class="md-nav__title" for="__nav_7">
1657           <span class="md-nav__icon md-icon"></span>
1658           Tutorials
1659         </label>
1660         <ul class="md-nav__list" data-md-scrollfix>
1661
1662
1663
1664
1665
1666
1667     <li class="md-nav__item md-nav__item--nested">
1668
1669
1670         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1671
1672       <label class="md-nav__link" for="__nav_7_1">
1673         Tutorial Series
1674         <span class="md-nav__icon md-icon"></span>
1675       </label>
1676       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1677         <label class="md-nav__title" for="__nav_7_1">
1678           <span class="md-nav__icon md-icon"></span>
1679           Tutorial Series
1680         </label>
1681         <ul class="md-nav__list" data-md-scrollfix>
1682
1683
1684
1685
1686
1687     <li class="md-nav__item">
1688       <a href="../../tutorial/series/overview/" class="md-nav__link">
1689         Overview
1690       </a>
1691     </li>
1692
1693
1694
1695
1696
1697
1698
1699     <li class="md-nav__item">
1700       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1701         Part 1
1702       </a>
1703     </li>
1704
1705
1706
1707
1708
1709
1710
1711     <li class="md-nav__item">
1712       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1713         Part 2
1714       </a>
1715     </li>
1716
1717
1718
1719
1720
1721
1722
1723     <li class="md-nav__item">
1724       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1725         Part 3
1726       </a>
1727     </li>
1728
1729
1730
1731         </ul>
1732       </nav>
1733     </li>
1734
1735
1736
1737         </ul>
1738       </nav>
1739     </li>
1740
1741
1742
1743   </ul>
1744 </nav>
1745                   </div>
1746                 </div>
1747               </div>
1748
1749
1750
1751               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1752                 <div class="md-sidebar__scrollwrap">
1753                   <div class="md-sidebar__inner">
1754
1755 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1756
1757
1758
1759
1760
1761     <label class="md-nav__title" for="__toc">
1762       <span class="md-nav__icon md-icon"></span>
1763       Table of contents
1764     </label>
1765     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1766
1767         <li class="md-nav__item">
1768   <a href="#53-anchor" class="md-nav__link">
1769     5.3+ anchor
1770   </a>
1771
1772 </li>
1773
1774         <li class="md-nav__item">
1775   <a href="#53-anchorattributes" class="md-nav__link">
1776     5.3+ anchorAttributes
1777   </a>
1778
1779 </li>
1780
1781         <li class="md-nav__item">
1782   <a href="#append" class="md-nav__link">
1783     append
1784   </a>
1785
1786 </li>
1787
1788         <li class="md-nav__item">
1789   <a href="#assign" class="md-nav__link">
1790     assign
1791   </a>
1792
1793 </li>
1794
1795         <li class="md-nav__item">
1796   <a href="#capture" class="md-nav__link">
1797     capture
1798   </a>
1799
1800 </li>
1801
1802         <li class="md-nav__item">
1803   <a href="#concat" class="md-nav__link">
1804     concat
1805   </a>
1806
1807 </li>
1808
1809         <li class="md-nav__item">
1810   <a href="#counter" class="md-nav__link">
1811     counter
1812   </a>
1813
1814 </li>
1815
1816         <li class="md-nav__item">
1817   <a href="#54-csrftoken" class="md-nav__link">
1818     5.4+ csrfToken
1819   </a>
1820
1821 </li>
1822
1823         <li class="md-nav__item">
1824   <a href="#currency" class="md-nav__link">
1825     currency
1826   </a>
1827
1828 </li>
1829
1830         <li class="md-nav__item">
1831   <a href="#cycle" class="md-nav__link">
1832     cycle
1833   </a>
1834
1835 </li>
1836
1837         <li class="md-nav__item">
1838   <a href="#date" class="md-nav__link">
1839     date
1840   </a>
1841
1842 </li>
1843
1844         <li class="md-nav__item">
1845   <a href="#31-dateinterval" class="md-nav__link">
1846     3.1+ dateInterval
1847   </a>
1848
1849 </li>
1850
1851         <li class="md-nav__item">
1852   <a href="#encodejs" class="md-nav__link">
1853     encodeJS
1854   </a>
1855
1856 </li>
1857
1858         <li class="md-nav__item">
1859   <a href="#encodejson" class="md-nav__link">
1860     encodeJSON
1861   </a>
1862
1863 </li>
1864
1865         <li class="md-nav__item">
1866   <a href="#escapecdata" class="md-nav__link">
1867     escapeCDATA
1868   </a>
1869
1870 </li>
1871
1872         <li class="md-nav__item">
1873   <a href="#event" class="md-nav__link">
1874     event
1875   </a>
1876
1877 </li>
1878
1879         <li class="md-nav__item">
1880   <a href="#fetch" class="md-nav__link">
1881     fetch
1882   </a>
1883
1884 </li>
1885
1886         <li class="md-nav__item">
1887   <a href="#filesizebinary" class="md-nav__link">
1888     filesizeBinary
1889   </a>
1890
1891 </li>
1892
1893         <li class="md-nav__item">
1894   <a href="#filesize" class="md-nav__link">
1895     filesize
1896   </a>
1897
1898 </li>
1899
1900         <li class="md-nav__item">
1901   <a href="#hascontent" class="md-nav__link">
1902     hascontent
1903   </a>
1904
1905 </li>
1906
1907         <li class="md-nav__item">
1908   <a href="#htmlcheckboxes" class="md-nav__link">
1909     htmlCheckboxes
1910   </a>
1911
1912 </li>
1913
1914         <li class="md-nav__item">
1915   <a href="#htmloptions" class="md-nav__link">
1916     htmlOptions
1917   </a>
1918
1919 </li>
1920
1921         <li class="md-nav__item">
1922   <a href="#implode" class="md-nav__link">
1923     implode
1924   </a>
1925
1926 </li>
1927
1928         <li class="md-nav__item">
1929   <a href="#52-ipsearch" class="md-nav__link">
1930     5.2+ ipSearch
1931   </a>
1932
1933 </li>
1934
1935         <li class="md-nav__item">
1936   <a href="#30-js" class="md-nav__link">
1937     3.0+ js
1938   </a>
1939
1940 </li>
1941
1942         <li class="md-nav__item">
1943   <a href="#53-jslang" class="md-nav__link">
1944     5.3+ jslang
1945   </a>
1946
1947 </li>
1948
1949         <li class="md-nav__item">
1950   <a href="#lang" class="md-nav__link">
1951     lang
1952   </a>
1953
1954 </li>
1955
1956         <li class="md-nav__item">
1957   <a href="#language" class="md-nav__link">
1958     language
1959   </a>
1960
1961 </li>
1962
1963         <li class="md-nav__item">
1964   <a href="#link" class="md-nav__link">
1965     link
1966   </a>
1967
1968 </li>
1969
1970         <li class="md-nav__item">
1971   <a href="#newlinetobreak" class="md-nav__link">
1972     newlineToBreak
1973   </a>
1974
1975 </li>
1976
1977         <li class="md-nav__item">
1978   <a href="#30-page" class="md-nav__link">
1979     3.0+ page
1980   </a>
1981
1982 </li>
1983
1984         <li class="md-nav__item">
1985   <a href="#pages" class="md-nav__link">
1986     pages
1987   </a>
1988
1989 </li>
1990
1991         <li class="md-nav__item">
1992   <a href="#plaintime" class="md-nav__link">
1993     plainTime
1994   </a>
1995
1996 </li>
1997
1998         <li class="md-nav__item">
1999   <a href="#53-plural" class="md-nav__link">
2000     5.3+ plural
2001   </a>
2002
2003 </li>
2004
2005         <li class="md-nav__item">
2006   <a href="#prepend" class="md-nav__link">
2007     prepend
2008   </a>
2009
2010 </li>
2011
2012         <li class="md-nav__item">
2013   <a href="#shortunit" class="md-nav__link">
2014     shortUnit
2015   </a>
2016
2017 </li>
2018
2019         <li class="md-nav__item">
2020   <a href="#smallpages" class="md-nav__link">
2021     smallpages
2022   </a>
2023
2024 </li>
2025
2026         <li class="md-nav__item">
2027   <a href="#tablewordwrap" class="md-nav__link">
2028     tableWordwrap
2029   </a>
2030
2031 </li>
2032
2033         <li class="md-nav__item">
2034   <a href="#time" class="md-nav__link">
2035     time
2036   </a>
2037
2038 </li>
2039
2040         <li class="md-nav__item">
2041   <a href="#truncate" class="md-nav__link">
2042     truncate
2043   </a>
2044
2045 </li>
2046
2047         <li class="md-nav__item">
2048   <a href="#53-user" class="md-nav__link">
2049     5.3+ user
2050   </a>
2051
2052 </li>
2053
2054     </ul>
2055
2056 </nav>
2057                   </div>
2058                 </div>
2059               </div>
2060
2061
2062           <div class="md-content" data-md-component="content">
2063             <article class="md-content__inner md-typeset">
2064
2065
2066
2067                 <h1 id="template-plugins">Template Plugins<a class="headerlink" href="#template-plugins" title="Permanent link">#</a></h1>
2068 <h2 id="53-anchor"><span class="label label-info">5.3+</span> <code>anchor</code><a class="headerlink" href="#53-anchor" title="Permanent link">#</a></h2>
2069 <p>The <code>anchor</code> template plugin creates <code>a</code> HTML elements.
2070 The easiest way to use the template plugin is to pass it an instance of <code>ITitledLinkObject</code>:</p>
2071 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$object</span><span class="cp">}</span><span class="x"></span>
2072 </code></pre></div>
2073
2074 <p>generates the same output as</p>
2075 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot;&gt;</span><span class="cp">{</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getTitle</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2076 </code></pre></div>
2077
2078 <p>Instead of an <code>object</code> parameter, a <code>link</code> and <code>content</code> parameter can be used:</p>
2079 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">link</span><span class="o">=</span><span class="nv">$linkObject</span> <span class="na">content</span><span class="o">=</span><span class="nv">$content</span><span class="cp">}</span><span class="x"></span>
2080 </code></pre></div>
2081
2082 <p>where <code>$linkObject</code> implements <code>ILinkableObject</code> and <code>$content</code> is either an object implementing <code>ITitledObject</code> or having a <code>__toString()</code> method or <code>$content</code> is a string or a number.</p>
2083 <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p>
2084 <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, expect for <code>href</code> which is disallowed, are added as attributes to the anchor element.</p>
2085 <p>If an <code>object</code> attribute is present, the object also implements <code>IPopoverObject</code> and if the return value of <code>IPopoverObject::getPopoverLinkClass()</code> is included in the <code>class</code> attribute of the <code>anchor</code> tag, <code>data-object-id</code> is automatically added.
2086 This functionality makes it easy to generate links with popover support.
2087 Instead of</p>
2088 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; class=&quot;blogEntryLink&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">entryID</span><span class="cp">}</span><span class="x">&quot;&gt;</span><span class="cp">{</span><span class="nv">$entry</span><span class="o">-&gt;</span><span class="na">subject</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2089 </code></pre></div>
2090
2091 <p>using</p>
2092 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">anchor</span> <span class="na">object</span><span class="o">=</span><span class="nv">$entry</span> <span class="na">class</span><span class="o">=</span><span class="s1">&#39;blogEntryLink&#39;</span><span class="cp">}</span><span class="x"></span>
2093 </code></pre></div>
2094
2095 <p>is sufficient if <code>Entry::getPopoverLinkClass()</code> returns <code>blogEntryLink</code>.</p>
2096 <h2 id="53-anchorattributes"><span class="label label-info">5.3+</span> <code>anchorAttributes</code><a class="headerlink" href="#53-anchorattributes" title="Permanent link">#</a></h2>
2097 <p><code>anchorAttributes</code> compliments the <code>StringUtil::getAnchorTagAttributes(string, bool): string</code> method.
2098 It allows to easily generate the necessary attributes for an anchor tag based off the destination URL.</p>
2099 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;https://www.example.com&quot; </span><span class="cp">{</span><span class="nf">anchorAttributes</span> <span class="na">url</span><span class="o">=</span><span class="s1">&#39;https://www.example.com&#39;</span> <span class="na">appendHref</span><span class="o">=</span><span class="kc">false</span> <span class="na">appendClassname</span><span class="o">=</span><span class="kc">true</span> <span class="na">isUgc</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">&gt;</span>
2100 </code></pre></div>
2101
2102 <table>
2103 <thead>
2104 <tr>
2105 <th>Attribute</th>
2106 <th>Description</th>
2107 </tr>
2108 </thead>
2109 <tbody>
2110 <tr>
2111 <td><code>url</code></td>
2112 <td>destination URL</td>
2113 </tr>
2114 <tr>
2115 <td><code>appendHref</code></td>
2116 <td>whether the <code>href</code> attribute should be generated; <code>true</code> by default</td>
2117 </tr>
2118 <tr>
2119 <td><code>isUgc</code></td>
2120 <td>whether the <code>rel="ugc"</code> attribute should be generated; <code>false</code> by default</td>
2121 </tr>
2122 <tr>
2123 <td><code>appendClassname</code></td>
2124 <td>whether the <code>class="externalURL"</code> attribute should be generated; <code>true</code> by default</td>
2125 </tr>
2126 </tbody>
2127 </table>
2128 <h2 id="append"><code>append</code><a class="headerlink" href="#append" title="Permanent link">#</a></h2>
2129 <p>If a string should be appended to the value of a variable, <code>append</code> can be used:</p>
2130 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2131
2132 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2133
2134 <span class="cp">{</span><span class="nf">append</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;2&#39;</span><span class="cp">}</span><span class="x"></span>
2135
2136 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints &#39;newValue2 *</span><span class="cp">}</span><span class="x"></span>
2137 </code></pre></div>
2138
2139 <p>If the variables does not exist yet, <code>append</code> creates a new one with the given value.
2140 If <code>append</code> is used on an array as the variable, the value is appended to all elements of the array.</p>
2141 <h2 id="assign"><code>assign</code><a class="headerlink" href="#assign" title="Permanent link">#</a></h2>
2142 <p>New template variables can be declared and new values can be assigned to existing template variables using <code>assign</code>:</p>
2143 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2144
2145 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2146 </code></pre></div>
2147
2148 <h2 id="capture"><code>capture</code><a class="headerlink" href="#capture" title="Permanent link">#</a></h2>
2149 <p>In some situations, <code>assign</code> is not sufficient to assign values to variables in templates if the value is complex.
2150 Instead, <code>capture</code> can be used:</p>
2151 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">capture</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span><span class="cp">}</span><span class="x"></span>
2152 <span class="x">    </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span><span class="cp">}</span><span class="x"></span>
2153 <span class="x">        &lt;p&gt;</span><span class="cp">{</span><span class="nv">$bar</span><span class="cp">}</span><span class="x">&lt;/p&gt;</span>
2154 <span class="x">    </span><span class="cp">{</span><span class="nf">else</span><span class="cp">}</span><span class="x"></span>
2155 <span class="x">        &lt;small&gt;</span><span class="cp">{</span><span class="nv">$baz</span><span class="cp">}</span><span class="x">&lt;/small&gt;</span>
2156 <span class="x">    </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2157 <span class="cp">{</span><span class="nf">/capture</span><span class="cp">}</span><span class="x"></span>
2158 </code></pre></div>
2159
2160 <h2 id="concat"><code>concat</code><a class="headerlink" href="#concat" title="Permanent link">#</a></h2>
2161 <p><code>concat</code> is a modifier used to concatenate multiple strings:</p>
2162 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="cp">}</span><span class="x"></span>
2163
2164 <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="o">|</span><span class="na">concat</span><span class="o">:</span><span class="nv">$foo</span><span class="cp">}</span><span class="x"></span>
2165
2166 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;foobar *</span><span class="cp">}</span><span class="x"></span>
2167 </code></pre></div>
2168
2169 <h2 id="counter"><code>counter</code><a class="headerlink" href="#counter" title="Permanent link">#</a></h2>
2170 <p><code>counter</code> can be used to generate and optionally print a counter:</p>
2171 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;1&#39; *</span><span class="cp">}</span><span class="x"></span>
2172
2173 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;2&#39; now *</span><span class="cp">}</span><span class="x"></span>
2174
2175 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints nothing, but counter value is &#39;3&#39; now internally *</span><span class="cp">}</span><span class="x"></span>
2176
2177 <span class="cp">{</span><span class="nf">counter</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCounter</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;4&#39; *</span><span class="cp">}</span><span class="x"></span>
2178 </code></pre></div>
2179
2180 <p>Counter supports the following attributes:</p>
2181 <table>
2182 <thead>
2183 <tr>
2184 <th>Attribute</th>
2185 <th>Description</th>
2186 </tr>
2187 </thead>
2188 <tbody>
2189 <tr>
2190 <td><code>assign</code></td>
2191 <td>optional name of the template variable the current counter value is assigned to</td>
2192 </tr>
2193 <tr>
2194 <td><code>direction</code></td>
2195 <td>counting direction, either <code>up</code> or <code>down</code>; <code>up</code> by default</td>
2196 </tr>
2197 <tr>
2198 <td><code>name</code></td>
2199 <td>name of the counter, relevant if multiple counters are used simultaneously</td>
2200 </tr>
2201 <tr>
2202 <td><code>print</code></td>
2203 <td>if <code>true</code>, the current counter value is printed; <code>false</code> by default</td>
2204 </tr>
2205 <tr>
2206 <td><code>skip</code></td>
2207 <td>positive counting increment; <code>1</code> by default</td>
2208 </tr>
2209 <tr>
2210 <td><code>start</code></td>
2211 <td>start counter value; <code>1</code> by default</td>
2212 </tr>
2213 </tbody>
2214 </table>
2215 <h2 id="54-csrftoken"><span class="label label-info">5.4+</span> <code>csrfToken</code><a class="headerlink" href="#54-csrftoken" title="Permanent link">#</a></h2>
2216 <p><code>{csrfToken}</code> prints out the session's CSRF token (“Security Token”).</p>
2217 <div class="highlight"><pre><span></span><code><span class="x">&lt;form action=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s2">&quot;Foo&quot;</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot; method=&quot;post&quot;&gt;</span>
2218 <span class="x">    </span><span class="cp">{</span><span class="c">* snip *</span><span class="cp">}</span><span class="x"></span>
2219
2220 <span class="x">    </span><span class="cp">{</span><span class="nf">csrfToken</span><span class="cp">}</span><span class="x"></span>
2221 <span class="x">&lt;/form&gt;</span>
2222 </code></pre></div>
2223
2224 <p>The <code>{csrfToken}</code> template plugin supports a <code>type</code> parameter.
2225 Specifying this parameter might be required in rare situations.
2226 Please <a href="https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/template/plugin/CsrfTokenFunctionTemplatePlugin.class.php">check the implementation</a> for details.</p>
2227 <h2 id="currency"><code>currency</code><a class="headerlink" href="#currency" title="Permanent link">#</a></h2>
2228 <p><code>currency</code> is a modifier used to format currency values with two decimals using language dependent thousands separators and decimal point:</p>
2229 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">currencyValue</span> <span class="na">value</span><span class="o">=</span><span class="m">12.345</span><span class="cp">}</span><span class="x"></span>
2230
2231 <span class="cp">{</span><span class="nv">$currencyValue</span><span class="o">|</span><span class="na">currency</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;12.34&#39; *</span><span class="cp">}</span><span class="x"></span>
2232 </code></pre></div>
2233
2234 <h2 id="cycle"><code>cycle</code><a class="headerlink" href="#cycle" title="Permanent link">#</a></h2>
2235 <p><code>cycle</code> can be used to cycle between different values:</p>
2236 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">values</span><span class="o">=</span><span class="s1">&#39;bar,baz&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;bar&#39; *</span><span class="cp">}</span><span class="x"></span>
2237
2238 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;baz&#39; *</span><span class="cp">}</span><span class="x"></span>
2239
2240 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span> <span class="na">advance</span><span class="o">=</span><span class="kc">false</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;baz&#39; again *</span><span class="cp">}</span><span class="x"></span>
2241
2242 <span class="cp">{</span><span class="nf">cycle</span> <span class="na">name</span><span class="o">=</span><span class="na">fooCycle</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;bar&#39; *</span><span class="cp">}</span><span class="x"></span>
2243 </code></pre></div>
2244
2245 <div class="admonition info">
2246 <p class="admonition-title">The values attribute only has to be present for the first call. If <code>cycle</code> is used in a loop, the presence of the same values in consecutive calls has no effect. Only once the values change, the cycle is reset.</p>
2247 </div>
2248 <table>
2249 <thead>
2250 <tr>
2251 <th>Attribute</th>
2252 <th>Description</th>
2253 </tr>
2254 </thead>
2255 <tbody>
2256 <tr>
2257 <td><code>advance</code></td>
2258 <td>if <code>true</code>, the current cycle value is advanced to the next value; <code>true</code> by default</td>
2259 </tr>
2260 <tr>
2261 <td><code>assign</code></td>
2262 <td>optional name of the template variable the current cycle value is assigned to; if used, <code>print</code> is set to <code>false</code></td>
2263 </tr>
2264 <tr>
2265 <td><code>delimiter</code></td>
2266 <td>delimiter between the different cycle values; <code>,</code> by default</td>
2267 </tr>
2268 <tr>
2269 <td><code>name</code></td>
2270 <td>name of the cycle, relevant if multiple cycles are used simultaneously</td>
2271 </tr>
2272 <tr>
2273 <td><code>print</code></td>
2274 <td>if <code>true</code>, the current cycle value is printed, <code>false</code> by default</td>
2275 </tr>
2276 <tr>
2277 <td><code>reset</code></td>
2278 <td>if <code>true</code>, the current cycle value is set to the first value, <code>false</code> by default</td>
2279 </tr>
2280 <tr>
2281 <td><code>values</code></td>
2282 <td>string containing the different cycles values, also see <code>delimiter</code></td>
2283 </tr>
2284 </tbody>
2285 </table>
2286 <h2 id="date"><code>date</code><a class="headerlink" href="#date" title="Permanent link">#</a></h2>
2287 <p><code>date</code> generated a formatted date using <code>wcf\util\DateUtil::format()</code> with <code>DateUtil::DATE_FORMAT</code> internally.</p>
2288 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">date</span><span class="cp">}</span><span class="x"></span>
2289 </code></pre></div>
2290
2291 <h2 id="31-dateinterval"><span class="label label-info">3.1+</span> <code>dateInterval</code><a class="headerlink" href="#31-dateinterval" title="Permanent link">#</a></h2>
2292 <p><code>dateInterval</code> calculates the difference between two unix timestamps and generated a textual date interval.</p>
2293 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">dateInterval</span> <span class="na">start</span><span class="o">=</span><span class="nv">$startTimestamp</span> <span class="na">end</span><span class="o">=</span><span class="nv">$endTimestamp</span> <span class="na">full</span><span class="o">=</span><span class="kc">true</span> <span class="na">format</span><span class="o">=</span><span class="s1">&#39;sentence&#39;</span><span class="cp">}</span><span class="x"></span>
2294 </code></pre></div>
2295
2296 <table>
2297 <thead>
2298 <tr>
2299 <th>Attribute</th>
2300 <th>Description</th>
2301 </tr>
2302 </thead>
2303 <tbody>
2304 <tr>
2305 <td><code>end</code></td>
2306 <td>end of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td>
2307 </tr>
2308 <tr>
2309 <td><code>format</code></td>
2310 <td>output format, either <code>default</code>, <code>sentence</code>, or <code>plain</code>; defaults to <code>default</code>, see <code>wcf\util\DateUtil::FORMAT_*</code> constants</td>
2311 </tr>
2312 <tr>
2313 <td><code>full</code></td>
2314 <td>if <code>true</code>, full difference in minutes is shown; if <code>false</code>, only the longest time interval is shown; <code>false</code> by default</td>
2315 </tr>
2316 <tr>
2317 <td><code>start</code></td>
2318 <td>start of the time interval; current timestamp by default (though either <code>start</code> or <code>end</code> has to be set)</td>
2319 </tr>
2320 </tbody>
2321 </table>
2322 <h2 id="encodejs"><code>encodeJS</code><a class="headerlink" href="#encodejs" title="Permanent link">#</a></h2>
2323 <p><code>encodeJS</code> encodes a string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>\'</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.</p>
2324 <div class="highlight"><pre><span></span><code><span class="x">&lt;script&gt;</span>
2325 <span class="x">    var foo = &#39;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJS</span><span class="cp">}</span><span class="x">&#39;;</span>
2326 <span class="x">&lt;/script&gt;</span>
2327 </code></pre></div>
2328
2329 <h2 id="encodejson"><code>encodeJSON</code><a class="headerlink" href="#encodejson" title="Permanent link">#</a></h2>
2330 <p><code>encodeJSON</code> encodes a JSON string to be used as a single-quoted string in JavaScript by replacing <code>\\</code> with <code>\\\\</code>, <code>'</code> with <code>&amp;#39;</code>, linebreaks with <code>\n</code>, and <code>/</code> with <code>\/</code>.
2331 Additionally, <code>htmlspecialchars</code> is applied to the string.</p>
2332 <div class="highlight"><pre><span></span><code><span class="x">&#39;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeJSON</span><span class="cp">}</span><span class="x">&#39;</span>
2333 </code></pre></div>
2334
2335 <h2 id="escapecdata"><code>escapeCDATA</code><a class="headerlink" href="#escapecdata" title="Permanent link">#</a></h2>
2336 <p><code>escapeCDATA</code> encodes a string to be used in a <code>CDATA</code> element by replacing <code>]]&gt;</code> with <code>]]]]&gt;&lt;![CDATA[&gt;</code>.</p>
2337 <div class="highlight"><pre><span></span><code><span class="x">&lt;![CDATA[</span><span class="cp">{</span><span class="o">@</span><span class="nv">$foo</span><span class="o">|</span><span class="na">encodeCDATA</span><span class="cp">}</span><span class="x">]]&gt;</span>
2338 </code></pre></div>
2339
2340 <h2 id="event"><code>event</code><a class="headerlink" href="#event" title="Permanent link">#</a></h2>
2341 <p><code>event</code> provides extension points in templates that <a href="../../package/pip/template-listener/">template listeners</a> can use.</p>
2342 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span><span class="cp">}</span><span class="x"></span>
2343 </code></pre></div>
2344
2345 <h2 id="fetch"><code>fetch</code><a class="headerlink" href="#fetch" title="Permanent link">#</a></h2>
2346 <p><code>fetch</code> fetches the contents of a file using <code>file_get_contents</code>.</p>
2347 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;foo.html&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints the contents of `foo.html` *</span><span class="cp">}</span><span class="x"></span>
2348
2349 <span class="cp">{</span><span class="nf">fetch</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;bar.html&#39;</span> <span class="na">assign</span><span class="o">=</span><span class="na">bar</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* assigns the contents of `foo.html` to `$bar`; does not print the contents *</span><span class="cp">}</span><span class="x"></span>
2350 </code></pre></div>
2351
2352 <h2 id="filesizebinary"><code>filesizeBinary</code><a class="headerlink" href="#filesizebinary" title="Permanent link">#</a></h2>
2353 <p><code>filesizeBinary</code> formats the filesize using binary filesize (in bytes).</p>
2354 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesizeBinary</span><span class="cp">}</span><span class="x"></span>
2355 </code></pre></div>
2356
2357 <h2 id="filesize"><code>filesize</code><a class="headerlink" href="#filesize" title="Permanent link">#</a></h2>
2358 <p><code>filesize</code> formats the filesize using filesize (in bytes).</p>
2359 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$filesize</span><span class="o">|</span><span class="na">filesize</span><span class="cp">}</span><span class="x"></span>
2360 </code></pre></div>
2361
2362 <h2 id="hascontent"><code>hascontent</code><a class="headerlink" href="#hascontent" title="Permanent link">#</a></h2>
2363 <p>In many cases, conditional statements can be used to determine if a certain section of a template is shown:</p>
2364 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2365 <span class="x">    only shown if $foo is bar</span>
2366 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2367 </code></pre></div>
2368
2369 <p>In some situations, however, such conditional statements are not sufficient.
2370 One prominent example is a template event:</p>
2371 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2372 <span class="x">    &lt;ul&gt;</span>
2373 <span class="x">        </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2374 <span class="x">            &lt;li&gt;Bar&lt;/li&gt;</span>
2375 <span class="x">        </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2376
2377 <span class="x">        </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;listItems&#39;</span><span class="cp">}</span><span class="x"></span>
2378 <span class="x">    &lt;/li&gt;</span>
2379 <span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2380 </code></pre></div>
2381
2382 <p>In this example, if <code>$foo !== 'bar'</code>, the list will not be shown, regardless of the additional template code provided by template listeners.
2383 In such a situation, <code>hascontent</code> has to be used:</p>
2384 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2385 <span class="x">    &lt;ul&gt;</span>
2386 <span class="x">        </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span>
2387 <span class="x">            </span><span class="cp">{</span><span class="nf">if</span> <span class="nv">$foo</span> <span class="o">===</span> <span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2388 <span class="x">                &lt;li&gt;Bar&lt;/li&gt;</span>
2389 <span class="x">            </span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x"></span>
2390
2391 <span class="x">            </span><span class="cp">{</span><span class="nf">event</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;listItems&#39;</span><span class="cp">}</span><span class="x"></span>
2392 <span class="x">        </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2393 <span class="x">    &lt;/ul&gt;</span>
2394 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2395 </code></pre></div>
2396
2397 <p>If the part of the template wrapped in the <code>content</code> tags has any (trimmed) content, the part of the template wrapped by <code>hascontent</code> tags is shown (including the part wrapped by the <code>content</code> tags), otherwise nothing is shown.
2398 Thus, this construct avoids an empty list compared to the <code>if</code> solution above.</p>
2399 <p>Like <code>foreach</code>, <code>hascontent</code> also supports an <code>else</code> part:</p>
2400 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">hascontent</span><span class="cp">}</span><span class="x"></span>
2401 <span class="x">    &lt;ul&gt;</span>
2402 <span class="x">        </span><span class="cp">{</span><span class="nf">content</span><span class="cp">}</span><span class="x"></span>
2403 <span class="x">            </span><span class="cp">{</span><span class="c">* … *</span><span class="cp">}</span><span class="x"></span>
2404 <span class="x">        </span><span class="cp">{</span><span class="nf">/content</span><span class="cp">}</span><span class="x"></span>
2405 <span class="x">    &lt;/ul&gt;</span>
2406 <span class="cp">{</span><span class="nf">hascontentelse</span><span class="cp">}</span><span class="x"></span>
2407 <span class="x">    no list</span>
2408 <span class="cp">{</span><span class="nf">/hascontent</span><span class="cp">}</span><span class="x"></span>
2409 </code></pre></div>
2410
2411 <h2 id="htmlcheckboxes"><code>htmlCheckboxes</code><a class="headerlink" href="#htmlcheckboxes" title="Permanent link">#</a></h2>
2412 <p><code>htmlCheckboxes</code> generates a list of HTML checkboxes.</p>
2413 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">foo</span> <span class="na">options</span><span class="o">=</span><span class="nv">$fooOptions</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentFoo</span><span class="cp">}</span><span class="x"></span>
2414
2415 <span class="cp">{</span><span class="nf">htmlCheckboxes</span> <span class="na">name</span><span class="o">=</span><span class="na">bar</span> <span class="na">output</span><span class="o">=</span><span class="nv">$barLabels</span> <span class="na">values</span><span class="o">=</span><span class="nv">$barValues</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$currentBar</span><span class="cp">}</span><span class="x"></span>
2416 </code></pre></div>
2417
2418 <table>
2419 <thead>
2420 <tr>
2421 <th>Attribute</th>
2422 <th>Description</th>
2423 </tr>
2424 </thead>
2425 <tbody>
2426 <tr>
2427 <td><span class="label label-info">5.2+</span> <code>disabled</code></td>
2428 <td>if <code>true</code>, all checkboxes are disabled</td>
2429 </tr>
2430 <tr>
2431 <td><code>disableEncoding</code></td>
2432 <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td>
2433 </tr>
2434 <tr>
2435 <td><code>name</code></td>
2436 <td><code>name</code> attribute of the <code>input</code> checkbox element</td>
2437 </tr>
2438 <tr>
2439 <td><code>output</code></td>
2440 <td>array used as keys and values for <code>options</code> if present; not present by default</td>
2441 </tr>
2442 <tr>
2443 <td><code>options</code></td>
2444 <td>array selectable options with the key used as <code>value</code> attribute and the value as the checkbox label</td>
2445 </tr>
2446 <tr>
2447 <td><code>selected</code></td>
2448 <td>current selected value(s)</td>
2449 </tr>
2450 <tr>
2451 <td><code>separator</code></td>
2452 <td>separator between the different checkboxes in the generated output; empty string by default</td>
2453 </tr>
2454 <tr>
2455 <td><code>values</code></td>
2456 <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td>
2457 </tr>
2458 </tbody>
2459 </table>
2460 <h2 id="htmloptions"><code>htmlOptions</code><a class="headerlink" href="#htmloptions" title="Permanent link">#</a></h2>
2461 <p><code>htmlOptions</code> generates an <code>select</code> HTML element.</p>
2462 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">name</span><span class="o">=</span><span class="s1">&#39;foo&#39;</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"></span>
2463
2464 <span class="x">&lt;select name=&quot;bar&quot;&gt;</span>
2465 <span class="x">    &lt;option value=&quot;&quot;</span><span class="cp">{</span><span class="nf">if</span> <span class="o">!</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> selected</span><span class="cp">{</span><span class="nf">/if</span><span class="cp">}</span><span class="x">&gt;</span><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.default</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x">&lt;/option&gt;</span>
2466 <span class="x">    </span><span class="cp">{</span><span class="nf">htmlOptions</span> <span class="na">options</span><span class="o">=</span><span class="nv">$options</span> <span class="na">selected</span><span class="o">=</span><span class="nv">$selected</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* no `name` attribute *</span><span class="cp">}</span><span class="x"></span>
2467 <span class="x">&lt;/select&gt;</span>
2468 </code></pre></div>
2469
2470 <table>
2471 <thead>
2472 <tr>
2473 <th>Attribute</th>
2474 <th>Description</th>
2475 </tr>
2476 </thead>
2477 <tbody>
2478 <tr>
2479 <td><code>disableEncoding</code></td>
2480 <td>if <code>true</code>, the values are not passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>false</code> by default</td>
2481 </tr>
2482 <tr>
2483 <td><code>object</code></td>
2484 <td>optional instance of <code>wcf\data\DatabaseObjectList</code> that provides the selectable options (overwrites <code>options</code> attribute internally)</td>
2485 </tr>
2486 <tr>
2487 <td><code>name</code></td>
2488 <td><code>name</code> attribute of the <code>select</code> element; if not present, only the <strong>contents</strong> of the <code>select</code> element are printed</td>
2489 </tr>
2490 <tr>
2491 <td><code>output</code></td>
2492 <td>array used as keys and values for <code>options</code> if present; not present by default</td>
2493 </tr>
2494 <tr>
2495 <td><code>values</code></td>
2496 <td>array with values used in combination with <code>output</code>, where <code>output</code> is only used as keys for <code>options</code></td>
2497 </tr>
2498 <tr>
2499 <td><code>options</code></td>
2500 <td>array selectable options with the key used as <code>value</code> attribute and the value as the option label; if a value is an array, an <code>optgroup</code> is generated with the array key as the <code>optgroup</code> label</td>
2501 </tr>
2502 <tr>
2503 <td><code>selected</code></td>
2504 <td>current selected value(s)</td>
2505 </tr>
2506 </tbody>
2507 </table>
2508 <p>All additional attributes are added as attributes of the <code>select</code> HTML element.</p>
2509 <h2 id="implode"><code>implode</code><a class="headerlink" href="#implode" title="Permanent link">#</a></h2>
2510 <p><code>implodes</code> transforms an array into a string and prints it.</p>
2511 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">implode</span> <span class="na">from</span><span class="o">=</span><span class="nv">$array</span> <span class="na">key</span><span class="o">=</span><span class="na">key</span> <span class="na">item</span><span class="o">=</span><span class="na">item</span> <span class="na">glue</span><span class="o">=</span><span class="s2">&quot;;&quot;</span><span class="cp">}{</span><span class="nv">$key</span><span class="cp">}</span><span class="x">: </span><span class="cp">{</span><span class="nv">$value</span><span class="cp">}{</span><span class="nf">/implode</span><span class="cp">}</span><span class="x"></span>
2512 </code></pre></div>
2513
2514 <table>
2515 <thead>
2516 <tr>
2517 <th>Attribute</th>
2518 <th>Description</th>
2519 </tr>
2520 </thead>
2521 <tbody>
2522 <tr>
2523 <td><code>from</code></td>
2524 <td>array with the imploded values</td>
2525 </tr>
2526 <tr>
2527 <td><code>glue</code></td>
2528 <td>separator between the different array values; <code>', '</code> by default</td>
2529 </tr>
2530 <tr>
2531 <td><code>item</code></td>
2532 <td>template variable name where the current array value is stored during the iteration</td>
2533 </tr>
2534 <tr>
2535 <td><code>key</code></td>
2536 <td>optional template variable name where the current array key is stored during the iteration</td>
2537 </tr>
2538 </tbody>
2539 </table>
2540 <h2 id="52-ipsearch"><span class="label label-info">5.2+</span> <code>ipSearch</code><a class="headerlink" href="#52-ipsearch" title="Permanent link">#</a></h2>
2541 <p><code>ipSearch</code> generates a link to search for an IP address.</p>
2542 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="s2">&quot;127.0.0.1&quot;</span><span class="o">|</span><span class="na">ipSearch</span><span class="cp">}</span><span class="x"></span>
2543 </code></pre></div>
2544
2545 <h2 id="30-js"><span class="label label-info">3.0+</span> <code>js</code><a class="headerlink" href="#30-js" title="Permanent link">#</a></h2>
2546 <p><code>js</code> generates script tags based on whether <code>ENABLE_DEBUG_MODE</code> and <code>VISITOR_USE_TINY_BUILD</code> are enabled.</p>
2547 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wbb&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WBB&#39;</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/js/WBB.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2548
2549 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WCF.Like&#39;</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">&#39;WCF.Combined&#39;</span><span class="cp">}</span><span class="x"></span>
2550 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Like.js&#39; if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span>
2551 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.min.js&#39; if ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span>
2552
2553 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">lib</span><span class="o">=</span><span class="s1">&#39;jquery&#39;</span><span class="cp">}</span><span class="x"></span>
2554 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/3rdParty/jquery.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2555
2556 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">lib</span><span class="o">=</span><span class="s1">&#39;jquery-ui&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;awesomeWidget&#39;</span><span class="cp">}</span><span class="x"></span>
2557 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/3rdParty/jquery-ui/awesomeWidget.js&#39; *</span><span class="cp">}</span><span class="x"></span>
2558
2559 <span class="cp">{</span><span class="nf">js</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;wcf&#39;</span> <span class="na">file</span><span class="o">=</span><span class="s1">&#39;WCF.Like&#39;</span> <span class="na">bundle</span><span class="o">=</span><span class="s1">&#39;WCF.Combined&#39;</span> <span class="na">hasTiny</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span>
2560 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Like.js&#39; if ENABLE_DEBUG_MODE=1 *</span><span class="cp">}</span><span class="x"></span>
2561 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.min.js&#39; (ENABLE_DEBUG_MODE=0 *</span><span class="cp">}</span><span class="x"></span>
2562 <span class="x">    </span><span class="cp">{</span><span class="c">* generates &#39;http://example.com/wcf/js/WCF.Combined.tiny.min.js&#39; if ENABLE_DEBUG_MODE=0 and VISITOR_USE_TINY_BUILD=1 *</span><span class="cp">}</span><span class="x"></span>
2563 </code></pre></div>
2564
2565 <h2 id="53-jslang"><span class="label label-info">5.3+</span> <code>jslang</code><a class="headerlink" href="#53-jslang" title="Permanent link">#</a></h2>
2566 <p><code>jslang</code> works like <a href="#lang"><code>lang</code></a> with the difference that the resulting string is automatically passed through <a href="#encodejs"><code>encodeJS</code></a>.</p>
2567 <div class="highlight"><pre><span></span><code><span class="x">require([&#39;Language&#39;, /* … */], function(Language, /* … */) </span><span class="cp">{</span>
2568     <span class="na">Language</span><span class="o">.</span><span class="na">addObject</span><span class="o">(</span><span class="cp">{</span>
2569         <span class="s1">&#39;app.foo.bar&#39;</span><span class="o">:</span> <span class="s1">&#39;{jslang}app.foo.bar{/jslang}&#39;</span><span class="o">,</span>
2570     <span class="cp">}</span><span class="o">);</span>
2571
2572     <span class="o">//</span> <span class="err">…</span>
2573 <span class="cp">}</span><span class="x">);</span>
2574 </code></pre></div>
2575
2576 <h2 id="lang"><code>lang</code><a class="headerlink" href="#lang" title="Permanent link">#</a></h2>
2577 <p><code>lang</code> replaces a language items with its value.</p>
2578 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2579
2580 <span class="cp">{</span><span class="nf">lang</span> <span class="na">__literal</span><span class="o">=</span><span class="kc">true</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2581
2582 <span class="cp">{</span><span class="nf">lang</span> <span class="na">foo</span><span class="o">=</span><span class="s1">&#39;baz&#39;</span><span class="cp">}</span><span class="x">foo.bar.baz</span><span class="cp">{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2583
2584 <span class="cp">{</span><span class="nf">lang</span><span class="cp">}</span><span class="x">foo.bar.baz.</span><span class="cp">{</span><span class="nv">$action</span><span class="cp">}{</span><span class="nf">/lang</span><span class="cp">}</span><span class="x"></span>
2585 </code></pre></div>
2586
2587 <table>
2588 <thead>
2589 <tr>
2590 <th>Attribute</th>
2591 <th>Description</th>
2592 </tr>
2593 </thead>
2594 <tbody>
2595 <tr>
2596 <td><code>__encode</code></td>
2597 <td>if <code>true</code>, the output will be passed through <code>StringUtil::encodeHTML()</code></td>
2598 </tr>
2599 <tr>
2600 <td><code>__literal</code></td>
2601 <td>if <code>true</code>, template variables will not resolved but printed as they are in the language item; <code>false</code> by default</td>
2602 </tr>
2603 <tr>
2604 <td><code>__optional</code></td>
2605 <td>if <code>true</code> and the language item does not exist, an empty string is printed; <code>false</code> by default</td>
2606 </tr>
2607 </tbody>
2608 </table>
2609 <p>All additional attributes are available when parsing the language item.</p>
2610 <h2 id="language"><code>language</code><a class="headerlink" href="#language" title="Permanent link">#</a></h2>
2611 <p><code>language</code> replaces a language items with its value.
2612 If the template variable <code>__language</code> exists, this language object will be used instead of <code>WCF::getLanguage()</code>.
2613 This modifier is useful when assigning the value directly to a variable.</p>
2614 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span>
2615
2616 <span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">foo</span> <span class="na">value</span><span class="o">=</span><span class="nv">$languageItem</span><span class="o">|</span><span class="na">language</span><span class="cp">}</span><span class="x"></span>
2617 </code></pre></div>
2618
2619 <h2 id="link"><code>link</code><a class="headerlink" href="#link" title="Permanent link">#</a></h2>
2620 <p><code>link</code> generates internal links using <code>LinkHandler</code>.</p>
2621 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;FooList&#39;</span> <span class="na">application</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x">param1=2&amp;param2=A</span><span class="cp">{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">&quot;&gt;Foo&lt;/a&gt;</span>
2622 </code></pre></div>
2623
2624 <table>
2625 <thead>
2626 <tr>
2627 <th>Attribute</th>
2628 <th>Description</th>
2629 </tr>
2630 </thead>
2631 <tbody>
2632 <tr>
2633 <td><code>application</code></td>
2634 <td>abbreviation of the application the controller belongs to; <code>wcf</code> by default</td>
2635 </tr>
2636 <tr>
2637 <td><code>controller</code></td>
2638 <td>name of the controller; if not present, the landing page is linked in the frontend and the index page in the ACP</td>
2639 </tr>
2640 <tr>
2641 <td><code>encode</code></td>
2642 <td>if <code>true</code>, the generated link is passed through <code>wcf\util\StringUtil::encodeHTML()</code>; <code>true</code> by default</td>
2643 </tr>
2644 <tr>
2645 <td><code>isEmail</code></td>
2646 <td>sets <code>encode=false</code> and forces links to link to the frontend</td>
2647 </tr>
2648 </tbody>
2649 </table>
2650 <p>Additional attributes are passed to <code>LinkHandler::getLink()</code>.</p>
2651 <h2 id="newlinetobreak"><code>newlineToBreak</code><a class="headerlink" href="#newlinetobreak" title="Permanent link">#</a></h2>
2652 <p><code>newlineToBreak</code> transforms newlines into HTML <code>&lt;br&gt;</code> elements after encoding the content via <code>wcf\util\StringUtil::encodeHTML()</code>.</p>
2653 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">newlineToBreak</span><span class="cp">}</span><span class="x"></span>
2654 </code></pre></div>
2655
2656 <h2 id="30-page"><span class="label label-info">3.0+</span> <code>page</code><a class="headerlink" href="#30-page" title="Permanent link">#</a></h2>
2657 <p><code>page</code> generates an internal link to a CMS page.</p>
2658 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">page</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2659
2660 <span class="cp">{</span><span class="nf">page</span> <span class="na">pageID</span><span class="o">=</span><span class="m">1</span><span class="cp">}{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2661
2662 <span class="cp">{</span><span class="nf">page</span> <span class="na">language</span><span class="o">=</span><span class="s1">&#39;de&#39;</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2663
2664 <span class="cp">{</span><span class="nf">page</span> <span class="na">languageID</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x">com.woltlab.wcf.CookiePolicy</span><span class="cp">{</span><span class="nf">/page</span><span class="cp">}</span><span class="x"></span>
2665 </code></pre></div>
2666
2667 <table>
2668 <thead>
2669 <tr>
2670 <th>Attribute</th>
2671 <th>Description</th>
2672 </tr>
2673 </thead>
2674 <tbody>
2675 <tr>
2676 <td><code>pageID</code></td>
2677 <td>unique id of the page (cannot be used together with a page identifier as value)</td>
2678 </tr>
2679 <tr>
2680 <td><code>languageID</code></td>
2681 <td>id of the page language (cannot be used together with <code>language</code>)</td>
2682 </tr>
2683 <tr>
2684 <td><code>language</code></td>
2685 <td>language code of the page language (cannot be used together with <code>languageID</code>)</td>
2686 </tr>
2687 </tbody>
2688 </table>
2689 <h2 id="pages"><code>pages</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h2>
2690 <p><code>pages</code> generates a pagination.</p>
2691 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">pages</span> <span class="na">controller</span><span class="o">=</span><span class="s1">&#39;FooList&#39;</span> <span class="na">link</span><span class="o">=</span><span class="s2">&quot;pageNo=%d&quot;</span> <span class="na">print</span><span class="o">=</span><span class="kc">true</span> <span class="na">assign</span><span class="o">=</span><span class="na">pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints pagination *</span><span class="cp">}</span><span class="x"></span>
2692
2693 <span class="cp">{</span><span class="o">@</span><span class="nv">$pagesLinks</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints same pagination again *</span><span class="cp">}</span><span class="x"></span>
2694 </code></pre></div>
2695
2696 <table>
2697 <thead>
2698 <tr>
2699 <th>Attribute</th>
2700 <th>Description</th>
2701 </tr>
2702 </thead>
2703 <tbody>
2704 <tr>
2705 <td><code>assign</code></td>
2706 <td>optional name of the template variable the pagination is assigned to</td>
2707 </tr>
2708 <tr>
2709 <td><code>controller</code></td>
2710 <td>controller name of the generated links</td>
2711 </tr>
2712 <tr>
2713 <td><code>link</code></td>
2714 <td>additional link parameter where <code>%d</code> will be replaced with the relevant page number</td>
2715 </tr>
2716 <tr>
2717 <td><code>pages</code></td>
2718 <td>maximum number of of pages; by default, the template variable <code>$pages</code> is used</td>
2719 </tr>
2720 <tr>
2721 <td><code>print</code></td>
2722 <td>if <code>false</code> and <code>assign=true</code>, the pagination is not printed</td>
2723 </tr>
2724 <tr>
2725 <td><code>application</code>, <code>id</code>, <code>object</code>, <code>title</code></td>
2726 <td>additional parameters passed to <code>LinkHandler::getLink()</code> to generate page links</td>
2727 </tr>
2728 </tbody>
2729 </table>
2730 <h2 id="plaintime"><code>plainTime</code><a class="headerlink" href="#plaintime" title="Permanent link">#</a></h2>
2731 <p><code>plainTime</code> formats a timestamp to include year, month, day, hour, and minutes.
2732 The exact formatting depends on the current language (via the language items <code>wcf.date.dateTimeFormat</code>, <code>wcf.date.dateFormat</code>, and <code>wcf.date.timeFormat</code>).</p>
2733 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">plainTime</span><span class="cp">}</span><span class="x"></span>
2734 </code></pre></div>
2735
2736 <h2 id="53-plural"><span class="label label-info">5.3+</span> <code>plural</code><a class="headerlink" href="#53-plural" title="Permanent link">#</a></h2>
2737 <p><code>plural</code> allows to easily select the correct plural form of a phrase based on a given <code>value</code>.
2738 The pluralization logic follows the <a href="https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.md">Unicode Language Plural Rules</a> for cardinal numbers.</p>
2739 <p>The <code>#</code> placeholder within the resulting phrase is replaced by the <code>value</code>.
2740 It is automatically formatted using <code>StringUtil::formatNumeric</code>.</p>
2741 <p>English:</p>
2742 <p>Note the use of <code>1</code> if the number (<code>#</code>) is not used within the phrase and the use of <code>one</code> otherwise.
2743 They are equivalent for English, but following this rule generalizes better to other languages, helping the translator.
2744 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2745 <span class="x">&lt;h1&gt;Hello </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;World&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;Worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2746 <span class="x">&lt;p&gt;There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;is one world&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;are # worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2747 <span class="x">&lt;p&gt;There </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;is # world&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;are # worlds&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2748 </code></pre></div></p>
2749 <p>German:
2750 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2751 <span class="x">&lt;h1&gt;Hallo </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2752 <span class="x">&lt;p&gt;Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;eine Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2753 <span class="x">&lt;p&gt;Es gibt </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# Welt&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# Welten&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2754 </code></pre></div></p>
2755 <p>Romanian:</p>
2756 <p>Note the additional use of <code>few</code> which is not required in English or German.
2757 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2758 <span class="x">&lt;h1&gt;Salut </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;lume&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2759 <span class="x">&lt;p&gt;Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;o lume&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# lumi&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# de lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2760 <span class="x">&lt;p&gt;Există </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# lume&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# lumi&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# de lumi&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2761 </code></pre></div></p>
2762 <p>Russian:</p>
2763 <p>Note the difference between <code>1</code> (exactly <code>1</code>) and <code>one</code> (ending in <code>1</code>, except ending in <code>11</code>).
2764 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">numberOfWorlds</span> <span class="na">value</span><span class="o">=</span><span class="m">2</span><span class="cp">}</span><span class="x"></span>
2765 <span class="x">&lt;h1&gt;Привет </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorld</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;мир&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;миры&#39;</span><span class="cp">}</span><span class="x">!&lt;/h1&gt;</span>
2766 <span class="x">&lt;p&gt;Есть </span><span class="cp">{</span><span class="nf">plural</span> <span class="na">value</span><span class="o">=</span><span class="nv">$numberOfWorlds</span> <span class="m">1</span><span class="o">=</span><span class="s1">&#39;мир&#39;</span> <span class="na">one</span><span class="o">=</span><span class="s1">&#39;# мир&#39;</span> <span class="na">few</span><span class="o">=</span><span class="s1">&#39;# мира&#39;</span> <span class="na">many</span><span class="o">=</span><span class="s1">&#39;# миров&#39;</span> <span class="na">other</span><span class="o">=</span><span class="s1">&#39;# миров&#39;</span><span class="cp">}</span><span class="x">!&lt;/p&gt;</span>
2767 </code></pre></div></p>
2768 <table>
2769 <thead>
2770 <tr>
2771 <th>Attribute</th>
2772 <th>Description</th>
2773 </tr>
2774 </thead>
2775 <tbody>
2776 <tr>
2777 <td>value</td>
2778 <td>The value that is used to select the proper phrase.</td>
2779 </tr>
2780 <tr>
2781 <td>other</td>
2782 <td>The phrase that is used when no other selector matches.</td>
2783 </tr>
2784 <tr>
2785 <td>Any Category Name</td>
2786 <td>The phrase that is used when <code>value</code> belongs to the named category. Available categories depend on the language.</td>
2787 </tr>
2788 <tr>
2789 <td>Any Integer</td>
2790 <td>The phrase that is used when <code>value</code> is that exact integer.</td>
2791 </tr>
2792 </tbody>
2793 </table>
2794 <h2 id="prepend"><code>prepend</code><a class="headerlink" href="#prepend" title="Permanent link">#</a></h2>
2795 <p>If a string should be prepended to the value of a variable, <code>prepend</code> can be used:</p>
2796 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">assign</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;newValue&#39;</span><span class="cp">}</span><span class="x"></span>
2797
2798 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints &#39;newValue *</span><span class="cp">}</span><span class="x"></span>
2799
2800 <span class="cp">{</span><span class="nf">prepend</span> <span class="na">var</span><span class="o">=</span><span class="na">templateVariable</span> <span class="na">value</span><span class="o">=</span><span class="s1">&#39;2&#39;</span><span class="cp">}</span><span class="x"></span>
2801
2802 <span class="cp">{</span><span class="nv">$templateVariable</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* now prints &#39;2newValue&#39; *</span><span class="cp">}</span><span class="x"></span>
2803 </code></pre></div>
2804
2805 <p>If the variables does not exist yet, <code>prepend</code> creates a new one with the given value.
2806 If <code>prepend</code> is used on an array as the variable, the value is prepended to all elements of the array.</p>
2807 <h2 id="shortunit"><code>shortUnit</code><a class="headerlink" href="#shortunit" title="Permanent link">#</a></h2>
2808 <p><code>shortUnit</code> shortens numbers larger than 1000 by using unit suffixes:</p>
2809 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="m">10000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 10k *</span><span class="cp">}</span><span class="x"></span>
2810 <span class="cp">{</span><span class="m">5400000</span><span class="o">|</span><span class="na">shortUnit</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints 5.4M *</span><span class="cp">}</span><span class="x"></span>
2811 </code></pre></div>
2812
2813 <h2 id="smallpages"><code>smallpages</code><a class="headerlink" href="#smallpages" title="Permanent link">#</a></h2>
2814 <p><code>smallpages</code> generates a smaller version of <code>pages</code> by using adding the <code>small</code> CSS class to the generated <code>&lt;nav&gt;</code> element and only showing 7 instead of 9 links. </p>
2815 <h2 id="tablewordwrap"><code>tableWordwrap</code><a class="headerlink" href="#tablewordwrap" title="Permanent link">#</a></h2>
2816 <p><code>tableWordwrap</code> inserts zero width spaces every 30 characters in words longer than 30 characters.</p>
2817 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">tableWordwrap</span><span class="cp">}</span><span class="x"></span>
2818 </code></pre></div>
2819
2820 <h2 id="time"><code>time</code><a class="headerlink" href="#time" title="Permanent link">#</a></h2>
2821 <p><code>time</code> generates an HTML <code>time</code> elements based on a timestamp that shows a relative time or the absolute time if the timestamp more than six days ago.</p>
2822 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$timestamp</span><span class="o">|</span><span class="na">time</span><span class="cp">}</span><span class="x"> </span><span class="cp">{</span><span class="c">* prints a &#39;&lt;time&gt;&#39; element *</span><span class="cp">}</span><span class="x"></span>
2823 </code></pre></div>
2824
2825 <h2 id="truncate"><code>truncate</code><a class="headerlink" href="#truncate" title="Permanent link">#</a></h2>
2826 <p><code>truncate</code> truncates a long string into a shorter one:</p>
2827 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="cp">}</span><span class="x"></span>
2828
2829 <span class="cp">{</span><span class="nv">$foo</span><span class="o">|</span><span class="na">truncate</span><span class="o">:</span><span class="m">35</span><span class="o">:</span><span class="s1">&#39;_&#39;</span><span class="o">:</span><span class="kc">true</span><span class="cp">}</span><span class="x"></span>
2830 </code></pre></div>
2831
2832 <table>
2833 <thead>
2834 <tr>
2835 <th>Parameter Number</th>
2836 <th>Description</th>
2837 </tr>
2838 </thead>
2839 <tbody>
2840 <tr>
2841 <td>0</td>
2842 <td>truncated string</td>
2843 </tr>
2844 <tr>
2845 <td>1</td>
2846 <td>truncated length; <code>80</code> by default</td>
2847 </tr>
2848 <tr>
2849 <td>2</td>
2850 <td>ellipsis symbol; <code>wcf\util\StringUtil::HELLIP</code> by default</td>
2851 </tr>
2852 <tr>
2853 <td>3</td>
2854 <td>if <code>true</code>, words can be broken up in the middle; <code>false</code> by default</td>
2855 </tr>
2856 </tbody>
2857 </table>
2858 <h2 id="53-user"><span class="label label-info">5.3+</span> <code>user</code><a class="headerlink" href="#53-user" title="Permanent link">#</a></h2>
2859 <p><code>user</code> generates links to user profiles.
2860 The mandatory <code>object</code> parameter requires an instances of <code>UserProfile</code>.
2861 The optional <code>type</code> parameter is responsible for what the generated link contains:</p>
2862 <ul>
2863 <li><code>type='default'</code> (also applies if no <code>type</code> is given) outputs the formatted username relying on the “User Marking” setting of the relevant user group.
2864   Additionally, the user popover card will be shown when hovering over the generated link.</li>
2865 <li><code>type='plain'</code> outputs the username without additional formatting.</li>
2866 <li><code>type='avatar(\d+)'</code> outputs the user’s avatar in the specified size, i.e., <code>avatar48</code> outputs the avatar with a width and height of 48 pixels.</li>
2867 </ul>
2868 <p>The last special attribute is <code>append</code> whose contents are appended to the <code>href</code> attribute of the generated anchor element.</p>
2869 <p>All of the other attributes matching <code>~^[a-z]+([A-z]+)+$~</code>, except for <code>href</code> which may not be added, are added as attributes to the anchor element.</p>
2870 <p>Examples:</p>
2871 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span><span class="cp">}</span><span class="x"></span>
2872 </code></pre></div>
2873
2874 <p>generates</p>
2875 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; data-object-id=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">userID</span><span class="cp">}</span><span class="x">&quot; class=&quot;userLink&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getFormattedUsername</span><span class="o">()</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2876 </code></pre></div>
2877
2878 <p>and</p>
2879 <div class="highlight"><pre><span></span><code><span class="cp">{</span><span class="nf">user</span> <span class="na">object</span><span class="o">=</span><span class="nv">$user</span> <span class="na">type</span><span class="o">=</span><span class="s1">&#39;avatar48&#39;</span> <span class="na">foo</span><span class="o">=</span><span class="s1">&#39;bar&#39;</span><span class="cp">}</span><span class="x"></span>
2880 </code></pre></div>
2881
2882 <p>generates</p>
2883 <div class="highlight"><pre><span></span><code><span class="x">&lt;a href=&quot;</span><span class="cp">{</span><span class="nv">$user</span><span class="o">-&gt;</span><span class="na">getLink</span><span class="o">()</span><span class="cp">}</span><span class="x">&quot; foo=&quot;bar&quot;&gt;</span><span class="cp">{</span><span class="o">@</span><span class="nv">$object</span><span class="o">-&gt;</span><span class="na">getAvatar</span><span class="o">()-&gt;</span><span class="na">getImageTag</span><span class="o">(</span><span class="m">48</span><span class="o">)</span><span class="cp">}</span><span class="x">&lt;/a&gt;</span>
2884 </code></pre></div>
2885
2886
2887
2888
2889
2890
2891
2892             </article>
2893           </div>
2894         </div>
2895       </main>
2896
2897
2898 <footer class="md-footer">
2899
2900   <div class="md-footer-meta md-typeset">
2901     <div class="md-footer-meta__inner md-grid">
2902       <div class="md-footer-copyright">
2903
2904           <div class="md-footer-copyright__highlight">
2905             Copyright © 2020 WoltLab GmbH
2906           </div>
2907
2908         Made with
2909         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2910           Material for MkDocs
2911         </a>
2912       </div>
2913       <div class="md-footer-copyright">
2914         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2915         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2916 </div>
2917     </div>
2918   </div>
2919 </footer>
2920
2921     </div>
2922     <div class="md-dialog" data-md-component="dialog">
2923       <div class="md-dialog__inner md-typeset"></div>
2924     </div>
2925     <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>
2926
2927
2928       <script src="../../assets/javascripts/bundle.ca5457b8.min.js"></script>
2929
2930
2931   </body>
2932 </html>