Deployed a63ec8f to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / migration / wsc31 / form-builder / index.html
CommitLineData
0c5338dd
TD
1
2<!doctype html>
3<html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.3">
14
15
16
17 <title>Migrating from WSC 3.1 - Form Builder - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.1655a90d.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#migrating-from-wsc-31-form-builder" 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 Migrating from WSC 3.1 - Form Builder
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 <li class="md-nav__item md-nav__item--nested">
1266
1267
1268 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1269
1270 <label class="md-nav__link" for="__nav_6">
1271 Migration
1272 <span class="md-nav__icon md-icon"></span>
1273 </label>
1274 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1275 <label class="md-nav__title" for="__nav_6">
1276 <span class="md-nav__icon md-icon"></span>
1277 Migration
1278 </label>
1279 <ul class="md-nav__list" data-md-scrollfix>
1280
1281
1282
1283
1284
1285
1286 <li class="md-nav__item md-nav__item--nested">
1287
1288
1289 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1290
1291 <label class="md-nav__link" for="__nav_6_1">
1292 Migrating from WSC 5.3
1293 <span class="md-nav__icon md-icon"></span>
1294 </label>
1295 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1296 <label class="md-nav__title" for="__nav_6_1">
1297 <span class="md-nav__icon md-icon"></span>
1298 Migrating from WSC 5.3
1299 </label>
1300 <ul class="md-nav__list" data-md-scrollfix>
1301
1302
1303
1304
1305
1306 <li class="md-nav__item">
1307 <a href="../../wsc53/php/" class="md-nav__link">
1308 PHP API
1309 </a>
1310 </li>
1311
1312
1313
1314
1315
1316
1317
1318 <li class="md-nav__item">
1319 <a href="../../wsc53/session/" class="md-nav__link">
1320 Session Handling and Authentication
1321 </a>
1322 </li>
1323
1324
1325
1326
1327
1328
1329
1330 <li class="md-nav__item">
1331 <a href="../../wsc53/javascript/" class="md-nav__link">
1332 JavaScript
1333 </a>
1334 </li>
1335
1336
1337
1338
1339
1340
1341
1342 <li class="md-nav__item">
1343 <a href="../../wsc53/templates/" class="md-nav__link">
1344 Templates
1345 </a>
1346 </li>
1347
1348
1349
1350
1351
1352
1353
1354 <li class="md-nav__item">
1355 <a href="../../wsc53/libraries/" class="md-nav__link">
1356 Third Party Libraries
1357 </a>
1358 </li>
1359
1360
1361
1362 </ul>
1363 </nav>
1364 </li>
1365
1366
1367
1368
1369
1370
1371
1372
1373 <li class="md-nav__item md-nav__item--nested">
1374
1375
1376 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1377
1378 <label class="md-nav__link" for="__nav_6_2">
1379 Migrating from WSC 5.2
1380 <span class="md-nav__icon md-icon"></span>
1381 </label>
1382 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1383 <label class="md-nav__title" for="__nav_6_2">
1384 <span class="md-nav__icon md-icon"></span>
1385 Migrating from WSC 5.2
1386 </label>
1387 <ul class="md-nav__list" data-md-scrollfix>
1388
1389
1390
1391
1392
1393 <li class="md-nav__item">
1394 <a href="../../wsc52/php/" class="md-nav__link">
1395 PHP API
1396 </a>
1397 </li>
1398
1399
1400
1401
1402
1403
1404
1405 <li class="md-nav__item">
1406 <a href="../../wsc52/templates/" class="md-nav__link">
1407 Templates and Languages
1408 </a>
1409 </li>
1410
1411
1412
1413
1414
1415
1416
1417 <li class="md-nav__item">
1418 <a href="../../wsc52/libraries/" class="md-nav__link">
1419 Third Party Libraries
1420 </a>
1421 </li>
1422
1423
1424
1425 </ul>
1426 </nav>
1427 </li>
1428
1429
1430
1431
1432
1433
1434
1435
1436 <li class="md-nav__item md-nav__item--nested">
1437
1438
1439 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1440
1441 <label class="md-nav__link" for="__nav_6_3">
1442 Migrating from WSC 3.1
1443 <span class="md-nav__icon md-icon"></span>
1444 </label>
1445 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1446 <label class="md-nav__title" for="__nav_6_3">
1447 <span class="md-nav__icon md-icon"></span>
1448 Migrating from WSC 3.1
1449 </label>
1450 <ul class="md-nav__list" data-md-scrollfix>
1451
1452
1453
1454
1455
1456 <li class="md-nav__item">
1457 <a href="../php/" class="md-nav__link">
1458 PHP API
1459 </a>
1460 </li>
1461
1462
1463
1464 </ul>
1465 </nav>
1466 </li>
1467
1468
1469
1470
1471
1472
1473
1474
1475 <li class="md-nav__item md-nav__item--nested">
1476
1477
1478 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1479
1480 <label class="md-nav__link" for="__nav_6_4">
1481 Migrating from WSC 3.0
1482 <span class="md-nav__icon md-icon"></span>
1483 </label>
1484 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1485 <label class="md-nav__title" for="__nav_6_4">
1486 <span class="md-nav__icon md-icon"></span>
1487 Migrating from WSC 3.0
1488 </label>
1489 <ul class="md-nav__list" data-md-scrollfix>
1490
1491
1492
1493
1494
1495 <li class="md-nav__item">
1496 <a href="../../wsc30/php/" class="md-nav__link">
1497 PHP API
1498 </a>
1499 </li>
1500
1501
1502
1503
1504
1505
1506
1507 <li class="md-nav__item">
1508 <a href="../../wsc30/javascript/" class="md-nav__link">
1509 JavaScript API
1510 </a>
1511 </li>
1512
1513
1514
1515
1516
1517
1518
1519 <li class="md-nav__item">
1520 <a href="../../wsc30/templates/" class="md-nav__link">
1521 Templates
1522 </a>
1523 </li>
1524
1525
1526
1527
1528
1529
1530
1531 <li class="md-nav__item">
1532 <a href="../../wsc30/css/" class="md-nav__link">
1533 CSS
1534 </a>
1535 </li>
1536
1537
1538
1539
1540
1541
1542
1543 <li class="md-nav__item">
1544 <a href="../../wsc30/package/" class="md-nav__link">
1545 Package Components
1546 </a>
1547 </li>
1548
1549
1550
1551 </ul>
1552 </nav>
1553 </li>
1554
1555
1556
1557
1558
1559
1560
1561
1562 <li class="md-nav__item md-nav__item--nested">
1563
1564
1565 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1566
1567 <label class="md-nav__link" for="__nav_6_5">
1568 Migrating from WCF 2.1
1569 <span class="md-nav__icon md-icon"></span>
1570 </label>
1571 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1572 <label class="md-nav__title" for="__nav_6_5">
1573 <span class="md-nav__icon md-icon"></span>
1574 Migrating from WCF 2.1
1575 </label>
1576 <ul class="md-nav__list" data-md-scrollfix>
1577
1578
1579
1580
1581
1582 <li class="md-nav__item">
1583 <a href="../../wcf21/php/" class="md-nav__link">
1584 PHP API
1585 </a>
1586 </li>
1587
1588
1589
1590
1591
1592
1593
1594 <li class="md-nav__item">
1595 <a href="../../wcf21/templates/" class="md-nav__link">
1596 Templates
1597 </a>
1598 </li>
1599
1600
1601
1602
1603
1604
1605
1606 <li class="md-nav__item">
1607 <a href="../../wcf21/css/" class="md-nav__link">
1608 CSS
1609 </a>
1610 </li>
1611
1612
1613
1614
1615
1616
1617
1618 <li class="md-nav__item">
1619 <a href="../../wcf21/package/" class="md-nav__link">
1620 Package Components
1621 </a>
1622 </li>
1623
1624
1625
1626 </ul>
1627 </nav>
1628 </li>
1629
1630
1631
1632 </ul>
1633 </nav>
1634 </li>
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646 <li class="md-nav__item md-nav__item--nested">
1647
1648
1649 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1650
1651 <label class="md-nav__link" for="__nav_7">
1652 Tutorials
1653 <span class="md-nav__icon md-icon"></span>
1654 </label>
1655 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1656 <label class="md-nav__title" for="__nav_7">
1657 <span class="md-nav__icon md-icon"></span>
1658 Tutorials
1659 </label>
1660 <ul class="md-nav__list" data-md-scrollfix>
1661
1662
1663
1664
1665
1666
1667 <li class="md-nav__item md-nav__item--nested">
1668
1669
1670 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1671
1672 <label class="md-nav__link" for="__nav_7_1">
1673 Tutorial Series
1674 <span class="md-nav__icon md-icon"></span>
1675 </label>
1676 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1677 <label class="md-nav__title" for="__nav_7_1">
1678 <span class="md-nav__icon md-icon"></span>
1679 Tutorial Series
1680 </label>
1681 <ul class="md-nav__list" data-md-scrollfix>
1682
1683
1684
1685
1686
1687 <li class="md-nav__item">
1688 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1689 Overview
1690 </a>
1691 </li>
1692
1693
1694
1695
1696
1697
1698
1699 <li class="md-nav__item">
1700 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1701 Part 1
1702 </a>
1703 </li>
1704
1705
1706
1707
1708
1709
1710
1711 <li class="md-nav__item">
1712 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1713 Part 2
1714 </a>
1715 </li>
1716
1717
1718
1719
1720
1721
1722
1723 <li class="md-nav__item">
1724 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1725 Part 3
1726 </a>
1727 </li>
1728
1729
1730
1731 </ul>
1732 </nav>
1733 </li>
1734
1735
1736
1737 </ul>
1738 </nav>
1739 </li>
1740
1741
1742
1743 </ul>
1744</nav>
1745 </div>
1746 </div>
1747 </div>
1748
1749
1750
1751 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1752 <div class="md-sidebar__scrollwrap">
1753 <div class="md-sidebar__inner">
1754
1755<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1756
1757
1758
1759
1760
1761 <label class="md-nav__title" for="__toc">
1762 <span class="md-nav__icon md-icon"></span>
1763 Table of contents
1764 </label>
1765 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1766
1767 <li class="md-nav__item">
1768 <a href="#example-two-text-form-fields" class="md-nav__link">
1769 Example: Two Text Form Fields
1770 </a>
1771
1772</li>
1773
1774 </ul>
1775
1776</nav>
1777 </div>
1778 </div>
1779 </div>
1780
1781
1782 <div class="md-content" data-md-component="content">
1783 <article class="md-content__inner md-typeset">
1784
1785
1786
1787 <h1 id="migrating-from-wsc-31-form-builder">Migrating from WSC 3.1 - Form Builder<a class="headerlink" href="#migrating-from-wsc-31-form-builder" title="Permanent link">#</a></h1>
1788<h2 id="example-two-text-form-fields">Example: Two Text Form Fields<a class="headerlink" href="#example-two-text-form-fields" title="Permanent link">#</a></h2>
1789<p>As the first example, the pre-WoltLab Suite Core 5.2 versions of the forms to add and edit persons from the <a href="../../../tutorial/series/part_1/">first part of the tutorial series</a> will be updated to the new form builder API.
1790This form is the perfect first examples as it is very simple with only two text fields whose only restriction is that they have to be filled out and that their values may not be longer than 255 characters each.</p>
1791<p>As a reminder, here are the two relevant PHP files and the relevant template file:</p>
1792<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1793<span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
1794<span class="k">use</span> <span class="nx">wcf\data\person\PersonAction</span><span class="p">;</span>
1795<span class="k">use</span> <span class="nx">wcf\form\AbstractForm</span><span class="p">;</span>
1796<span class="k">use</span> <span class="nx">wcf\system\exception\UserInputException</span><span class="p">;</span>
1797<span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
1798<span class="k">use</span> <span class="nx">wcf\util\StringUtil</span><span class="p">;</span>
1799
1800<span class="sd">/**</span>
1801<span class="sd"> * Shows the form to create a new person.</span>
1802<span class="sd"> * </span>
1803<span class="sd"> * @author Matthias Schmidt</span>
1804<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
1805<span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
1806<span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
1807<span class="sd"> */</span>
1808<span class="k">class</span> <span class="nc">PersonAddForm</span> <span class="k">extends</span> <span class="nx">AbstractForm</span> <span class="p">{</span>
1809 <span class="sd">/**</span>
1810<span class="sd"> * @inheritDoc</span>
1811<span class="sd"> */</span>
1812 <span class="k">public</span> <span class="nv">$activeMenuItem</span> <span class="o">=</span> <span class="s1">&#39;wcf.acp.menu.link.person.add&#39;</span><span class="p">;</span>
1813
1814 <span class="sd">/**</span>
1815<span class="sd"> * first name of the person</span>
1816<span class="sd"> * @var string</span>
1817<span class="sd"> */</span>
1818 <span class="k">public</span> <span class="nv">$firstName</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
1819
1820 <span class="sd">/**</span>
1821<span class="sd"> * last name of the person</span>
1822<span class="sd"> * @var string</span>
1823<span class="sd"> */</span>
1824 <span class="k">public</span> <span class="nv">$lastName</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
1825
1826 <span class="sd">/**</span>
1827<span class="sd"> * @inheritDoc</span>
1828<span class="sd"> */</span>
1829 <span class="k">public</span> <span class="nv">$neededPermissions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;admin.content.canManagePeople&#39;</span><span class="p">];</span>
1830
1831 <span class="sd">/**</span>
1832<span class="sd"> * @inheritDoc</span>
1833<span class="sd"> */</span>
1834 <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
1835 <span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
1836
1837 <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>
1838 <span class="s1">&#39;action&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;add&#39;</span><span class="p">,</span>
1839 <span class="s1">&#39;firstName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">,</span>
1840 <span class="s1">&#39;lastName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span>
1841 <span class="p">]);</span>
1842 <span class="p">}</span>
1843
1844 <span class="sd">/**</span>
1845<span class="sd"> * @inheritDoc</span>
1846<span class="sd"> */</span>
1847 <span class="k">public</span> <span class="k">function</span> <span class="nf">readFormParameters</span><span class="p">()</span> <span class="p">{</span>
1848 <span class="k">parent</span><span class="o">::</span><span class="na">readFormParameters</span><span class="p">();</span>
1849
1850 <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;firstName&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span> <span class="o">=</span> <span class="nx">StringUtil</span><span class="o">::</span><span class="na">trim</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;firstName&#39;</span><span class="p">]);</span>
1851 <span class="k">if</span> <span class="p">(</span><span class="nb">isset</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;lastName&#39;</span><span class="p">]))</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span> <span class="o">=</span> <span class="nx">StringUtil</span><span class="o">::</span><span class="na">trim</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">[</span><span class="s1">&#39;lastName&#39;</span><span class="p">]);</span>
1852 <span class="p">}</span>
1853
1854 <span class="sd">/**</span>
1855<span class="sd"> * @inheritDoc</span>
1856<span class="sd"> */</span>
1857 <span class="k">public</span> <span class="k">function</span> <span class="nf">save</span><span class="p">()</span> <span class="p">{</span>
1858 <span class="k">parent</span><span class="o">::</span><span class="na">save</span><span class="p">();</span>
1859
1860 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objectAction</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PersonAction</span><span class="p">([],</span> <span class="s1">&#39;create&#39;</span><span class="p">,</span> <span class="p">[</span>
1861 <span class="s1">&#39;data&#39;</span> <span class="o">=&gt;</span> <span class="nb">array_merge</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">additionalFields</span><span class="p">,</span> <span class="p">[</span>
1862 <span class="s1">&#39;firstName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">,</span>
1863 <span class="s1">&#39;lastName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span>
1864 <span class="p">])</span>
1865 <span class="p">]);</span>
1866 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objectAction</span><span class="o">-&gt;</span><span class="na">executeAction</span><span class="p">();</span>
1867
1868 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">saved</span><span class="p">();</span>
1869
1870 <span class="c1">// reset values</span>
1871 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
1872 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span><span class="p">;</span>
1873
1874 <span class="c1">// show success message</span>
1875 <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><span class="s1">&#39;success&#39;</span><span class="p">,</span> <span class="k">true</span><span class="p">);</span>
1876 <span class="p">}</span>
1877
1878 <span class="sd">/**</span>
1879<span class="sd"> * @inheritDoc</span>
1880<span class="sd"> */</span>
1881 <span class="k">public</span> <span class="k">function</span> <span class="nf">validate</span><span class="p">()</span> <span class="p">{</span>
1882 <span class="k">parent</span><span class="o">::</span><span class="na">validate</span><span class="p">();</span>
1883
1884 <span class="c1">// validate first name</span>
1885 <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">))</span> <span class="p">{</span>
1886 <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">);</span>
1887 <span class="p">}</span>
1888 <span class="k">if</span> <span class="p">(</span><span class="nb">mb_strlen</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">255</span><span class="p">)</span> <span class="p">{</span>
1889 <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">,</span> <span class="s1">&#39;tooLong&#39;</span><span class="p">);</span>
1890 <span class="p">}</span>
1891
1892 <span class="c1">// validate last name</span>
1893 <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span><span class="p">))</span> <span class="p">{</span>
1894 <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">);</span>
1895 <span class="p">}</span>
1896 <span class="k">if</span> <span class="p">(</span><span class="nb">mb_strlen</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">255</span><span class="p">)</span> <span class="p">{</span>
1897 <span class="k">throw</span> <span class="k">new</span> <span class="nx">UserInputException</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">,</span> <span class="s1">&#39;tooLong&#39;</span><span class="p">);</span>
1898 <span class="p">}</span>
1899 <span class="p">}</span>
1900<span class="p">}</span>
1901</code></pre></div>
1902
1903<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
1904<span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
1905<span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
1906<span class="k">use</span> <span class="nx">wcf\data\person\PersonAction</span><span class="p">;</span>
1907<span class="k">use</span> <span class="nx">wcf\form\AbstractForm</span><span class="p">;</span>
1908<span class="k">use</span> <span class="nx">wcf\system\exception\IllegalLinkException</span><span class="p">;</span>
1909<span class="k">use</span> <span class="nx">wcf\system\WCF</span><span class="p">;</span>
1910
1911<span class="sd">/**</span>
1912<span class="sd"> * Shows the form to edit an existing person.</span>
1913<span class="sd"> * </span>
1914<span class="sd"> * @author Matthias Schmidt</span>
1915<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
1916<span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
1917<span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
1918<span class="sd"> */</span>
1919<span class="k">class</span> <span class="nc">PersonEditForm</span> <span class="k">extends</span> <span class="nx">PersonAddForm</span> <span class="p">{</span>
1920 <span class="sd">/**</span>
1921<span class="sd"> * @inheritDoc</span>
1922<span class="sd"> */</span>
1923 <span class="k">public</span> <span class="nv">$activeMenuItem</span> <span class="o">=</span> <span class="s1">&#39;wcf.acp.menu.link.person&#39;</span><span class="p">;</span>
1924
1925 <span class="sd">/**</span>
1926<span class="sd"> * edited person object</span>
1927<span class="sd"> * @var Person</span>
1928<span class="sd"> */</span>
1929 <span class="k">public</span> <span class="nv">$person</span> <span class="o">=</span> <span class="k">null</span><span class="p">;</span>
1930
1931 <span class="sd">/**</span>
1932<span class="sd"> * id of the edited person</span>
1933<span class="sd"> * @var integer</span>
1934<span class="sd"> */</span>
1935 <span class="k">public</span> <span class="nv">$personID</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
1936
1937 <span class="sd">/**</span>
1938<span class="sd"> * @inheritDoc</span>
1939<span class="sd"> */</span>
1940 <span class="k">public</span> <span class="k">function</span> <span class="nf">assignVariables</span><span class="p">()</span> <span class="p">{</span>
1941 <span class="k">parent</span><span class="o">::</span><span class="na">assignVariables</span><span class="p">();</span>
1942
1943 <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>
1944 <span class="s1">&#39;action&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;edit&#39;</span><span class="p">,</span>
1945 <span class="s1">&#39;person&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span>
1946 <span class="p">]);</span>
1947 <span class="p">}</span>
1948
1949 <span class="sd">/**</span>
1950<span class="sd"> * @inheritDoc</span>
1951<span class="sd"> */</span>
1952 <span class="k">public</span> <span class="k">function</span> <span class="nf">readData</span><span class="p">()</span> <span class="p">{</span>
1953 <span class="k">parent</span><span class="o">::</span><span class="na">readData</span><span class="p">();</span>
1954
1955 <span class="k">if</span> <span class="p">(</span><span class="k">empty</span><span class="p">(</span><span class="nv">$_POST</span><span class="p">))</span> <span class="p">{</span>
1956 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">;</span>
1957 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span><span class="o">-&gt;</span><span class="na">lastName</span><span class="p">;</span>
1958 <span class="p">}</span>
1959 <span class="p">}</span>
1960
1961 <span class="sd">/**</span>
1962<span class="sd"> * @inheritDoc</span>
1963<span class="sd"> */</span>
1964 <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
1965 <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
1966
1967 <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">personID</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>
1968 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Person</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">);</span>
1969 <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">person</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">)</span> <span class="p">{</span>
1970 <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
1971 <span class="p">}</span>
1972 <span class="p">}</span>
1973
1974 <span class="sd">/**</span>
1975<span class="sd"> * @inheritDoc</span>
1976<span class="sd"> */</span>
1977 <span class="k">public</span> <span class="k">function</span> <span class="nf">save</span><span class="p">()</span> <span class="p">{</span>
1978 <span class="nx">AbstractForm</span><span class="o">::</span><span class="na">save</span><span class="p">();</span>
1979
1980 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objectAction</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">PersonAction</span><span class="p">([</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">person</span><span class="p">],</span> <span class="s1">&#39;update&#39;</span><span class="p">,</span> <span class="p">[</span>
1981 <span class="s1">&#39;data&#39;</span> <span class="o">=&gt;</span> <span class="nb">array_merge</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">additionalFields</span><span class="p">,</span> <span class="p">[</span>
1982 <span class="s1">&#39;firstName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">firstName</span><span class="p">,</span>
1983 <span class="s1">&#39;lastName&#39;</span> <span class="o">=&gt;</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">lastName</span>
1984 <span class="p">])</span>
1985 <span class="p">]);</span>
1986 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">objectAction</span><span class="o">-&gt;</span><span class="na">executeAction</span><span class="p">();</span>
1987
1988 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">saved</span><span class="p">();</span>
1989
1990 <span class="c1">// show success message</span>
1991 <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><span class="s1">&#39;success&#39;</span><span class="p">,</span> <span class="k">true</span><span class="p">);</span>
1992 <span class="p">}</span>
1993<span class="p">}</span>
1994</code></pre></div>
1995
1996<div class="highlight"><pre><span></span><code><span class="p">{</span><span class="k">include</span> <span class="nb">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span> <span class="nx">pageTitle</span><span class="o">=</span><span class="s1">&#39;wcf.acp.person.&#39;</span><span class="o">|</span><span class="nx">concat</span><span class="o">:</span><span class="nv">$action</span><span class="p">}</span>
1997
1998<span class="o">&lt;</span><span class="nb">header</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeader&quot;</span><span class="o">&gt;</span>
1999 <span class="o">&lt;</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeaderTitle&quot;</span><span class="o">&gt;</span>
2000 <span class="o">&lt;</span><span class="nx">h1</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentTitle&quot;</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="p">{</span><span class="nv">$action</span><span class="p">}{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">h1</span><span class="o">&gt;</span>
2001 <span class="o">&lt;/</span><span class="nx">div</span><span class="o">&gt;</span>
2002
2003 <span class="o">&lt;</span><span class="nx">nav</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeaderNavigation&quot;</span><span class="o">&gt;</span>
2004 <span class="o">&lt;</span><span class="nx">ul</span><span class="o">&gt;</span>
2005 <span class="o">&lt;</span><span class="nx">li</span><span class="o">&gt;&lt;</span><span class="nx">a</span> <span class="nx">href</span><span class="o">=</span><span class="s2">&quot;{link controller=&#39;PersonList&#39;}{/link}&quot;</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;button&quot;</span><span class="o">&gt;&lt;</span><span class="nx">span</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;icon icon16 fa-list&quot;</span><span class="o">&gt;&lt;/</span><span class="nx">span</span><span class="o">&gt;</span> <span class="o">&lt;</span><span class="nx">span</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">menu</span><span class="o">.</span><span class="nb">link</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="k">list</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">span</span><span class="o">&gt;&lt;/</span><span class="nx">a</span><span class="o">&gt;&lt;/</span><span class="nx">li</span><span class="o">&gt;</span>
2006
2007 <span class="p">{</span><span class="nx">event</span> <span class="nx">name</span><span class="o">=</span><span class="s1">&#39;contentHeaderNavigation&#39;</span><span class="p">}</span>
2008 <span class="o">&lt;/</span><span class="nx">ul</span><span class="o">&gt;</span>
2009 <span class="o">&lt;/</span><span class="nx">nav</span><span class="o">&gt;</span>
2010<span class="o">&lt;/</span><span class="nb">header</span><span class="o">&gt;</span>
2011
2012<span class="p">{</span><span class="k">include</span> <span class="nb">file</span><span class="o">=</span><span class="s1">&#39;formError&#39;</span><span class="p">}</span>
2013
2014<span class="p">{</span><span class="k">if</span> <span class="nv">$success</span><span class="o">|</span><span class="nb">isset</span><span class="p">}</span>
2015 <span class="o">&lt;</span><span class="nx">p</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;success&quot;</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="k">global</span><span class="o">.</span><span class="nx">success</span><span class="o">.</span><span class="p">{</span><span class="nv">$action</span><span class="p">}{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">p</span><span class="o">&gt;</span>
2016<span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span>
2017
2018<span class="o">&lt;</span><span class="nx">form</span> <span class="nx">method</span><span class="o">=</span><span class="s2">&quot;post&quot;</span> <span class="nx">action</span><span class="o">=</span><span class="s2">&quot;{if </span><span class="si">$action</span><span class="s2"> == &#39;add&#39;}{link controller=&#39;PersonAdd&#39;}{/link}{else}{link controller=&#39;PersonEdit&#39; object=</span><span class="si">$person</span><span class="s2">}{/link}{/if}&quot;</span><span class="o">&gt;</span>
2019 <span class="o">&lt;</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;section&quot;</span><span class="o">&gt;</span>
2020 <span class="o">&lt;</span><span class="nb">dl</span><span class="p">{</span><span class="k">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;firstName&#39;</span><span class="p">}</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;formError&quot;</span><span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span><span class="o">&gt;</span>
2021 <span class="o">&lt;</span><span class="nx">dt</span><span class="o">&gt;&lt;</span><span class="nx">label</span> <span class="k">for</span><span class="o">=</span><span class="s2">&quot;firstName&quot;</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="nx">firstName</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">label</span><span class="o">&gt;&lt;/</span><span class="nx">dt</span><span class="o">&gt;</span>
2022 <span class="o">&lt;</span><span class="nx">dd</span><span class="o">&gt;</span>
2023 <span class="o">&lt;</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nx">id</span><span class="o">=</span><span class="s2">&quot;firstName&quot;</span> <span class="nx">name</span><span class="o">=</span><span class="s2">&quot;firstName&quot;</span> <span class="nx">value</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">{</span><span class="nv">$firstName</span><span class="si">}</span><span class="s2">&quot;</span> <span class="nx">required</span> <span class="nx">autofocus</span> <span class="nx">maxlength</span><span class="o">=</span><span class="s2">&quot;255&quot;</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;long&quot;</span><span class="o">&gt;</span>
2024 <span class="p">{</span><span class="k">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;firstName&#39;</span><span class="p">}</span>
2025 <span class="o">&lt;</span><span class="nx">small</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;innerError&quot;</span><span class="o">&gt;</span>
2026 <span class="p">{</span><span class="k">if</span> <span class="nv">$errorType</span> <span class="o">==</span> <span class="s1">&#39;empty&#39;</span><span class="p">}</span>
2027 <span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="k">global</span><span class="o">.</span><span class="nx">form</span><span class="o">.</span><span class="nx">error</span><span class="o">.</span><span class="k">empty</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span>
2028 <span class="p">{</span><span class="k">else</span><span class="p">}</span>
2029 <span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="nx">firstName</span><span class="o">.</span><span class="nx">error</span><span class="o">.</span><span class="p">{</span><span class="nv">$errorType</span><span class="p">}{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span>
2030 <span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span>
2031 <span class="o">&lt;/</span><span class="nx">small</span><span class="o">&gt;</span>
2032 <span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span>
2033 <span class="o">&lt;/</span><span class="nx">dd</span><span class="o">&gt;</span>
2034 <span class="o">&lt;/</span><span class="nb">dl</span><span class="o">&gt;</span>
2035
2036 <span class="o">&lt;</span><span class="nb">dl</span><span class="p">{</span><span class="k">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;lastName&#39;</span><span class="p">}</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;formError&quot;</span><span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span><span class="o">&gt;</span>
2037 <span class="o">&lt;</span><span class="nx">dt</span><span class="o">&gt;&lt;</span><span class="nx">label</span> <span class="k">for</span><span class="o">=</span><span class="s2">&quot;lastName&quot;</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="nx">lastName</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">label</span><span class="o">&gt;&lt;/</span><span class="nx">dt</span><span class="o">&gt;</span>
2038 <span class="o">&lt;</span><span class="nx">dd</span><span class="o">&gt;</span>
2039 <span class="o">&lt;</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nx">id</span><span class="o">=</span><span class="s2">&quot;lastName&quot;</span> <span class="nx">name</span><span class="o">=</span><span class="s2">&quot;lastName&quot;</span> <span class="nx">value</span><span class="o">=</span><span class="s2">&quot;</span><span class="si">{</span><span class="nv">$lastName</span><span class="si">}</span><span class="s2">&quot;</span> <span class="nx">required</span> <span class="nx">maxlength</span><span class="o">=</span><span class="s2">&quot;255&quot;</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;long&quot;</span><span class="o">&gt;</span>
2040 <span class="p">{</span><span class="k">if</span> <span class="nv">$errorField</span> <span class="o">==</span> <span class="s1">&#39;lastName&#39;</span><span class="p">}</span>
2041 <span class="o">&lt;</span><span class="nx">small</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;innerError&quot;</span><span class="o">&gt;</span>
2042 <span class="p">{</span><span class="k">if</span> <span class="nv">$errorType</span> <span class="o">==</span> <span class="s1">&#39;empty&#39;</span><span class="p">}</span>
2043 <span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="k">global</span><span class="o">.</span><span class="nx">form</span><span class="o">.</span><span class="nx">error</span><span class="o">.</span><span class="k">empty</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span>
2044 <span class="p">{</span><span class="k">else</span><span class="p">}</span>
2045 <span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="nx">lastName</span><span class="o">.</span><span class="nx">error</span><span class="o">.</span><span class="p">{</span><span class="nv">$errorType</span><span class="p">}{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span>
2046 <span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span>
2047 <span class="o">&lt;/</span><span class="nx">small</span><span class="o">&gt;</span>
2048 <span class="p">{</span><span class="o">/</span><span class="k">if</span><span class="p">}</span>
2049 <span class="o">&lt;/</span><span class="nx">dd</span><span class="o">&gt;</span>
2050 <span class="o">&lt;/</span><span class="nb">dl</span><span class="o">&gt;</span>
2051
2052 <span class="p">{</span><span class="nx">event</span> <span class="nx">name</span><span class="o">=</span><span class="s1">&#39;dataFields&#39;</span><span class="p">}</span>
2053 <span class="o">&lt;/</span><span class="nx">div</span><span class="o">&gt;</span>
2054
2055 <span class="p">{</span><span class="nx">event</span> <span class="nx">name</span><span class="o">=</span><span class="s1">&#39;sections&#39;</span><span class="p">}</span>
2056
2057 <span class="o">&lt;</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;formSubmit&quot;</span><span class="o">&gt;</span>
2058 <span class="o">&lt;</span><span class="nx">input</span> <span class="nx">type</span><span class="o">=</span><span class="s2">&quot;submit&quot;</span> <span class="nx">value</span><span class="o">=</span><span class="s2">&quot;{lang}wcf.global.button.submit{/lang}&quot;</span> <span class="nx">accesskey</span><span class="o">=</span><span class="s2">&quot;s&quot;</span><span class="o">&gt;</span>
2059 <span class="p">{</span><span class="o">@</span><span class="nx">SECURITY_TOKEN_INPUT_TAG</span><span class="p">}</span>
2060 <span class="o">&lt;/</span><span class="nx">div</span><span class="o">&gt;</span>
2061<span class="o">&lt;/</span><span class="nx">form</span><span class="o">&gt;</span>
2062
2063<span class="p">{</span><span class="k">include</span> <span class="nb">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="p">}</span>
2064</code></pre></div>
2065
2066<p>Updating the template is easy as the complete form is replace by a single line of code:</p>
2067<div class="highlight"><pre><span></span><code><span class="p">{</span><span class="k">include</span> <span class="nb">file</span><span class="o">=</span><span class="s1">&#39;header&#39;</span> <span class="nx">pageTitle</span><span class="o">=</span><span class="s1">&#39;wcf.acp.person.&#39;</span><span class="o">|</span><span class="nx">concat</span><span class="o">:</span><span class="nv">$action</span><span class="p">}</span>
2068
2069<span class="o">&lt;</span><span class="nb">header</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeader&quot;</span><span class="o">&gt;</span>
2070 <span class="o">&lt;</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeaderTitle&quot;</span><span class="o">&gt;</span>
2071 <span class="o">&lt;</span><span class="nx">h1</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentTitle&quot;</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="p">{</span><span class="nv">$action</span><span class="p">}{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">h1</span><span class="o">&gt;</span>
2072 <span class="o">&lt;/</span><span class="nx">div</span><span class="o">&gt;</span>
2073
2074 <span class="o">&lt;</span><span class="nx">nav</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;contentHeaderNavigation&quot;</span><span class="o">&gt;</span>
2075 <span class="o">&lt;</span><span class="nx">ul</span><span class="o">&gt;</span>
2076 <span class="o">&lt;</span><span class="nx">li</span><span class="o">&gt;&lt;</span><span class="nx">a</span> <span class="nx">href</span><span class="o">=</span><span class="s2">&quot;{link controller=&#39;PersonList&#39;}{/link}&quot;</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;button&quot;</span><span class="o">&gt;&lt;</span><span class="nx">span</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;icon icon16 fa-list&quot;</span><span class="o">&gt;&lt;/</span><span class="nx">span</span><span class="o">&gt;</span> <span class="o">&lt;</span><span class="nx">span</span><span class="o">&gt;</span><span class="p">{</span><span class="nx">lang</span><span class="p">}</span><span class="nx">wcf</span><span class="o">.</span><span class="nx">acp</span><span class="o">.</span><span class="nx">menu</span><span class="o">.</span><span class="nb">link</span><span class="o">.</span><span class="nx">person</span><span class="o">.</span><span class="k">list</span><span class="p">{</span><span class="o">/</span><span class="nx">lang</span><span class="p">}</span><span class="o">&lt;/</span><span class="nx">span</span><span class="o">&gt;&lt;/</span><span class="nx">a</span><span class="o">&gt;&lt;/</span><span class="nx">li</span><span class="o">&gt;</span>
2077
2078 <span class="p">{</span><span class="nx">event</span> <span class="nx">name</span><span class="o">=</span><span class="s1">&#39;contentHeaderNavigation&#39;</span><span class="p">}</span>
2079 <span class="o">&lt;/</span><span class="nx">ul</span><span class="o">&gt;</span>
2080 <span class="o">&lt;/</span><span class="nx">nav</span><span class="o">&gt;</span>
2081<span class="o">&lt;/</span><span class="nb">header</span><span class="o">&gt;</span>
2082
2083<span class="p">{</span><span class="o">@</span><span class="nv">$form</span><span class="o">-&gt;</span><span class="na">getHtml</span><span class="p">()}</span>
2084
2085<span class="p">{</span><span class="k">include</span> <span class="nb">file</span><span class="o">=</span><span class="s1">&#39;footer&#39;</span><span class="p">}</span>
2086</code></pre></div>
2087
2088<p><code>PersonEditForm</code> also becomes much simpler:
2089only the edited <code>Person</code> object must be read:</p>
2090<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2091<span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
2092<span class="k">use</span> <span class="nx">wcf\data\person\Person</span><span class="p">;</span>
2093<span class="k">use</span> <span class="nx">wcf\system\exception\IllegalLinkException</span><span class="p">;</span>
2094
2095<span class="sd">/**</span>
2096<span class="sd"> * Shows the form to edit an existing person.</span>
2097<span class="sd"> * </span>
2098<span class="sd"> * @author Matthias Schmidt</span>
2099<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2100<span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2101<span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
2102<span class="sd"> */</span>
2103<span class="k">class</span> <span class="nc">PersonEditForm</span> <span class="k">extends</span> <span class="nx">PersonAddForm</span> <span class="p">{</span>
2104 <span class="sd">/**</span>
2105<span class="sd"> * @inheritDoc</span>
2106<span class="sd"> */</span>
2107 <span class="k">public</span> <span class="nv">$activeMenuItem</span> <span class="o">=</span> <span class="s1">&#39;wcf.acp.menu.link.person&#39;</span><span class="p">;</span>
2108
2109 <span class="sd">/**</span>
2110<span class="sd"> * @inheritDoc</span>
2111<span class="sd"> */</span>
2112 <span class="k">public</span> <span class="k">function</span> <span class="nf">readParameters</span><span class="p">()</span> <span class="p">{</span>
2113 <span class="k">parent</span><span class="o">::</span><span class="na">readParameters</span><span class="p">();</span>
2114
2115 <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="p">{</span>
2116 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">formObject</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Person</span><span class="p">(</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>
2117 <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">formObject</span><span class="o">-&gt;</span><span class="na">personID</span><span class="p">)</span> <span class="p">{</span>
2118 <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalLinkException</span><span class="p">();</span>
2119 <span class="p">}</span>
2120 <span class="p">}</span>
2121 <span class="p">}</span>
2122<span class="p">}</span>
2123</code></pre></div>
2124
2125<p>Most of the work is done in <code>PersonAddForm</code>:</p>
2126<div class="highlight"><pre><span></span><code><span class="o">&lt;?</span><span class="nx">php</span>
2127<span class="k">namespace</span> <span class="nx">wcf\acp\form</span><span class="p">;</span>
2128<span class="k">use</span> <span class="nx">wcf\data\person\PersonAction</span><span class="p">;</span>
2129<span class="k">use</span> <span class="nx">wcf\form\AbstractFormBuilderForm</span><span class="p">;</span>
2130<span class="k">use</span> <span class="nx">wcf\system\form\builder\container\FormContainer</span><span class="p">;</span>
2131<span class="k">use</span> <span class="nx">wcf\system\form\builder\field\TextFormField</span><span class="p">;</span>
2132
2133<span class="sd">/**</span>
2134<span class="sd"> * Shows the form to create a new person.</span>
2135<span class="sd"> * </span>
2136<span class="sd"> * @author Matthias Schmidt</span>
2137<span class="sd"> * @copyright 2001-2019 WoltLab GmbH</span>
2138<span class="sd"> * @license GNU Lesser General Public License &lt;http://opensource.org/licenses/lgpl-license.php&gt;</span>
2139<span class="sd"> * @package WoltLabSuite\Core\Acp\Form</span>
2140<span class="sd"> */</span>
2141<span class="k">class</span> <span class="nc">PersonAddForm</span> <span class="k">extends</span> <span class="nx">AbstractFormBuilderForm</span> <span class="p">{</span>
2142 <span class="sd">/**</span>
2143<span class="sd"> * @inheritDoc</span>
2144<span class="sd"> */</span>
2145 <span class="k">public</span> <span class="nv">$activeMenuItem</span> <span class="o">=</span> <span class="s1">&#39;wcf.acp.menu.link.person.add&#39;</span><span class="p">;</span>
2146
2147 <span class="sd">/**</span>
2148<span class="sd"> * @inheritDoc</span>
2149<span class="sd"> */</span>
2150 <span class="k">public</span> <span class="nv">$formAction</span> <span class="o">=</span> <span class="s1">&#39;create&#39;</span><span class="p">;</span>
2151
2152 <span class="sd">/**</span>
2153<span class="sd"> * @inheritDoc</span>
2154<span class="sd"> */</span>
2155 <span class="k">public</span> <span class="nv">$neededPermissions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;admin.content.canManagePeople&#39;</span><span class="p">];</span>
2156
2157 <span class="sd">/**</span>
2158<span class="sd"> * @inheritDoc</span>
2159<span class="sd"> */</span>
2160 <span class="k">public</span> <span class="nv">$objectActionClass</span> <span class="o">=</span> <span class="nx">PersonAction</span><span class="o">::</span><span class="na">class</span><span class="p">;</span>
2161
2162 <span class="sd">/**</span>
2163<span class="sd"> * @inheritDoc</span>
2164<span class="sd"> */</span>
2165 <span class="k">protected</span> <span class="k">function</span> <span class="nf">createForm</span><span class="p">()</span> <span class="p">{</span>
2166 <span class="k">parent</span><span class="o">::</span><span class="na">createForm</span><span class="p">();</span>
2167
2168 <span class="nv">$dataContainer</span> <span class="o">=</span> <span class="nx">FormContainer</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;data&#39;</span><span class="p">)</span>
2169 <span class="o">-&gt;</span><span class="na">appendChildren</span><span class="p">([</span>
2170 <span class="nx">TextFormField</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;firstName&#39;</span><span class="p">)</span>
2171 <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;wcf.person.firstName&#39;</span><span class="p">)</span>
2172 <span class="o">-&gt;</span><span class="na">required</span><span class="p">()</span>
2173 <span class="o">-&gt;</span><span class="na">maximumLength</span><span class="p">(</span><span class="mi">255</span><span class="p">),</span>
2174
2175 <span class="nx">TextFormField</span><span class="o">::</span><span class="na">create</span><span class="p">(</span><span class="s1">&#39;lastName&#39;</span><span class="p">)</span>
2176 <span class="o">-&gt;</span><span class="na">label</span><span class="p">(</span><span class="s1">&#39;wcf.person.lastName&#39;</span><span class="p">)</span>
2177 <span class="o">-&gt;</span><span class="na">required</span><span class="p">()</span>
2178 <span class="o">-&gt;</span><span class="na">maximumLength</span><span class="p">(</span><span class="mi">255</span><span class="p">)</span>
2179 <span class="p">]);</span>
2180
2181 <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">form</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$dataContainer</span><span class="p">);</span>
2182 <span class="p">}</span>
2183<span class="p">}</span>
2184</code></pre></div>
2185
2186<p>But, as you can see, the number of lines almost decreased by half.
2187All changes are due to extending <code>AbstractFormBuilderForm</code>:</p>
2188<ul>
2189<li><code>$formAction</code> is added and set to <code>create</code> as the form is used to create a new person.
2190 In the edit form, <code>$formAction</code> has not to be set explicitly as it is done automatically if a <code>$formObject</code> is set.</li>
2191<li><code>$objectActionClass</code> is set to <code>PersonAction::class</code> and is the class name of the used <code>AbstractForm::$objectAction</code> object to create and update the <code>Person</code> object.</li>
2192<li><code>AbstractFormBuilderForm::createForm()</code> is overridden and the form contents are added:
2193 a form container representing the <code>div.section</code> element from the old version and the two form fields with the same ids and labels as before.
2194 The contents of the old <code>validate()</code> method is put into two method calls:
2195 <code>required()</code> to ensure that the form is filled out and <code>maximumLength(255)</code> to ensure that the names are not longer than 255 characters.</li>
2196</ul>
2197
2198
2199
2200
2201
2202
2203
2204 </article>
2205 </div>
2206 </div>
2207 </main>
2208
2209
2210<footer class="md-footer">
2211
2212 <div class="md-footer-meta md-typeset">
2213 <div class="md-footer-meta__inner md-grid">
2214 <div class="md-footer-copyright">
2215
2216 <div class="md-footer-copyright__highlight">
2217 Copyright © 2020 WoltLab GmbH
2218 </div>
2219
2220 Made with
2221 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2222 Material for MkDocs
2223 </a>
2224 </div>
2225 <div class="md-footer-copyright">
2226 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2227 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2228</div>
2229 </div>
2230 </div>
2231</footer>
2232
2233 </div>
2234 <div class="md-dialog" data-md-component="dialog">
2235 <div class="md-dialog__inner md-typeset"></div>
2236 </div>
2237 <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>
2238
2239
2240 <script src="../../../assets/javascripts/bundle.ca5457b8.min.js"></script>
2241
2242
2243 </body>
2244</html>