latest/php/pages/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>Pages - WoltLab Suite Documentation</title>
  18
  19
  20
  21       <link rel="stylesheet" href="../../assets/stylesheets/main.77f3fd56.min.css">
  22
  23
  24         <link rel="stylesheet" href="../../assets/stylesheets/palette.7fa14f5b.min.css">
  25
  26
  27
  28           <meta name="theme-color" content="#009485">
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38       <link rel="stylesheet" href="../../stylesheets/extra.css">
  39
  40
  41
  42
  43
  44   </head>
  45
  46
  47
  48
  49
  50
  51
  52     <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
  53
  54
  55
  56     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  57     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  58     <label class="md-overlay" for="__drawer"></label>
  59     <div data-md-component="skip">
  60
  61
  62         <a href="#page-types" class="md-skip">
  63           Skip to content
  64         </a>
  65
  66     </div>
  67     <div data-md-component="announce">
  68
  69         <aside class="md-announce">
  70           <div class="md-announce__inner md-grid md-typeset">
  71
  72     <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
  73
  74           </div>
  75         </aside>
  76
  77     </div>
  78
  79
  80
  81 <header class="md-header" data-md-component="header">
  82   <nav class="md-header__inner md-grid" aria-label="Header">
  83     <a href="../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
  84
  85   <img src="../../assets/logo.png" alt="logo">
  86
  87     </a>
  88     <label class="md-header__button md-icon" for="__drawer">
  89       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  90     </label>
  91     <div class="md-header__title" data-md-component="header-title">
  92       <div class="md-header__ellipsis">
  93         <div class="md-header__topic">
  94           <span class="md-ellipsis">
  95             WoltLab Suite Documentation
  96           </span>
  97         </div>
  98         <div class="md-header__topic" data-md-component="header-topic">
  99           <span class="md-ellipsis">
 100
 101               Pages
 102
 103           </span>
 104         </div>
 105       </div>
 106     </div>
 107     <div class="md-header__options">
 108
 109     </div>
 110
 111
 112       <div class="md-header__source">
 113
 114 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 115   <div class="md-source__icon md-icon">
 116
 117     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 118   </div>
 119   <div class="md-source__repository">
 120     GitHub
 121   </div>
 122 </a>
 123       </div>
 124
 125   </nav>
 126 </header>
 127
 128     <div class="md-container" data-md-component="container">
 129
 130
 131
 132
 133       <main class="md-main" data-md-component="main">
 134         <div class="md-main__inner md-grid">
 135
 136
 137
 138               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
 139                 <div class="md-sidebar__scrollwrap">
 140                   <div class="md-sidebar__inner">
 141
 142
 143
 144
 145
 146 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
 147   <label class="md-nav__title" for="__drawer">
 148     <a href="../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
 149
 150   <img src="../../assets/logo.png" alt="logo">
 151
 152     </a>
 153     WoltLab Suite Documentation
 154   </label>
 155
 156     <div class="md-nav__source">
 157
 158 <a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
 159   <div class="md-source__icon md-icon">
 160
 161     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
 162   </div>
 163   <div class="md-source__repository">
 164     GitHub
 165   </div>
 166 </a>
 167     </div>
 168
 169   <ul class="md-nav__list" data-md-scrollfix>
 170
 171
 172
 173
 174
 175
 176
 177
 178     <li class="md-nav__item">
 179       <a href="../../getting-started/" class="md-nav__link">
 180         Getting Started
 181       </a>
 182     </li>
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
 197
 198
 199         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
 200
 201       <label class="md-nav__link" for="__nav_2">
 202         PHP API
 203         <span class="md-nav__icon md-icon"></span>
 204       </label>
 205       <nav class="md-nav" aria-label="PHP API" data-md-level="1">
 206         <label class="md-nav__title" for="__nav_2">
 207           <span class="md-nav__icon md-icon"></span>
 208           PHP API
 209         </label>
 210         <ul class="md-nav__list" data-md-scrollfix>
 211
 212
 213
 214
 215
 216
 217
 218     <li class="md-nav__item md-nav__item--active">
 219
 220       <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
 221
 222
 223
 224
 225         <label class="md-nav__link md-nav__link--active" for="__toc">
 226           Pages
 227           <span class="md-nav__icon md-icon"></span>
 228         </label>
 229
 230       <a href="./" class="md-nav__link md-nav__link--active">
 231         Pages
 232       </a>
 233
 234
 235 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
 236
 237
 238
 239
 240
 241     <label class="md-nav__title" for="__toc">
 242       <span class="md-nav__icon md-icon"></span>
 243       Table of contents
 244     </label>
 245     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 246
 247         <li class="md-nav__item">
 248   <a href="#abstractpage" class="md-nav__link">
 249     AbstractPage
 250   </a>
 251
 252     <nav class="md-nav" aria-label="AbstractPage">
 253       <ul class="md-nav__list">
 254
 255           <li class="md-nav__item">
 256   <a href="#method-chain" class="md-nav__link">
 257     Method Chain
 258   </a>
 259
 260     <nav class="md-nav" aria-label="Method Chain">
 261       <ul class="md-nav__list">
 262
 263           <li class="md-nav__item">
 264   <a href="#__run" class="md-nav__link">
 265     __run()
 266   </a>
 267
 268 </li>
 269
 270           <li class="md-nav__item">
 271   <a href="#readparameters" class="md-nav__link">
 272     readParameters()
 273   </a>
 274
 275 </li>
 276
 277           <li class="md-nav__item">
 278   <a href="#show" class="md-nav__link">
 279     show()
 280   </a>
 281
 282 </li>
 283
 284           <li class="md-nav__item">
 285   <a href="#readdata" class="md-nav__link">
 286     readData()
 287   </a>
 288
 289 </li>
 290
 291           <li class="md-nav__item">
 292   <a href="#assignvariables" class="md-nav__link">
 293     assignVariables()
 294   </a>
 295
 296 </li>
 297
 298       </ul>
 299     </nav>
 300
 301 </li>
 302
 303       </ul>
 304     </nav>
 305
 306 </li>
 307
 308         <li class="md-nav__item">
 309   <a href="#abstractform" class="md-nav__link">
 310     AbstractForm
 311   </a>
 312
 313     <nav class="md-nav" aria-label="AbstractForm">
 314       <ul class="md-nav__list">
 315
 316           <li class="md-nav__item">
 317   <a href="#method-chain_1" class="md-nav__link">
 318     Method Chain
 319   </a>
 320
 321     <nav class="md-nav" aria-label="Method Chain">
 322       <ul class="md-nav__list">
 323
 324           <li class="md-nav__item">
 325   <a href="#__run_1" class="md-nav__link">
 326     __run()
 327   </a>
 328
 329 </li>
 330
 331           <li class="md-nav__item">
 332   <a href="#readparameters_1" class="md-nav__link">
 333     readParameters()
 334   </a>
 335
 336 </li>
 337
 338           <li class="md-nav__item">
 339   <a href="#show_1" class="md-nav__link">
 340     show()
 341   </a>
 342
 343 </li>
 344
 345           <li class="md-nav__item">
 346   <a href="#submit" class="md-nav__link">
 347     submit()
 348   </a>
 349
 350 </li>
 351
 352           <li class="md-nav__item">
 353   <a href="#readformparameters" class="md-nav__link">
 354     readFormParameters()
 355   </a>
 356
 357 </li>
 358
 359           <li class="md-nav__item">
 360   <a href="#validate" class="md-nav__link">
 361     validate()
 362   </a>
 363
 364 </li>
 365
 366           <li class="md-nav__item">
 367   <a href="#save" class="md-nav__link">
 368     save()
 369   </a>
 370
 371 </li>
 372
 373           <li class="md-nav__item">
 374   <a href="#saved" class="md-nav__link">
 375     saved()
 376   </a>
 377
 378 </li>
 379
 380           <li class="md-nav__item">
 381   <a href="#readdata_1" class="md-nav__link">
 382     readData()
 383   </a>
 384
 385 </li>
 386
 387           <li class="md-nav__item">
 388   <a href="#assignvariables_1" class="md-nav__link">
 389     assignVariables()
 390   </a>
 391
 392 </li>
 393
 394       </ul>
 395     </nav>
 396
 397 </li>
 398
 399       </ul>
 400     </nav>
 401
 402 </li>
 403
 404     </ul>
 405
 406 </nav>
 407
 408     </li>
 409
 410
 411
 412
 413
 414
 415
 416     <li class="md-nav__item">
 417       <a href="../database-objects/" class="md-nav__link">
 418         Database Objects
 419       </a>
 420     </li>
 421
 422
 423
 424
 425
 426
 427
 428     <li class="md-nav__item">
 429       <a href="../database-access/" class="md-nav__link">
 430         Database Access
 431       </a>
 432     </li>
 433
 434
 435
 436
 437
 438
 439
 440     <li class="md-nav__item">
 441       <a href="../exceptions/" class="md-nav__link">
 442         Exceptions
 443       </a>
 444     </li>
 445
 446
 447
 448
 449
 450
 451
 452
 453     <li class="md-nav__item md-nav__item--nested">
 454
 455
 456         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
 457
 458       <label class="md-nav__link" for="__nav_2_5">
 459         API
 460         <span class="md-nav__icon md-icon"></span>
 461       </label>
 462       <nav class="md-nav" aria-label="API" data-md-level="2">
 463         <label class="md-nav__title" for="__nav_2_5">
 464           <span class="md-nav__icon md-icon"></span>
 465           API
 466         </label>
 467         <ul class="md-nav__list" data-md-scrollfix>
 468
 469
 470
 471
 472
 473     <li class="md-nav__item">
 474       <a href="../api/caches/" class="md-nav__link">
 475         Caches
 476       </a>
 477     </li>
 478
 479
 480
 481
 482
 483
 484
 485     <li class="md-nav__item">
 486       <a href="../api/comments/" class="md-nav__link">
 487         Comments
 488       </a>
 489     </li>
 490
 491
 492
 493
 494
 495
 496
 497     <li class="md-nav__item">
 498       <a href="../api/cronjobs/" class="md-nav__link">
 499         Cronjobs
 500       </a>
 501     </li>
 502
 503
 504
 505
 506
 507
 508
 509     <li class="md-nav__item">
 510       <a href="../api/events/" class="md-nav__link">
 511         Events
 512       </a>
 513     </li>
 514
 515
 516
 517
 518
 519
 520
 521
 522     <li class="md-nav__item md-nav__item--nested">
 523
 524
 525         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
 526
 527       <label class="md-nav__link" for="__nav_2_5_5">
 528         Form Builder
 529         <span class="md-nav__icon md-icon"></span>
 530       </label>
 531       <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
 532         <label class="md-nav__title" for="__nav_2_5_5">
 533           <span class="md-nav__icon md-icon"></span>
 534           Form Builder
 535         </label>
 536         <ul class="md-nav__list" data-md-scrollfix>
 537
 538
 539
 540
 541
 542     <li class="md-nav__item">
 543       <a href="../api/form_builder/overview/" class="md-nav__link">
 544         Overview
 545       </a>
 546     </li>
 547
 548
 549
 550
 551
 552
 553
 554     <li class="md-nav__item">
 555       <a href="../api/form_builder/structure/" class="md-nav__link">
 556         Structure
 557       </a>
 558     </li>
 559
 560
 561
 562
 563
 564
 565
 566     <li class="md-nav__item">
 567       <a href="../api/form_builder/form_fields/" class="md-nav__link">
 568         Fields
 569       </a>
 570     </li>
 571
 572
 573
 574
 575
 576
 577
 578     <li class="md-nav__item">
 579       <a href="../api/form_builder/validation_data/" class="md-nav__link">
 580         Validation and Data
 581       </a>
 582     </li>
 583
 584
 585
 586
 587
 588
 589
 590     <li class="md-nav__item">
 591       <a href="../api/form_builder/dependencies/" class="md-nav__link">
 592         Dependencies
 593       </a>
 594     </li>
 595
 596
 597
 598         </ul>
 599       </nav>
 600     </li>
 601
 602
 603
 604
 605
 606
 607
 608     <li class="md-nav__item">
 609       <a href="../api/package_installation_plugins/" class="md-nav__link">
 610         Package Installation Plugins
 611       </a>
 612     </li>
 613
 614
 615
 616
 617
 618
 619
 620     <li class="md-nav__item">
 621       <a href="../api/user_activity_points/" class="md-nav__link">
 622         User Activity Points
 623       </a>
 624     </li>
 625
 626
 627
 628
 629
 630
 631
 632     <li class="md-nav__item">
 633       <a href="../api/user_notifications/" class="md-nav__link">
 634         User Notifications
 635       </a>
 636     </li>
 637
 638
 639
 640
 641
 642
 643
 644     <li class="md-nav__item">
 645       <a href="../api/sitemaps/" class="md-nav__link">
 646         Sitemaps
 647       </a>
 648     </li>
 649
 650
 651
 652         </ul>
 653       </nav>
 654     </li>
 655
 656
 657
 658
 659
 660
 661
 662     <li class="md-nav__item">
 663       <a href="../code-style/" class="md-nav__link">
 664         Code Style
 665       </a>
 666     </li>
 667
 668
 669
 670
 671
 672
 673
 674     <li class="md-nav__item">
 675       <a href="../apps/" class="md-nav__link">
 676         Apps
 677       </a>
 678     </li>
 679
 680
 681
 682
 683
 684
 685
 686     <li class="md-nav__item">
 687       <a href="../gdpr/" class="md-nav__link">
 688         GDPR
 689       </a>
 690     </li>
 691
 692
 693
 694         </ul>
 695       </nav>
 696     </li>
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708     <li class="md-nav__item md-nav__item--nested">
 709
 710
 711         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
 712
 713       <label class="md-nav__link" for="__nav_3">
 714         Languages, Templates & CSS
 715         <span class="md-nav__icon md-icon"></span>
 716       </label>
 717       <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
 718         <label class="md-nav__title" for="__nav_3">
 719           <span class="md-nav__icon md-icon"></span>
 720           Languages, Templates & CSS
 721         </label>
 722         <ul class="md-nav__list" data-md-scrollfix>
 723
 724
 725
 726
 727
 728     <li class="md-nav__item">
 729       <a href="../../view/languages/" class="md-nav__link">
 730         Languages
 731       </a>
 732     </li>
 733
 734
 735
 736
 737
 738
 739
 740     <li class="md-nav__item">
 741       <a href="../../view/templates/" class="md-nav__link">
 742         Templates
 743       </a>
 744     </li>
 745
 746
 747
 748
 749
 750
 751
 752     <li class="md-nav__item">
 753       <a href="../../view/css/" class="md-nav__link">
 754         CSS
 755       </a>
 756     </li>
 757
 758
 759
 760         </ul>
 761       </nav>
 762     </li>
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774     <li class="md-nav__item md-nav__item--nested">
 775
 776
 777         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
 778
 779       <label class="md-nav__link" for="__nav_4">
 780         JavaScript API
 781         <span class="md-nav__icon md-icon"></span>
 782       </label>
 783       <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
 784         <label class="md-nav__title" for="__nav_4">
 785           <span class="md-nav__icon md-icon"></span>
 786           JavaScript API
 787         </label>
 788         <ul class="md-nav__list" data-md-scrollfix>
 789
 790
 791
 792
 793
 794     <li class="md-nav__item">
 795       <a href="../../javascript/general-usage/" class="md-nav__link">
 796         General Usage
 797       </a>
 798     </li>
 799
 800
 801
 802
 803
 804
 805
 806
 807     <li class="md-nav__item md-nav__item--nested">
 808
 809
 810         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
 811
 812       <label class="md-nav__link" for="__nav_4_2">
 813         New API
 814         <span class="md-nav__icon md-icon"></span>
 815       </label>
 816       <nav class="md-nav" aria-label="New API" data-md-level="2">
 817         <label class="md-nav__title" for="__nav_4_2">
 818           <span class="md-nav__icon md-icon"></span>
 819           New API
 820         </label>
 821         <ul class="md-nav__list" data-md-scrollfix>
 822
 823
 824
 825
 826
 827     <li class="md-nav__item">
 828       <a href="../../javascript/new-api_writing-a-module/" class="md-nav__link">
 829         Writing a module
 830       </a>
 831     </li>
 832
 833
 834
 835
 836
 837
 838
 839     <li class="md-nav__item">
 840       <a href="../../javascript/new-api_data-structures/" class="md-nav__link">
 841         Data Structures
 842       </a>
 843     </li>
 844
 845
 846
 847
 848
 849
 850
 851     <li class="md-nav__item">
 852       <a href="../../javascript/new-api_core/" class="md-nav__link">
 853         Core Functions
 854       </a>
 855     </li>
 856
 857
 858
 859
 860
 861
 862
 863     <li class="md-nav__item">
 864       <a href="../../javascript/new-api_dom/" class="md-nav__link">
 865         DOM
 866       </a>
 867     </li>
 868
 869
 870
 871
 872
 873
 874
 875     <li class="md-nav__item">
 876       <a href="../../javascript/new-api_events/" class="md-nav__link">
 877         Event Handling
 878       </a>
 879     </li>
 880
 881
 882
 883
 884
 885
 886
 887     <li class="md-nav__item">
 888       <a href="../../javascript/new-api_ajax/" class="md-nav__link">
 889         Ajax
 890       </a>
 891     </li>
 892
 893
 894
 895
 896
 897
 898
 899     <li class="md-nav__item">
 900       <a href="../../javascript/new-api_dialogs/" class="md-nav__link">
 901         Dialogs
 902       </a>
 903     </li>
 904
 905
 906
 907
 908
 909
 910
 911     <li class="md-nav__item">
 912       <a href="../../javascript/new-api_browser/" class="md-nav__link">
 913         Browser and Screen Sizes
 914       </a>
 915     </li>
 916
 917
 918
 919
 920
 921
 922
 923     <li class="md-nav__item">
 924       <a href="../../javascript/new-api_ui/" class="md-nav__link">
 925         User Interface
 926       </a>
 927     </li>
 928
 929
 930
 931         </ul>
 932       </nav>
 933     </li>
 934
 935
 936
 937
 938
 939
 940
 941     <li class="md-nav__item">
 942       <a href="../../javascript/legacy-api/" class="md-nav__link">
 943         Legacy API
 944       </a>
 945     </li>
 946
 947
 948
 949
 950
 951
 952
 953     <li class="md-nav__item">
 954       <a href="../../javascript/helper-functions/" class="md-nav__link">
 955         Helper Functions
 956       </a>
 957     </li>
 958
 959
 960
 961
 962
 963
 964
 965     <li class="md-nav__item">
 966       <a href="../../javascript/code-snippets/" class="md-nav__link">
 967         Code Snippets
 968       </a>
 969     </li>
 970
 971
 972
 973         </ul>
 974       </nav>
 975     </li>
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987     <li class="md-nav__item md-nav__item--nested">
 988
 989
 990         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
 991
 992       <label class="md-nav__link" for="__nav_5">
 993         Package Components
 994         <span class="md-nav__icon md-icon"></span>
 995       </label>
 996       <nav class="md-nav" aria-label="Package Components" data-md-level="1">
 997         <label class="md-nav__title" for="__nav_5">
 998           <span class="md-nav__icon md-icon"></span>
 999           Package Components
1000         </label>
1001         <ul class="md-nav__list" data-md-scrollfix>
1002
1003
1004
1005
1006
1007     <li class="md-nav__item">
1008       <a href="../../package/package-xml/" class="md-nav__link">
1009         package.xml
1010       </a>
1011     </li>
1012
1013
1014
1015
1016
1017
1018
1019
1020     <li class="md-nav__item md-nav__item--nested">
1021
1022
1023         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
1024
1025       <label class="md-nav__link" for="__nav_5_2">
1026         PIPs
1027         <span class="md-nav__icon md-icon"></span>
1028       </label>
1029       <nav class="md-nav" aria-label="PIPs" data-md-level="2">
1030         <label class="md-nav__title" for="__nav_5_2">
1031           <span class="md-nav__icon md-icon"></span>
1032           PIPs
1033         </label>
1034         <ul class="md-nav__list" data-md-scrollfix>
1035
1036
1037
1038
1039
1040     <li class="md-nav__item">
1041       <a href="../../package/pip/" class="md-nav__link">
1042         Overview
1043       </a>
1044     </li>
1045
1046
1047
1048
1049
1050
1051
1052     <li class="md-nav__item">
1053       <a href="../../package/pip/acl-option/" class="md-nav__link">
1054         aclOption
1055       </a>
1056     </li>
1057
1058
1059
1060
1061
1062
1063
1064     <li class="md-nav__item">
1065       <a href="../../package/pip/acp-menu/" class="md-nav__link">
1066         acpMenu
1067       </a>
1068     </li>
1069
1070
1071
1072
1073
1074
1075
1076     <li class="md-nav__item">
1077       <a href="../../package/pip/acp-search-provider/" class="md-nav__link">
1078         acpSearchProvider
1079       </a>
1080     </li>
1081
1082
1083
1084
1085
1086
1087
1088     <li class="md-nav__item">
1089       <a href="../../package/pip/acp-template/" class="md-nav__link">
1090         acpTemplate
1091       </a>
1092     </li>
1093
1094
1095
1096
1097
1098
1099
1100     <li class="md-nav__item">
1101       <a href="../../package/pip/bbcode/" class="md-nav__link">
1102         bbcode
1103       </a>
1104     </li>
1105
1106
1107
1108
1109
1110
1111
1112     <li class="md-nav__item">
1113       <a href="../../package/pip/box/" class="md-nav__link">
1114         box
1115       </a>
1116     </li>
1117
1118
1119
1120
1121
1122
1123
1124     <li class="md-nav__item">
1125       <a href="../../package/pip/clipboard-action/" class="md-nav__link">
1126         clipboardAction
1127       </a>
1128     </li>
1129
1130
1131
1132
1133
1134
1135
1136     <li class="md-nav__item">
1137       <a href="../../package/pip/core-object/" class="md-nav__link">
1138         coreObject
1139       </a>
1140     </li>
1141
1142
1143
1144
1145
1146
1147
1148     <li class="md-nav__item">
1149       <a href="../../package/pip/cronjob/" class="md-nav__link">
1150         cronjob
1151       </a>
1152     </li>
1153
1154
1155
1156
1157
1158
1159
1160     <li class="md-nav__item">
1161       <a href="../../package/pip/event-listener/" class="md-nav__link">
1162         eventListener
1163       </a>
1164     </li>
1165
1166
1167
1168
1169
1170
1171
1172     <li class="md-nav__item">
1173       <a href="../../package/pip/file/" class="md-nav__link">
1174         file
1175       </a>
1176     </li>
1177
1178
1179
1180
1181
1182
1183
1184     <li class="md-nav__item">
1185       <a href="../../package/pip/language/" class="md-nav__link">
1186         language
1187       </a>
1188     </li>
1189
1190
1191
1192
1193
1194
1195
1196     <li class="md-nav__item">
1197       <a href="../../package/pip/media-provider/" class="md-nav__link">
1198         mediaProvider
1199       </a>
1200     </li>
1201
1202
1203
1204
1205
1206
1207
1208     <li class="md-nav__item">
1209       <a href="../../package/pip/menu/" class="md-nav__link">
1210         menu
1211       </a>
1212     </li>
1213
1214
1215
1216
1217
1218
1219
1220     <li class="md-nav__item">
1221       <a href="../../package/pip/menu-item/" class="md-nav__link">
1222         menuItem
1223       </a>
1224     </li>
1225
1226
1227
1228
1229
1230
1231
1232     <li class="md-nav__item">
1233       <a href="../../package/pip/object-type/" class="md-nav__link">
1234         objectType
1235       </a>
1236     </li>
1237
1238
1239
1240
1241
1242
1243
1244     <li class="md-nav__item">
1245       <a href="../../package/pip/object-type-definition/" class="md-nav__link">
1246         objectTypeDefinition
1247       </a>
1248     </li>
1249
1250
1251
1252
1253
1254
1255
1256     <li class="md-nav__item">
1257       <a href="../../package/pip/option/" class="md-nav__link">
1258         option
1259       </a>
1260     </li>
1261
1262
1263
1264
1265
1266
1267
1268     <li class="md-nav__item">
1269       <a href="../../package/pip/page/" class="md-nav__link">
1270         page
1271       </a>
1272     </li>
1273
1274
1275
1276
1277
1278
1279
1280     <li class="md-nav__item">
1281       <a href="../../package/pip/pip/" class="md-nav__link">
1282         pip
1283       </a>
1284     </li>
1285
1286
1287
1288
1289
1290
1291
1292     <li class="md-nav__item">
1293       <a href="../../package/pip/script/" class="md-nav__link">
1294         script
1295       </a>
1296     </li>
1297
1298
1299
1300
1301
1302
1303
1304     <li class="md-nav__item">
1305       <a href="../../package/pip/smiley/" class="md-nav__link">
1306         smiley
1307       </a>
1308     </li>
1309
1310
1311
1312
1313
1314
1315
1316     <li class="md-nav__item">
1317       <a href="../../package/pip/sql/" class="md-nav__link">
1318         sql
1319       </a>
1320     </li>
1321
1322
1323
1324
1325
1326
1327
1328     <li class="md-nav__item">
1329       <a href="../../package/pip/style/" class="md-nav__link">
1330         style
1331       </a>
1332     </li>
1333
1334
1335
1336
1337
1338
1339
1340     <li class="md-nav__item">
1341       <a href="../../package/pip/template/" class="md-nav__link">
1342         template
1343       </a>
1344     </li>
1345
1346
1347
1348
1349
1350
1351
1352     <li class="md-nav__item">
1353       <a href="../../package/pip/template-listener/" class="md-nav__link">
1354         templateListener
1355       </a>
1356     </li>
1357
1358
1359
1360
1361
1362
1363
1364     <li class="md-nav__item">
1365       <a href="../../package/pip/user-group-option/" class="md-nav__link">
1366         userGroupOption
1367       </a>
1368     </li>
1369
1370
1371
1372
1373
1374
1375
1376     <li class="md-nav__item">
1377       <a href="../../package/pip/user-menu/" class="md-nav__link">
1378         userMenu
1379       </a>
1380     </li>
1381
1382
1383
1384
1385
1386
1387
1388     <li class="md-nav__item">
1389       <a href="../../package/pip/user-notification-event/" class="md-nav__link">
1390         userNotificationEvent
1391       </a>
1392     </li>
1393
1394
1395
1396
1397
1398
1399
1400     <li class="md-nav__item">
1401       <a href="../../package/pip/user-option/" class="md-nav__link">
1402         userOption
1403       </a>
1404     </li>
1405
1406
1407
1408
1409
1410
1411
1412     <li class="md-nav__item">
1413       <a href="../../package/pip/user-profile-menu/" class="md-nav__link">
1414         userProfileMenu
1415       </a>
1416     </li>
1417
1418
1419
1420         </ul>
1421       </nav>
1422     </li>
1423
1424
1425
1426
1427
1428
1429
1430     <li class="md-nav__item">
1431       <a href="../../package/database-php-api/" class="md-nav__link">
1432         Database PHP API
1433       </a>
1434     </li>
1435
1436
1437
1438         </ul>
1439       </nav>
1440     </li>
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452     <li class="md-nav__item md-nav__item--nested">
1453
1454
1455         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1456
1457       <label class="md-nav__link" for="__nav_6">
1458         Migration
1459         <span class="md-nav__icon md-icon"></span>
1460       </label>
1461       <nav class="md-nav" aria-label="Migration" data-md-level="1">
1462         <label class="md-nav__title" for="__nav_6">
1463           <span class="md-nav__icon md-icon"></span>
1464           Migration
1465         </label>
1466         <ul class="md-nav__list" data-md-scrollfix>
1467
1468
1469
1470
1471
1472
1473     <li class="md-nav__item md-nav__item--nested">
1474
1475
1476         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1477
1478       <label class="md-nav__link" for="__nav_6_1">
1479         Migrating from WSC 5.3
1480         <span class="md-nav__icon md-icon"></span>
1481       </label>
1482       <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1483         <label class="md-nav__title" for="__nav_6_1">
1484           <span class="md-nav__icon md-icon"></span>
1485           Migrating from WSC 5.3
1486         </label>
1487         <ul class="md-nav__list" data-md-scrollfix>
1488
1489
1490
1491
1492
1493     <li class="md-nav__item">
1494       <a href="../../migration/wsc53/php/" class="md-nav__link">
1495         PHP API
1496       </a>
1497     </li>
1498
1499
1500
1501
1502
1503
1504
1505     <li class="md-nav__item">
1506       <a href="../../migration/wsc53/session/" class="md-nav__link">
1507         Session Handling and Authentication
1508       </a>
1509     </li>
1510
1511
1512
1513
1514
1515
1516
1517     <li class="md-nav__item">
1518       <a href="../../migration/wsc53/javascript/" class="md-nav__link">
1519         JavaScript
1520       </a>
1521     </li>
1522
1523
1524
1525
1526
1527
1528
1529     <li class="md-nav__item">
1530       <a href="../../migration/wsc53/templates/" class="md-nav__link">
1531         Templates
1532       </a>
1533     </li>
1534
1535
1536
1537
1538
1539
1540
1541     <li class="md-nav__item">
1542       <a href="../../migration/wsc53/libraries/" class="md-nav__link">
1543         Third Party Libraries
1544       </a>
1545     </li>
1546
1547
1548
1549         </ul>
1550       </nav>
1551     </li>
1552
1553
1554
1555
1556
1557
1558
1559
1560     <li class="md-nav__item md-nav__item--nested">
1561
1562
1563         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1564
1565       <label class="md-nav__link" for="__nav_6_2">
1566         Migrating from WSC 5.2
1567         <span class="md-nav__icon md-icon"></span>
1568       </label>
1569       <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1570         <label class="md-nav__title" for="__nav_6_2">
1571           <span class="md-nav__icon md-icon"></span>
1572           Migrating from WSC 5.2
1573         </label>
1574         <ul class="md-nav__list" data-md-scrollfix>
1575
1576
1577
1578
1579
1580     <li class="md-nav__item">
1581       <a href="../../migration/wsc52/php/" class="md-nav__link">
1582         PHP API
1583       </a>
1584     </li>
1585
1586
1587
1588
1589
1590
1591
1592     <li class="md-nav__item">
1593       <a href="../../migration/wsc52/templates/" class="md-nav__link">
1594         Templates and Languages
1595       </a>
1596     </li>
1597
1598
1599
1600
1601
1602
1603
1604     <li class="md-nav__item">
1605       <a href="../../migration/wsc52/libraries/" class="md-nav__link">
1606         Third Party Libraries
1607       </a>
1608     </li>
1609
1610
1611
1612         </ul>
1613       </nav>
1614     </li>
1615
1616
1617
1618
1619
1620
1621
1622
1623     <li class="md-nav__item md-nav__item--nested">
1624
1625
1626         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1627
1628       <label class="md-nav__link" for="__nav_6_3">
1629         Migrating from WSC 3.1
1630         <span class="md-nav__icon md-icon"></span>
1631       </label>
1632       <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1633         <label class="md-nav__title" for="__nav_6_3">
1634           <span class="md-nav__icon md-icon"></span>
1635           Migrating from WSC 3.1
1636         </label>
1637         <ul class="md-nav__list" data-md-scrollfix>
1638
1639
1640
1641
1642
1643     <li class="md-nav__item">
1644       <a href="../../migration/wsc31/php/" class="md-nav__link">
1645         PHP API
1646       </a>
1647     </li>
1648
1649
1650
1651         </ul>
1652       </nav>
1653     </li>
1654
1655
1656
1657
1658
1659
1660
1661
1662     <li class="md-nav__item md-nav__item--nested">
1663
1664
1665         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1666
1667       <label class="md-nav__link" for="__nav_6_4">
1668         Migrating from WSC 3.0
1669         <span class="md-nav__icon md-icon"></span>
1670       </label>
1671       <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1672         <label class="md-nav__title" for="__nav_6_4">
1673           <span class="md-nav__icon md-icon"></span>
1674           Migrating from WSC 3.0
1675         </label>
1676         <ul class="md-nav__list" data-md-scrollfix>
1677
1678
1679
1680
1681
1682     <li class="md-nav__item">
1683       <a href="../../migration/wsc30/php/" class="md-nav__link">
1684         PHP API
1685       </a>
1686     </li>
1687
1688
1689
1690
1691
1692
1693
1694     <li class="md-nav__item">
1695       <a href="../../migration/wsc30/javascript/" class="md-nav__link">
1696         JavaScript API
1697       </a>
1698     </li>
1699
1700
1701
1702
1703
1704
1705
1706     <li class="md-nav__item">
1707       <a href="../../migration/wsc30/templates/" class="md-nav__link">
1708         Templates
1709       </a>
1710     </li>
1711
1712
1713
1714
1715
1716
1717
1718     <li class="md-nav__item">
1719       <a href="../../migration/wsc30/css/" class="md-nav__link">
1720         CSS
1721       </a>
1722     </li>
1723
1724
1725
1726
1727
1728
1729
1730     <li class="md-nav__item">
1731       <a href="../../migration/wsc30/package/" class="md-nav__link">
1732         Package Components
1733       </a>
1734     </li>
1735
1736
1737
1738         </ul>
1739       </nav>
1740     </li>
1741
1742
1743
1744
1745
1746
1747
1748
1749     <li class="md-nav__item md-nav__item--nested">
1750
1751
1752         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1753
1754       <label class="md-nav__link" for="__nav_6_5">
1755         Migrating from WCF 2.1
1756         <span class="md-nav__icon md-icon"></span>
1757       </label>
1758       <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1759         <label class="md-nav__title" for="__nav_6_5">
1760           <span class="md-nav__icon md-icon"></span>
1761           Migrating from WCF 2.1
1762         </label>
1763         <ul class="md-nav__list" data-md-scrollfix>
1764
1765
1766
1767
1768
1769     <li class="md-nav__item">
1770       <a href="../../migration/wcf21/php/" class="md-nav__link">
1771         PHP API
1772       </a>
1773     </li>
1774
1775
1776
1777
1778
1779
1780
1781     <li class="md-nav__item">
1782       <a href="../../migration/wcf21/templates/" class="md-nav__link">
1783         Templates
1784       </a>
1785     </li>
1786
1787
1788
1789
1790
1791
1792
1793     <li class="md-nav__item">
1794       <a href="../../migration/wcf21/css/" class="md-nav__link">
1795         CSS
1796       </a>
1797     </li>
1798
1799
1800
1801
1802
1803
1804
1805     <li class="md-nav__item">
1806       <a href="../../migration/wcf21/package/" class="md-nav__link">
1807         Package Components
1808       </a>
1809     </li>
1810
1811
1812
1813         </ul>
1814       </nav>
1815     </li>
1816
1817
1818
1819         </ul>
1820       </nav>
1821     </li>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833     <li class="md-nav__item md-nav__item--nested">
1834
1835
1836         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1837
1838       <label class="md-nav__link" for="__nav_7">
1839         Tutorials
1840         <span class="md-nav__icon md-icon"></span>
1841       </label>
1842       <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1843         <label class="md-nav__title" for="__nav_7">
1844           <span class="md-nav__icon md-icon"></span>
1845           Tutorials
1846         </label>
1847         <ul class="md-nav__list" data-md-scrollfix>
1848
1849
1850
1851
1852
1853
1854     <li class="md-nav__item md-nav__item--nested">
1855
1856
1857         <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1858
1859       <label class="md-nav__link" for="__nav_7_1">
1860         Tutorial Series
1861         <span class="md-nav__icon md-icon"></span>
1862       </label>
1863       <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1864         <label class="md-nav__title" for="__nav_7_1">
1865           <span class="md-nav__icon md-icon"></span>
1866           Tutorial Series
1867         </label>
1868         <ul class="md-nav__list" data-md-scrollfix>
1869
1870
1871
1872
1873
1874     <li class="md-nav__item">
1875       <a href="../../tutorial/series/overview/" class="md-nav__link">
1876         Overview
1877       </a>
1878     </li>
1879
1880
1881
1882
1883
1884
1885
1886     <li class="md-nav__item">
1887       <a href="../../tutorial/series/part_1/" class="md-nav__link">
1888         Part 1
1889       </a>
1890     </li>
1891
1892
1893
1894
1895
1896
1897
1898     <li class="md-nav__item">
1899       <a href="../../tutorial/series/part_2/" class="md-nav__link">
1900         Part 2
1901       </a>
1902     </li>
1903
1904
1905
1906
1907
1908
1909
1910     <li class="md-nav__item">
1911       <a href="../../tutorial/series/part_3/" class="md-nav__link">
1912         Part 3
1913       </a>
1914     </li>
1915
1916
1917
1918         </ul>
1919       </nav>
1920     </li>
1921
1922
1923
1924         </ul>
1925       </nav>
1926     </li>
1927
1928
1929
1930   </ul>
1931 </nav>
1932                   </div>
1933                 </div>
1934               </div>
1935
1936
1937
1938               <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1939                 <div class="md-sidebar__scrollwrap">
1940                   <div class="md-sidebar__inner">
1941
1942 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1943
1944
1945
1946
1947
1948     <label class="md-nav__title" for="__toc">
1949       <span class="md-nav__icon md-icon"></span>
1950       Table of contents
1951     </label>
1952     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1953
1954         <li class="md-nav__item">
1955   <a href="#abstractpage" class="md-nav__link">
1956     AbstractPage
1957   </a>
1958
1959     <nav class="md-nav" aria-label="AbstractPage">
1960       <ul class="md-nav__list">
1961
1962           <li class="md-nav__item">
1963   <a href="#method-chain" class="md-nav__link">
1964     Method Chain
1965   </a>
1966
1967     <nav class="md-nav" aria-label="Method Chain">
1968       <ul class="md-nav__list">
1969
1970           <li class="md-nav__item">
1971   <a href="#__run" class="md-nav__link">
1972     __run()
1973   </a>
1974
1975 </li>
1976
1977           <li class="md-nav__item">
1978   <a href="#readparameters" class="md-nav__link">
1979     readParameters()
1980   </a>
1981
1982 </li>
1983
1984           <li class="md-nav__item">
1985   <a href="#show" class="md-nav__link">
1986     show()
1987   </a>
1988
1989 </li>
1990
1991           <li class="md-nav__item">
1992   <a href="#readdata" class="md-nav__link">
1993     readData()
1994   </a>
1995
1996 </li>
1997
1998           <li class="md-nav__item">
1999   <a href="#assignvariables" class="md-nav__link">
2000     assignVariables()
2001   </a>
2002
2003 </li>
2004
2005       </ul>
2006     </nav>
2007
2008 </li>
2009
2010       </ul>
2011     </nav>
2012
2013 </li>
2014
2015         <li class="md-nav__item">
2016   <a href="#abstractform" class="md-nav__link">
2017     AbstractForm
2018   </a>
2019
2020     <nav class="md-nav" aria-label="AbstractForm">
2021       <ul class="md-nav__list">
2022
2023           <li class="md-nav__item">
2024   <a href="#method-chain_1" class="md-nav__link">
2025     Method Chain
2026   </a>
2027
2028     <nav class="md-nav" aria-label="Method Chain">
2029       <ul class="md-nav__list">
2030
2031           <li class="md-nav__item">
2032   <a href="#__run_1" class="md-nav__link">
2033     __run()
2034   </a>
2035
2036 </li>
2037
2038           <li class="md-nav__item">
2039   <a href="#readparameters_1" class="md-nav__link">
2040     readParameters()
2041   </a>
2042
2043 </li>
2044
2045           <li class="md-nav__item">
2046   <a href="#show_1" class="md-nav__link">
2047     show()
2048   </a>
2049
2050 </li>
2051
2052           <li class="md-nav__item">
2053   <a href="#submit" class="md-nav__link">
2054     submit()
2055   </a>
2056
2057 </li>
2058
2059           <li class="md-nav__item">
2060   <a href="#readformparameters" class="md-nav__link">
2061     readFormParameters()
2062   </a>
2063
2064 </li>
2065
2066           <li class="md-nav__item">
2067   <a href="#validate" class="md-nav__link">
2068     validate()
2069   </a>
2070
2071 </li>
2072
2073           <li class="md-nav__item">
2074   <a href="#save" class="md-nav__link">
2075     save()
2076   </a>
2077
2078 </li>
2079
2080           <li class="md-nav__item">
2081   <a href="#saved" class="md-nav__link">
2082     saved()
2083   </a>
2084
2085 </li>
2086
2087           <li class="md-nav__item">
2088   <a href="#readdata_1" class="md-nav__link">
2089     readData()
2090   </a>
2091
2092 </li>
2093
2094           <li class="md-nav__item">
2095   <a href="#assignvariables_1" class="md-nav__link">
2096     assignVariables()
2097   </a>
2098
2099 </li>
2100
2101       </ul>
2102     </nav>
2103
2104 </li>
2105
2106       </ul>
2107     </nav>
2108
2109 </li>
2110
2111     </ul>
2112
2113 </nav>
2114                   </div>
2115                 </div>
2116               </div>
2117
2118
2119           <div class="md-content" data-md-component="content">
2120             <article class="md-content__inner md-typeset">
2121
2122
2123                   <a href="https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/pages.md" title="Edit this page" class="md-content__button md-icon">
2124                     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2125                   </a>
2126
2127
2128                 <h1 id="page-types">Page Types<a class="headerlink" href="#page-types" title="Permanent link">#</a></h1>
2129 <h2 id="abstractpage">AbstractPage<a class="headerlink" href="#abstractpage" title="Permanent link">#</a></h2>
2130 <p>The default implementation for pages to present any sort of content, but are designed to handle <code>GET</code> requests only. They usually follow a fixed method chain that will be invoked one after another, adding logical sections to the request flow.</p>
2131 <h3 id="method-chain">Method Chain<a class="headerlink" href="#method-chain" title="Permanent link">#</a></h3>
2132 <h4 id="__run">__run()<a class="headerlink" href="#__run" title="Permanent link">#</a></h4>
2133 <p>This is the only method being invoked from the outside and starts the whole chain.</p>
2134 <h4 id="readparameters">readParameters()<a class="headerlink" href="#readparameters" title="Permanent link">#</a></h4>
2135 <p>Reads and sanitizes request parameters, this should be the only method to ever read user-supplied input. Read data should be stored in class properties to be accessible at a later point, allowing your code to safely assume that the data has been sanitized and is safe to work with.</p>
2136 <p>A typical example is the board page from the forum app that reads the id and attempts to identify the request forum.</p>
2137 <div class="highlight"><pre><span></span><code><span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
2138     <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
2139
2140     <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">boardID</span> <span class="o">=</span> <span class="nb">intval</span><span class="p">(</span><span class="nv">$_REQUEST</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">]);</span>
2141     <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">board</span> <span class="o">=</span> <span class="nx">BoardCache</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">getBoard</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">boardID</span><span class="p">);</span>
2142     <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">board</span> <span class="o">===</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
2143         <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
2144     <span class="p">}</span>
2145
2146     <span class="c1">// check permissions</span>
2147     <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">board</span><span class="o">-&gt;</span><span class="na">canEnter</span><span class="p">())</span> <span class="p">{</span>
2148         <span class="k">throw</span> <span class="k">new</span> <span class="nx">PermissionDeniedException</span><span class="p">();</span>
2149     <span class="p">}</span>
2150 <span class="p">}</span>
2151 </code></pre></div>
2152 <p><span class="label label-info">Events</span> <code>readParameters</code></p>
2153 <h4 id="show">show()<a class="headerlink" href="#show" title="Permanent link">#</a></h4>
2154 <p>Used to be the method of choice to handle permissions and module option checks, but has been used almost entirely as an internal method since the introduction of the properties <code>$loginRequired</code>, <code>$neededModules</code> and <code>$neededPermissions</code>.</p>
2155 <p><span class="label label-info">Events</span> <code>checkModules</code>, <code>checkPermissions</code> and <code>show</code></p>
2156 <h4 id="readdata">readData()<a class="headerlink" href="#readdata" title="Permanent link">#</a></h4>
2157 <p>Central method for data retrieval based on class properties including those populated with user data in <code>readParameters()</code>. It is strongly recommended to use this method to read data in order to properly separate the business logic present in your class.</p>
2158 <p><span class="label label-info">Events</span> <code>readData</code></p>
2159 <h4 id="assignvariables">assignVariables()<a class="headerlink" href="#assignvariables" title="Permanent link">#</a></h4>
2160 <p>Last method call before the template engine kicks in and renders the template. All though some properties are bound to the template automatically, you still need to pass any custom variables and class properties to the engine to make them available in templates.</p>
2161 <p>Following the example in <code>readParameters()</code>, the code below adds the board data to the template.</p>
2162 <div class="highlight"><pre><span></span><code><span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
2163     <span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
2164
2165     <span class="nx">WCF</span><span class="o">::</span><span class="na">getTPL</span><span class="p">()</span><span class="o">-&gt;</span><span class="na">assign</span><span class="p">([</span>
2166         <span class="s1">&#39;board&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">board</span><span class="p">,</span>
2167         <span class="s1">&#39;boardID&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">boardID</span>
2168     <span class="p">]);</span>
2169 <span class="p">}</span>
2170 </code></pre></div>
2171 <p><span class="label label-info">Events</span> <code>assignVariables</code></p>
2172 <h2 id="abstractform">AbstractForm<a class="headerlink" href="#abstractform" title="Permanent link">#</a></h2>
2173 <p>Extends the AbstractPage implementation with additional methods designed to handle form submissions properly.</p>
2174 <h3 id="method-chain_1">Method Chain<a class="headerlink" href="#method-chain_1" title="Permanent link">#</a></h3>
2175 <h4 id="__run_1">__run()<a class="headerlink" href="#__run_1" title="Permanent link">#</a></h4>
2176 <p><em>Inherited from AbstractPage.</em></p>
2177 <h4 id="readparameters_1">readParameters()<a class="headerlink" href="#readparameters_1" title="Permanent link">#</a></h4>
2178 <p><em>Inherited from AbstractPage.</em></p>
2179 <h4 id="show_1">show()<a class="headerlink" href="#show_1" title="Permanent link">#</a></h4>
2180 <p><em>Inherited from AbstractPage.</em></p>
2181 <h4 id="submit">submit()<a class="headerlink" href="#submit" title="Permanent link">#</a></h4>
2182 <div class="admonition warning">
2183 <p class="admonition-title">The methods <code>submit()</code> up until <code>save()</code> are only invoked if either <code>$_POST</code> or <code>$_FILES</code> are not empty, otherwise they won't be invoked and the execution will continue with <code>readData()</code>.</p>
2184 </div>
2185 <p>This is an internal method that is responsible of input processing and validation.</p>
2186 <p><span class="label label-info">Events</span> <code>submit</code></p>
2187 <h4 id="readformparameters">readFormParameters()<a class="headerlink" href="#readformparameters" title="Permanent link">#</a></h4>
2188 <p>This method is quite similar to <code>readParameters()</code> that is being called earlier, but is designed around reading form data submitted through POST requests. You should avoid accessing <code>$_GET</code> or <code>$_REQUEST</code> in this context to avoid mixing up parameters evaluated when retrieving the page on first load and when submitting to it.</p>
2189 <p><span class="label label-info">Events</span> <code>readFormParameters</code></p>
2190 <h4 id="validate">validate()<a class="headerlink" href="#validate" title="Permanent link">#</a></h4>
2191 <p>Deals with input validation and automatically catches exceptions deriving from <code>wcf\system\exception\UserInputException</code>, resulting in a clean and consistent error handling for the user.</p>
2192 <p><span class="label label-info">Events</span> <code>validate</code></p>
2193 <h4 id="save">save()<a class="headerlink" href="#save" title="Permanent link">#</a></h4>
2194 <p>Saves the processed data to database or any other source of your choice. Please keep in mind to invoke <code>$this-&gt;saved()</code> before resetting the form data.</p>
2195 <p><span class="label label-info">Events</span> <code>save</code></p>
2196 <h4 id="saved">saved()<a class="headerlink" href="#saved" title="Permanent link">#</a></h4>
2197 <div class="admonition warning">
2198 <p class="admonition-title">This method is not called automatically and must be invoked manually by executing <code>$this-&gt;saved()</code> inside <code>save()</code>.</p>
2199 </div>
2200 <p>The only purpose of this method is to fire the event <code>saved</code> that signals that the form data has been processed successfully and data has been saved. It is somewhat special as it is dispatched after the data has been saved, but before the data is purged during form reset. This is by default the last event that has access to the processed data.</p>
2201 <p><span class="label label-info">Events</span> <code>saved</code></p>
2202 <h4 id="readdata_1">readData()<a class="headerlink" href="#readdata_1" title="Permanent link">#</a></h4>
2203 <p><em>Inherited from AbstractPage.</em></p>
2204 <h4 id="assignvariables_1">assignVariables()<a class="headerlink" href="#assignvariables_1" title="Permanent link">#</a></h4>
2205 <p><em>Inherited from AbstractPage.</em></p>
2206
2207
2208
2209
2210 <hr>
2211 <div class="md-source-date">
2212   <small>
2213
2214       Last update: 2021-01-08
2215
2216   </small>
2217 </div>
2218
2219
2220
2221
2222
2223
2224
2225
2226             </article>
2227           </div>
2228         </div>
2229       </main>
2230
2231
2232 <footer class="md-footer">
2233
2234     <nav class="md-footer__inner md-grid" aria-label="Footer">
2235
2236         <a href="../../getting-started/" class="md-footer__link md-footer__link--prev" rel="prev">
2237           <div class="md-footer__button md-icon">
2238             <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>
2239           </div>
2240           <div class="md-footer__title">
2241             <div class="md-ellipsis">
2242               <span class="md-footer__direction">
2243                 Previous
2244               </span>
2245               Getting Started
2246             </div>
2247           </div>
2248         </a>
2249
2250
2251         <a href="../database-objects/" class="md-footer__link md-footer__link--next" rel="next">
2252           <div class="md-footer__title">
2253             <div class="md-ellipsis">
2254               <span class="md-footer__direction">
2255                 Next
2256               </span>
2257               Database Objects
2258             </div>
2259           </div>
2260           <div class="md-footer__button md-icon">
2261             <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>
2262           </div>
2263         </a>
2264
2265     </nav>
2266
2267   <div class="md-footer-meta md-typeset">
2268     <div class="md-footer-meta__inner md-grid">
2269       <div class="md-footer-copyright">
2270
2271           <div class="md-footer-copyright__highlight">
2272             Copyright © 2020 WoltLab GmbH
2273           </div>
2274
2275         Made with
2276         <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2277           Material for MkDocs
2278         </a>
2279
2280       </div>
2281       <div class="md-footer-copyright">
2282         <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2283         <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2284 </div>
2285     </div>
2286   </div>
2287 </footer>
2288
2289     </div>
2290     <div class="md-dialog" data-md-component="dialog">
2291       <div class="md-dialog__inner md-typeset"></div>
2292     </div>
2293     <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>
2294
2295
2296       <script src="../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2297
2298
2299   </body>
2300 </html>