latest/migration/wcf21/php/index.html

   1
   2 <!doctype html>
   3 <html lang="en" class="no-js">
   4   <head>
   5
   6       <meta charset="utf-8">
   7       <meta name="viewport" content="width=device-width,initial-scale=1">
   8
   9
  10
  11
  12       <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
  13       <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
  14
  15
  16
  17         <title>PHP API - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37       <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="#wcf-21x-php" 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               PHP API
 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="../../../view/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="../../../view/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="../../../view/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
1266
1267     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1268
1269
1270         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
1271
1272       <label class="md-nav__link" for="__nav_6">
1273         Migration
1274         <span class="md-nav__icon md-icon"></span>
1275       </label>
1276       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1277         <label class="md-nav__title" for="__nav_6">
1278           <span class="md-nav__icon md-icon"></span>
1279           Migration
1280         </label>
1281         <ul class="md-nav__list" data-md-scrollfix>
1282
1283
1284
1285
1286
1287
1288     <li class="md-nav__item md-nav__item--nested">
1289
1290
1291         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1292
1293       <label class="md-nav__link" for="__nav_6_1">
1294         Migrating from WSC 5.3
1295         <span class="md-nav__icon md-icon"></span>
1296       </label>
1297       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1298         <label class="md-nav__title" for="__nav_6_1">
1299           <span class="md-nav__icon md-icon"></span>
1300           Migrating from WSC 5.3
1301         </label>
1302         <ul class="md-nav__list" data-md-scrollfix>
1303
1304
1305
1306
1307
1308     <li class="md-nav__item">
1309       <a href="../../wsc53/php/" class="md-nav__link">
1310         PHP API
1311       </a>
1312     </li>
1313
1314
1315
1316
1317
1318
1319
1320     <li class="md-nav__item">
1321       <a href="../../wsc53/session/" class="md-nav__link">
1322         Session Handling and Authentication
1323       </a>
1324     </li>
1325
1326
1327
1328
1329
1330
1331
1332     <li class="md-nav__item">
1333       <a href="../../wsc53/javascript/" class="md-nav__link">
1334         JavaScript
1335       </a>
1336     </li>
1337
1338
1339
1340
1341
1342
1343
1344     <li class="md-nav__item">
1345       <a href="../../wsc53/templates/" class="md-nav__link">
1346         Templates
1347       </a>
1348     </li>
1349
1350
1351
1352
1353
1354
1355
1356     <li class="md-nav__item">
1357       <a href="../../wsc53/libraries/" class="md-nav__link">
1358         Third Party Libraries
1359       </a>
1360     </li>
1361
1362
1363
1364         </ul>
1365       </nav>
1366     </li>
1367
1368
1369
1370
1371
1372
1373
1374
1375     <li class="md-nav__item md-nav__item--nested">
1376
1377
1378         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1379
1380       <label class="md-nav__link" for="__nav_6_2">
1381         Migrating from WSC 5.2
1382         <span class="md-nav__icon md-icon"></span>
1383       </label>
1384       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1385         <label class="md-nav__title" for="__nav_6_2">
1386           <span class="md-nav__icon md-icon"></span>
1387           Migrating from WSC 5.2
1388         </label>
1389         <ul class="md-nav__list" data-md-scrollfix>
1390
1391
1392
1393
1394
1395     <li class="md-nav__item">
1396       <a href="../../wsc52/php/" class="md-nav__link">
1397         PHP API
1398       </a>
1399     </li>
1400
1401
1402
1403
1404
1405
1406
1407     <li class="md-nav__item">
1408       <a href="../../wsc52/templates/" class="md-nav__link">
1409         Templates and Languages
1410       </a>
1411     </li>
1412
1413
1414
1415
1416
1417
1418
1419     <li class="md-nav__item">
1420       <a href="../../wsc52/libraries/" class="md-nav__link">
1421         Third Party Libraries
1422       </a>
1423     </li>
1424
1425
1426
1427         </ul>
1428       </nav>
1429     </li>
1430
1431
1432
1433
1434
1435
1436
1437
1438     <li class="md-nav__item md-nav__item--nested">
1439
1440
1441         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1442
1443       <label class="md-nav__link" for="__nav_6_3">
1444         Migrating from WSC 3.1
1445         <span class="md-nav__icon md-icon"></span>
1446       </label>
1447       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1448         <label class="md-nav__title" for="__nav_6_3">
1449           <span class="md-nav__icon md-icon"></span>
1450           Migrating from WSC 3.1
1451         </label>
1452         <ul class="md-nav__list" data-md-scrollfix>
1453
1454
1455
1456
1457
1458     <li class="md-nav__item">
1459       <a href="../../wsc31/php/" class="md-nav__link">
1460         PHP API
1461       </a>
1462     </li>
1463
1464
1465
1466         </ul>
1467       </nav>
1468     </li>
1469
1470
1471
1472
1473
1474
1475
1476
1477     <li class="md-nav__item md-nav__item--nested">
1478
1479
1480         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1481
1482       <label class="md-nav__link" for="__nav_6_4">
1483         Migrating from WSC 3.0
1484         <span class="md-nav__icon md-icon"></span>
1485       </label>
1486       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1487         <label class="md-nav__title" for="__nav_6_4">
1488           <span class="md-nav__icon md-icon"></span>
1489           Migrating from WSC 3.0
1490         </label>
1491         <ul class="md-nav__list" data-md-scrollfix>
1492
1493
1494
1495
1496
1497     <li class="md-nav__item">
1498       <a href="../../wsc30/php/" class="md-nav__link">
1499         PHP API
1500       </a>
1501     </li>
1502
1503
1504
1505
1506
1507
1508
1509     <li class="md-nav__item">
1510       <a href="../../wsc30/javascript/" class="md-nav__link">
1511         JavaScript API
1512       </a>
1513     </li>
1514
1515
1516
1517
1518
1519
1520
1521     <li class="md-nav__item">
1522       <a href="../../wsc30/templates/" class="md-nav__link">
1523         Templates
1524       </a>
1525     </li>
1526
1527
1528
1529
1530
1531
1532
1533     <li class="md-nav__item">
1534       <a href="../../wsc30/css/" class="md-nav__link">
1535         CSS
1536       </a>
1537     </li>
1538
1539
1540
1541
1542
1543
1544
1545     <li class="md-nav__item">
1546       <a href="../../wsc30/package/" class="md-nav__link">
1547         Package Components
1548       </a>
1549     </li>
1550
1551
1552
1553         </ul>
1554       </nav>
1555     </li>
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1567
1568
1569         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" checked>
1570
1571       <label class="md-nav__link" for="__nav_6_5">
1572         Migrating from WCF 2.1
1573         <span class="md-nav__icon md-icon"></span>
1574       </label>
1575       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1576         <label class="md-nav__title" for="__nav_6_5">
1577           <span class="md-nav__icon md-icon"></span>
1578           Migrating from WCF 2.1
1579         </label>
1580         <ul class="md-nav__list" data-md-scrollfix>
1581
1582
1583
1584
1585
1586
1587
1588     <li class="md-nav__item md-nav__item--active">
1589
1590       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1591
1592
1593
1594
1595         <label class="md-nav__link md-nav__link--active" for="__toc">
1596           PHP API
1597           <span class="md-nav__icon md-icon"></span>
1598         </label>
1599
1600       <a href="./" class="md-nav__link md-nav__link--active">
1601         PHP API
1602       </a>
1603
1604
1605 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1606
1607
1608
1609
1610
1611     <label class="md-nav__title" for="__toc">
1612       <span class="md-nav__icon md-icon"></span>
1613       Table of contents
1614     </label>
1615     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1616
1617         <li class="md-nav__item">
1618   <a href="#message-processing" class="md-nav__link">
1619     Message Processing
1620   </a>
1621
1622     <nav class="md-nav" aria-label="Message Processing">
1623       <ul class="md-nav__list">
1624
1625           <li class="md-nav__item">
1626   <a href="#input-processing-for-storage" class="md-nav__link">
1627     Input Processing for Storage
1628   </a>
1629
1630 </li>
1631
1632           <li class="md-nav__item">
1633   <a href="#embedded-objects" class="md-nav__link">
1634     Embedded Objects
1635   </a>
1636
1637 </li>
1638
1639           <li class="md-nav__item">
1640   <a href="#rendering-the-message" class="md-nav__link">
1641     Rendering the Message
1642   </a>
1643
1644     <nav class="md-nav" aria-label="Rendering the Message">
1645       <ul class="md-nav__list">
1646
1647           <li class="md-nav__item">
1648   <a href="#simplified-output" class="md-nav__link">
1649     Simplified Output
1650   </a>
1651
1652 </li>
1653
1654           <li class="md-nav__item">
1655   <a href="#plaintext-output" class="md-nav__link">
1656     Plaintext Output
1657   </a>
1658
1659 </li>
1660
1661       </ul>
1662     </nav>
1663
1664 </li>
1665
1666           <li class="md-nav__item">
1667   <a href="#rebuilding-data" class="md-nav__link">
1668     Rebuilding Data
1669   </a>
1670
1671     <nav class="md-nav" aria-label="Rebuilding Data">
1672       <ul class="md-nav__list">
1673
1674           <li class="md-nav__item">
1675   <a href="#converting-from-bbcode" class="md-nav__link">
1676     Converting from BBCode
1677   </a>
1678
1679 </li>
1680
1681           <li class="md-nav__item">
1682   <a href="#extracting-embedded-objects" class="md-nav__link">
1683     Extracting Embedded Objects
1684   </a>
1685
1686 </li>
1687
1688       </ul>
1689     </nav>
1690
1691 </li>
1692
1693       </ul>
1694     </nav>
1695
1696 </li>
1697
1698         <li class="md-nav__item">
1699   <a href="#breadcrumbs-page-location" class="md-nav__link">
1700     Breadcrumbs / Page Location
1701   </a>
1702
1703 </li>
1704
1705         <li class="md-nav__item">
1706   <a href="#pages-and-forms" class="md-nav__link">
1707     Pages and Forms
1708   </a>
1709
1710 </li>
1711
1712         <li class="md-nav__item">
1713   <a href="#search" class="md-nav__link">
1714     Search
1715   </a>
1716
1717     <nav class="md-nav" aria-label="Search">
1718       <ul class="md-nav__list">
1719
1720           <li class="md-nav__item">
1721   <a href="#isearchableobjecttype" class="md-nav__link">
1722     ISearchableObjectType
1723   </a>
1724
1725 </li>
1726
1727           <li class="md-nav__item">
1728   <a href="#searchindexmanager" class="md-nav__link">
1729     SearchIndexManager
1730   </a>
1731
1732 </li>
1733
1734       </ul>
1735     </nav>
1736
1737 </li>
1738
1739     </ul>
1740
1741 </nav>
1742
1743     </li>
1744
1745
1746
1747
1748
1749
1750
1751     <li class="md-nav__item">
1752       <a href="../templates/" class="md-nav__link">
1753         Templates
1754       </a>
1755     </li>
1756
1757
1758
1759
1760
1761
1762
1763     <li class="md-nav__item">
1764       <a href="../css/" class="md-nav__link">
1765         CSS
1766       </a>
1767     </li>
1768
1769
1770
1771
1772
1773
1774
1775     <li class="md-nav__item">
1776       <a href="../package/" class="md-nav__link">
1777         Package Components
1778       </a>
1779     </li>
1780
1781
1782
1783         </ul>
1784       </nav>
1785     </li>
1786
1787
1788
1789         </ul>
1790       </nav>
1791     </li>
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803     <li class="md-nav__item md-nav__item--nested">
1804
1805
1806         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1807
1808       <label class="md-nav__link" for="__nav_7">
1809         Tutorials
1810         <span class="md-nav__icon md-icon"></span>
1811       </label>
1812       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1813         <label class="md-nav__title" for="__nav_7">
1814           <span class="md-nav__icon md-icon"></span>
1815           Tutorials
1816         </label>
1817         <ul class="md-nav__list" data-md-scrollfix>
1818
1819
1820
1821
1822
1823
1824     <li class="md-nav__item md-nav__item--nested">
1825
1826
1827         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1828
1829       <label class="md-nav__link" for="__nav_7_1">
1830         Tutorial Series
1831         <span class="md-nav__icon md-icon"></span>
1832       </label>
1833       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1834         <label class="md-nav__title" for="__nav_7_1">
1835           <span class="md-nav__icon md-icon"></span>
1836           Tutorial Series
1837         </label>
1838         <ul class="md-nav__list" data-md-scrollfix>
1839
1840
1841
1842
1843
1844     <li class="md-nav__item">
1845       <a href="../../../tutorial/series/overview/" class="md-nav__link">
1846         Overview
1847       </a>
1848     </li>
1849
1850
1851
1852
1853
1854
1855
1856     <li class="md-nav__item">
1857       <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1858         Part 1
1859       </a>
1860     </li>
1861
1862
1863
1864
1865
1866
1867
1868     <li class="md-nav__item">
1869       <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1870         Part 2
1871       </a>
1872     </li>
1873
1874
1875
1876
1877
1878
1879
1880     <li class="md-nav__item">
1881       <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1882         Part 3
1883       </a>
1884     </li>
1885
1886
1887
1888         </ul>
1889       </nav>
1890     </li>
1891
1892
1893
1894         </ul>
1895       </nav>
1896     </li>
1897
1898
1899
1900   </ul>
1901 </nav>
1902                   </div>
1903                 </div>
1904               </div>
1905
1906
1907
1908               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1909                 <div class="md-sidebar__scrollwrap">
1910                   <div class="md-sidebar__inner">
1911
1912 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1913
1914
1915
1916
1917
1918     <label class="md-nav__title" for="__toc">
1919       <span class="md-nav__icon md-icon"></span>
1920       Table of contents
1921     </label>
1922     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1923
1924         <li class="md-nav__item">
1925   <a href="#message-processing" class="md-nav__link">
1926     Message Processing
1927   </a>
1928
1929     <nav class="md-nav" aria-label="Message Processing">
1930       <ul class="md-nav__list">
1931
1932           <li class="md-nav__item">
1933   <a href="#input-processing-for-storage" class="md-nav__link">
1934     Input Processing for Storage
1935   </a>
1936
1937 </li>
1938
1939           <li class="md-nav__item">
1940   <a href="#embedded-objects" class="md-nav__link">
1941     Embedded Objects
1942   </a>
1943
1944 </li>
1945
1946           <li class="md-nav__item">
1947   <a href="#rendering-the-message" class="md-nav__link">
1948     Rendering the Message
1949   </a>
1950
1951     <nav class="md-nav" aria-label="Rendering the Message">
1952       <ul class="md-nav__list">
1953
1954           <li class="md-nav__item">
1955   <a href="#simplified-output" class="md-nav__link">
1956     Simplified Output
1957   </a>
1958
1959 </li>
1960
1961           <li class="md-nav__item">
1962   <a href="#plaintext-output" class="md-nav__link">
1963     Plaintext Output
1964   </a>
1965
1966 </li>
1967
1968       </ul>
1969     </nav>
1970
1971 </li>
1972
1973           <li class="md-nav__item">
1974   <a href="#rebuilding-data" class="md-nav__link">
1975     Rebuilding Data
1976   </a>
1977
1978     <nav class="md-nav" aria-label="Rebuilding Data">
1979       <ul class="md-nav__list">
1980
1981           <li class="md-nav__item">
1982   <a href="#converting-from-bbcode" class="md-nav__link">
1983     Converting from BBCode
1984   </a>
1985
1986 </li>
1987
1988           <li class="md-nav__item">
1989   <a href="#extracting-embedded-objects" class="md-nav__link">
1990     Extracting Embedded Objects
1991   </a>
1992
1993 </li>
1994
1995       </ul>
1996     </nav>
1997
1998 </li>
1999
2000       </ul>
2001     </nav>
2002
2003 </li>
2004
2005         <li class="md-nav__item">
2006   <a href="#breadcrumbs-page-location" class="md-nav__link">
2007     Breadcrumbs / Page Location
2008   </a>
2009
2010 </li>
2011
2012         <li class="md-nav__item">
2013   <a href="#pages-and-forms" class="md-nav__link">
2014     Pages and Forms
2015   </a>
2016
2017 </li>
2018
2019         <li class="md-nav__item">
2020   <a href="#search" class="md-nav__link">
2021     Search
2022   </a>
2023
2024     <nav class="md-nav" aria-label="Search">
2025       <ul class="md-nav__list">
2026
2027           <li class="md-nav__item">
2028   <a href="#isearchableobjecttype" class="md-nav__link">
2029     ISearchableObjectType
2030   </a>
2031
2032 </li>
2033
2034           <li class="md-nav__item">
2035   <a href="#searchindexmanager" class="md-nav__link">
2036     SearchIndexManager
2037   </a>
2038
2039 </li>
2040
2041       </ul>
2042     </nav>
2043
2044 </li>
2045
2046     </ul>
2047
2048 </nav>
2049                   </div>
2050                 </div>
2051               </div>
2052
2053
2054           <div class="md-content" data-md-component="content">
2055             <article class="md-content__inner md-typeset">
2056
2057
2058
2059                 <h1 id="wcf-21x-php">WCF 2.1.x - PHP<a class="headerlink" href="#wcf-21x-php" title="Permanent link">#</a></h1>
2060 <h2 id="message-processing">Message Processing<a class="headerlink" href="#message-processing" title="Permanent link">#</a></h2>
2061 <p>WoltLab Suite 3.0 finally made the transition from raw bbcode to bbcode-flavored HTML, with many new features related to message processing being added. This change impacts both message validation and storing, requiring slightly different APIs to get the job done.</p>
2062 <h3 id="input-processing-for-storage">Input Processing for Storage<a class="headerlink" href="#input-processing-for-storage" title="Permanent link">#</a></h3>
2063 <p>The returned HTML is an intermediate representation with a maximum of meta data embedded into it, designed to be stored in the database. Some bbcodes are replaced during this process, for example <code>[b]…[/b]</code> becomes <code>&lt;strong&gt;…&lt;/strong&gt;</code>, while others are converted into a metacode tag for later processing.</p>
2064 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2065 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2066 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$message</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2067 <span class="nv">$html</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2068 </code></pre></div>
2069 <p>The <code>$messageObjectID</code> can be zero if the element did not exist before, but it should be non-zero when saving an edited message.</p>
2070 <h3 id="embedded-objects">Embedded Objects<a class="headerlink" href="#embedded-objects" title="Permanent link">#</a></h3>
2071 <p>Embedded objects need to be registered after saving the message, but once again you can use the processor instance to do the job.</p>
2072 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2073 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2074 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$message</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2075 <span class="nv">$html</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2076
2077 <span class="c1">// at this point the message is saved to database and the created object</span>
2078 <span class="c1">// `$example` is a `DatabaseObject` with the id column `$exampleID`</span>
2079
2080 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setObjectID</span><span class="p">(</span><span class="nv">$example</span><span class="o">-&gt;</span><span class="na">exampleID</span><span class="p">);</span>
2081 <span class="k">if</span> <span class="p">(</span><span class="nx">\wcf\system\message\embedded\object\MessageEmbeddedObjectManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">registerObjects</span><span class="p">(</span><span class="nv">$processor</span><span class="p">))</span> <span class="p">{</span>
2082     <span class="c1">// there is at least one embedded object, this is also the point at which you</span>
2083     <span class="c1">// would set `hasEmbeddedObjects` to true (if implemented by your type)</span>
2084     <span class="p">(</span><span class="k">new</span> <span class="nx">\wcf\data\example\ExampleEditor</span><span class="p">(</span><span class="nv">$example</span><span class="p">))</span><span class="o">-&gt;</span><span class="na">update</span><span class="p">([</span><span class="s1">&#39;hasEmbeddedObjects&#39;</span> <span class="o">=&gt;</span> <span class="mi">1</span><span class="p">]);</span>
2085 <span class="p">}</span>
2086 </code></pre></div>
2087 <h3 id="rendering-the-message">Rendering the Message<a class="headerlink" href="#rendering-the-message" title="Permanent link">#</a></h3>
2088 <p>The output processor will parse the intermediate HTML and finalize the output for display. This step is highly dynamic and allows for bbcode evaluation and contextual output based on the viewer's permissions.</p>
2089 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2090 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2091 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2092 <span class="nv">$renderedHtml</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2093 </code></pre></div>
2094 <h4 id="simplified-output">Simplified Output<a class="headerlink" href="#simplified-output" title="Permanent link">#</a></h4>
2095 <p>At some point there can be the need of a simplified output HTML that includes only basic HTML formatting and reduces more sophisticated bbcodes into a simpler representation.</p>
2096 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2097 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2098 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setOutputType</span><span class="p">(</span><span class="s1">&#39;text/simplified-html&#39;</span><span class="p">);</span>
2099 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nx">…</span><span class="p">);</span>
2100 </code></pre></div>
2101 <h4 id="plaintext-output">Plaintext Output<a class="headerlink" href="#plaintext-output" title="Permanent link">#</a></h4>
2102 <p>The <code>text/plain</code> output type will strip down the simplified HTML into pure text, suitable for text-only output such as the plaintext representation of an email.</p>
2103 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2104 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\output\HtmlOutputProcessor</span><span class="p">();</span>
2105 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">setOutputType</span><span class="p">(</span><span class="s1">&#39;text/plain&#39;</span><span class="p">);</span>
2106 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nx">…</span><span class="p">);</span>
2107 </code></pre></div>
2108 <h3 id="rebuilding-data">Rebuilding Data<a class="headerlink" href="#rebuilding-data" title="Permanent link">#</a></h3>
2109 <h4 id="converting-from-bbcode">Converting from BBCode<a class="headerlink" href="#converting-from-bbcode" title="Permanent link">#</a></h4>
2110 <div class="admonition warning">
2111 <p class="admonition-title">Enabling message conversion for HTML messages is undefined and yields unexpected results.</p>
2112 </div>
2113 <p>Legacy message that still use raw bbcodes must be converted to be properly parsed by the html processors. This process is enabled by setting the fourth parameter of <code>process()</code> to <code>true</code>.</p>
2114 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2115 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2116 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">process</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">,</span> <span class="k">true</span><span class="p">);</span>
2117 <span class="nv">$renderedHtml</span> <span class="o">=</span> <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">();</span>
2118 </code></pre></div>
2119 <h4 id="extracting-embedded-objects">Extracting Embedded Objects<a class="headerlink" href="#extracting-embedded-objects" title="Permanent link">#</a></h4>
2120 <p>The <code>process()</code> method of the input processor is quite expensive, as it runs through the full message validation including the invocation of HTMLPurifier. This is perfectly fine when dealing with single messages, but when you're handling messages in bulk to extract their embedded objects, you're better of with <code>processEmbeddedContent()</code>. This method deconstructs the message, but skips all validation and expects the input to be perfectly valid, that is the output of a previous run of <code>process()</code> saved to storage.</p>
2121 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2122 <span class="nv">$processor</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">\wcf\system\html\input\HtmlInputProcessor</span><span class="p">();</span>
2123 <span class="nv">$processor</span><span class="o">-&gt;</span><span class="na">processEmbeddedContent</span><span class="p">(</span><span class="nv">$html</span><span class="p">,</span> <span class="nv">$messageObjectType</span><span class="p">,</span> <span class="nv">$messageObjectID</span><span class="p">);</span>
2124
2125 <span class="c1">// invoke `MessageEmbeddedObjectManager::registerObjects` here</span>
2126 </code></pre></div>
2127 <h2 id="breadcrumbs-page-location">Breadcrumbs / Page Location<a class="headerlink" href="#breadcrumbs-page-location" title="Permanent link">#</a></h2>
2128 <div class="admonition warning">
2129 <p class="admonition-title">Breadcrumbs used to be added left to right, but parent locations are added from the bottom to the top, starting with the first ancestor and going upwards. In most cases you simply need to reverse the order.</p>
2130 </div>
2131 <p>Breadcrumbs used to be a lose collection of arbitrary links, but are now represented by actual page objects and the control has shifted over to the <code>PageLocationManager</code>.</p>
2132 <div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2133 <span class="c1">// before</span>
2134 <span class="nx">\wcf\system\WCF</span><span class="o">::</span><span class="na">getBreadcrumbs</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">add</span><span class="p">(</span><span class="k">new</span> <span class="nx">\wcf\system\breadcrumb\Breadcrumb</span><span class="p">(</span><span class="s1">&#39;title&#39;</span><span class="p">,</span> <span class="s1">&#39;link&#39;</span><span class="p">));</span>
2135
2136 <span class="c1">// after</span>
2137 <span class="nx">\wcf\system\page\PageLocationManager</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">addParentLocation</span><span class="p">(</span><span class="nv">$pageIdentifier</span><span class="p">,</span> <span class="nv">$pageObjectID</span><span class="p">,</span> <span class="nv">$object</span><span class="p">);</span>
2138 </code></pre></div>
2139 <h2 id="pages-and-forms">Pages and Forms<a class="headerlink" href="#pages-and-forms" title="Permanent link">#</a></h2>
2140 <p>The property <code>$activeMenuItem</code> has been deprecated for the front end and is no longer evaluated at runtime. Recognition of the active item is entirely based around the invoked controller class name and its definition in the page table. You need to properly <a href="../../../package/pip/page/">register your pages</a> for this feature to work.</p>
2141 <h2 id="search">Search<a class="headerlink" href="#search" title="Permanent link">#</a></h2>
2142 <h3 id="isearchableobjecttype">ISearchableObjectType<a class="headerlink" href="#isearchableobjecttype" title="Permanent link">#</a></h3>
2143 <p>Added the <code>setLocation()</code> method that is used to set the current page location based on the search result.</p>
2144 <h3 id="searchindexmanager">SearchIndexManager<a class="headerlink" href="#searchindexmanager" title="Permanent link">#</a></h3>
2145 <p>The methods <code>SearchIndexManager::add()</code> and <code>SearchIndexManager::update()</code> have been deprecated and forward their call to the new method <code>SearchIndexManager::set()</code>.</p>
2146
2147
2148
2149
2150
2151
2152
2153             </article>
2154           </div>
2155         </div>
2156       </main>
2157
2158
2159 <footer class="md-footer">
2160
2161     <nav class="md-footer__inner md-grid" aria-label="Footer">
2162
2163         <a href="../../wsc30/package/" class="md-footer__link md-footer__link--prev" rel="prev">
2164           <div class="md-footer__button md-icon">
2165             <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>
2166           </div>
2167           <div class="md-footer__title">
2168             <div class="md-ellipsis">
2169               <span class="md-footer__direction">
2170                 Previous
2171               </span>
2172               Package Components
2173             </div>
2174           </div>
2175         </a>
2176
2177
2178         <a href="../templates/" class="md-footer__link md-footer__link--next" rel="next">
2179           <div class="md-footer__title">
2180             <div class="md-ellipsis">
2181               <span class="md-footer__direction">
2182                 Next
2183               </span>
2184               Templates
2185             </div>
2186           </div>
2187           <div class="md-footer__button md-icon">
2188             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2189           </div>
2190         </a>
2191
2192     </nav>
2193
2194   <div class="md-footer-meta md-typeset">
2195     <div class="md-footer-meta__inner md-grid">
2196       <div class="md-footer-copyright">
2197
2198           <div class="md-footer-copyright__highlight">
2199             Copyright © 2020 WoltLab GmbH
2200           </div>
2201
2202         Made with
2203         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2204           Material for MkDocs
2205         </a>
2206
2207       </div>
2208       <div class="md-footer-copyright">
2209         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2210         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2211 </div>
2212     </div>
2213   </div>
2214 </footer>
2215
2216     </div>
2217     <div class="md-dialog" data-md-component="dialog">
2218       <div class="md-dialog__inner md-typeset"></div>
2219     </div>
2220     <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>
2221
2222
2223       <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2224
2225
2226   </body>
2227 </html>