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