3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
13 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.0">
17 <title>Part
2 - WoltLab Suite Documentation
</title>
21 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.33e2939f.min.css">
24 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
28 <meta name=
"theme-color" content=
"#009485">
38 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
52 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
55 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
57 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
58 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
59 <label class=
"md-overlay" for=
"__drawer"></label>
60 <div data-md-component=
"skip">
63 <a href=
"#part-2-event-listeners-and-template-listeners" class=
"md-skip">
68 <div data-md-component=
"announce">
70 <aside class=
"md-announce">
71 <div class=
"md-announce__inner md-grid md-typeset">
73 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
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" data-md-component=
"logo">
84 <img src=
"../../../assets/logo.png" alt=
"logo">
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>
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
97 <div class=
"md-header__topic" data-md-component=
"header-topic">
98 <span class=
"md-ellipsis">
109 <label class=
"md-header__button md-icon" for=
"__search">
110 <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 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
114 <label class=
"md-search__overlay" for=
"__search"></label>
115 <div class=
"md-search__inner" role=
"search">
116 <form class=
"md-search__form" name=
"search">
117 <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
>
118 <label class=
"md-search__icon md-icon" for=
"__search">
119 <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>
120 <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 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
123 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.41 17.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 <div class=
"md-search__output">
127 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
128 <div class=
"md-search-result" data-md-component=
"search-result">
129 <div class=
"md-search-result__meta">
132 <ol class=
"md-search-result__list"></ol>
140 <div class=
"md-header__source">
142 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
143 <div class=
"md-source__icon md-icon">
145 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 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>
147 <div class=
"md-source__repository">
156 <div class=
"md-container" data-md-component=
"container">
161 <main class=
"md-main" data-md-component=
"main">
162 <div class=
"md-main__inner md-grid">
166 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
167 <div class=
"md-sidebar__scrollwrap">
168 <div class=
"md-sidebar__inner">
172 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
173 <label class=
"md-nav__title" for=
"__drawer">
174 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
176 <img src=
"../../../assets/logo.png" alt=
"logo">
179 WoltLab Suite Documentation
182 <div class=
"md-nav__source">
184 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
185 <div class=
"md-source__icon md-icon">
187 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 448 512"><path d=
"M439.55 236.05 244 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>
189 <div class=
"md-source__repository">
195 <ul class=
"md-nav__list" data-md-scrollfix
>
204 <li class=
"md-nav__item">
205 <a href=
"../../../getting-started/" class=
"md-nav__link">
220 <li class=
"md-nav__item md-nav__item--nested">
223 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" >
225 <label class=
"md-nav__link" for=
"__nav_2">
227 <span class=
"md-nav__icon md-icon"></span>
229 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
230 <label class=
"md-nav__title" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
234 <ul class=
"md-nav__list" data-md-scrollfix
>
240 <li class=
"md-nav__item">
241 <a href=
"../../../php/pages/" class=
"md-nav__link">
252 <li class=
"md-nav__item">
253 <a href=
"../../../php/database-objects/" class=
"md-nav__link">
264 <li class=
"md-nav__item">
265 <a href=
"../../../php/database-access/" class=
"md-nav__link">
276 <li class=
"md-nav__item">
277 <a href=
"../../../php/exceptions/" class=
"md-nav__link">
289 <li class=
"md-nav__item md-nav__item--nested">
292 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" >
294 <label class=
"md-nav__link" for=
"__nav_2_5">
296 <span class=
"md-nav__icon md-icon"></span>
298 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
299 <label class=
"md-nav__title" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
303 <ul class=
"md-nav__list" data-md-scrollfix
>
310 <li class=
"md-nav__item md-nav__item--nested">
313 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
315 <label class=
"md-nav__link" for=
"__nav_2_5_1">
317 <span class=
"md-nav__icon md-icon"></span>
319 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
320 <label class=
"md-nav__title" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
324 <ul class=
"md-nav__list" data-md-scrollfix
>
330 <li class=
"md-nav__item">
331 <a href=
"../../../php/api/caches/" class=
"md-nav__link">
342 <li class=
"md-nav__item">
343 <a href=
"../../../php/api/caches_persistent-caches/" class=
"md-nav__link">
354 <li class=
"md-nav__item">
355 <a href=
"../../../php/api/caches_runtime-caches/" class=
"md-nav__link">
372 <li class=
"md-nav__item">
373 <a href=
"../../../php/api/comments/" class=
"md-nav__link">
384 <li class=
"md-nav__item">
385 <a href=
"../../../php/api/cronjobs/" class=
"md-nav__link">
396 <li class=
"md-nav__item">
397 <a href=
"../../../php/api/events/" class=
"md-nav__link">
409 <li class=
"md-nav__item md-nav__item--nested">
412 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
414 <label class=
"md-nav__link" for=
"__nav_2_5_5">
416 <span class=
"md-nav__icon md-icon"></span>
418 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
419 <label class=
"md-nav__title" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
423 <ul class=
"md-nav__list" data-md-scrollfix
>
429 <li class=
"md-nav__item">
430 <a href=
"../../../php/api/form_builder/overview/" class=
"md-nav__link">
441 <li class=
"md-nav__item">
442 <a href=
"../../../php/api/form_builder/structure/" class=
"md-nav__link">
453 <li class=
"md-nav__item">
454 <a href=
"../../../php/api/form_builder/form_fields/" class=
"md-nav__link">
465 <li class=
"md-nav__item">
466 <a href=
"../../../php/api/form_builder/validation_data/" class=
"md-nav__link">
477 <li class=
"md-nav__item">
478 <a href=
"../../../php/api/form_builder/dependencies/" class=
"md-nav__link">
495 <li class=
"md-nav__item">
496 <a href=
"../../../php/api/package_installation_plugins/" class=
"md-nav__link">
497 Package Installation Plugins
507 <li class=
"md-nav__item">
508 <a href=
"../../../php/api/user_activity_points/" class=
"md-nav__link">
519 <li class=
"md-nav__item">
520 <a href=
"../../../php/api/user_notifications/" class=
"md-nav__link">
531 <li class=
"md-nav__item">
532 <a href=
"../../../php/api/sitemaps/" class=
"md-nav__link">
549 <li class=
"md-nav__item">
550 <a href=
"../../../php/code-style/" class=
"md-nav__link">
561 <li class=
"md-nav__item">
562 <a href=
"../../../php/apps/" class=
"md-nav__link">
573 <li class=
"md-nav__item">
574 <a href=
"../../../php/gdpr/" class=
"md-nav__link">
595 <li class=
"md-nav__item md-nav__item--nested">
598 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
600 <label class=
"md-nav__link" for=
"__nav_3">
601 Languages, Templates & CSS
602 <span class=
"md-nav__icon md-icon"></span>
604 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
605 <label class=
"md-nav__title" for=
"__nav_3">
606 <span class=
"md-nav__icon md-icon"></span>
607 Languages, Templates & CSS
609 <ul class=
"md-nav__list" data-md-scrollfix
>
615 <li class=
"md-nav__item">
616 <a href=
"../../../view/languages/" class=
"md-nav__link">
627 <li class=
"md-nav__item">
628 <a href=
"../../../view/templates/" class=
"md-nav__link">
639 <li class=
"md-nav__item">
640 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
651 <li class=
"md-nav__item">
652 <a href=
"../../../view/css/" class=
"md-nav__link">
673 <li class=
"md-nav__item md-nav__item--nested">
676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
678 <label class=
"md-nav__link" for=
"__nav_4">
679 TypeScript and JavaScript API
680 <span class=
"md-nav__icon md-icon"></span>
682 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
683 <label class=
"md-nav__title" for=
"__nav_4">
684 <span class=
"md-nav__icon md-icon"></span>
685 TypeScript and JavaScript API
687 <ul class=
"md-nav__list" data-md-scrollfix
>
693 <li class=
"md-nav__item">
694 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
705 <li class=
"md-nav__item">
706 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
718 <li class=
"md-nav__item md-nav__item--nested">
721 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
723 <label class=
"md-nav__link" for=
"__nav_4_3">
725 <span class=
"md-nav__icon md-icon"></span>
727 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
728 <label class=
"md-nav__title" for=
"__nav_4_3">
729 <span class=
"md-nav__icon md-icon"></span>
732 <ul class=
"md-nav__list" data-md-scrollfix
>
738 <li class=
"md-nav__item">
739 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
750 <li class=
"md-nav__item">
751 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
762 <li class=
"md-nav__item">
763 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
774 <li class=
"md-nav__item">
775 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
786 <li class=
"md-nav__item">
787 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
798 <li class=
"md-nav__item">
799 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
810 <li class=
"md-nav__item">
811 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
822 <li class=
"md-nav__item">
823 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
824 Browser and Screen Sizes
834 <li class=
"md-nav__item">
835 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
852 <li class=
"md-nav__item">
853 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
864 <li class=
"md-nav__item">
865 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
876 <li class=
"md-nav__item">
877 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
898 <li class=
"md-nav__item md-nav__item--nested">
901 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
903 <label class=
"md-nav__link" for=
"__nav_5">
905 <span class=
"md-nav__icon md-icon"></span>
907 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
908 <label class=
"md-nav__title" for=
"__nav_5">
909 <span class=
"md-nav__icon md-icon"></span>
912 <ul class=
"md-nav__list" data-md-scrollfix
>
918 <li class=
"md-nav__item">
919 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
931 <li class=
"md-nav__item md-nav__item--nested">
934 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
936 <label class=
"md-nav__link" for=
"__nav_5_2">
938 <span class=
"md-nav__icon md-icon"></span>
940 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
941 <label class=
"md-nav__title" for=
"__nav_5_2">
942 <span class=
"md-nav__icon md-icon"></span>
945 <ul class=
"md-nav__list" data-md-scrollfix
>
951 <li class=
"md-nav__item">
952 <a href=
"../../../package/pip/" class=
"md-nav__link">
963 <li class=
"md-nav__item">
964 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
975 <li class=
"md-nav__item">
976 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
987 <li class=
"md-nav__item">
988 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
999 <li class=
"md-nav__item">
1000 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1011 <li class=
"md-nav__item">
1012 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1023 <li class=
"md-nav__item">
1024 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1035 <li class=
"md-nav__item">
1036 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1047 <li class=
"md-nav__item">
1048 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1059 <li class=
"md-nav__item">
1060 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1071 <li class=
"md-nav__item">
1072 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1083 <li class=
"md-nav__item">
1084 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1095 <li class=
"md-nav__item">
1096 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1107 <li class=
"md-nav__item">
1108 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1119 <li class=
"md-nav__item">
1120 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1131 <li class=
"md-nav__item">
1132 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1143 <li class=
"md-nav__item">
1144 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1155 <li class=
"md-nav__item">
1156 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1167 <li class=
"md-nav__item">
1168 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1169 objectTypeDefinition
1179 <li class=
"md-nav__item">
1180 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1191 <li class=
"md-nav__item">
1192 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1203 <li class=
"md-nav__item">
1204 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1215 <li class=
"md-nav__item">
1216 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1227 <li class=
"md-nav__item">
1228 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1239 <li class=
"md-nav__item">
1240 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1251 <li class=
"md-nav__item">
1252 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1263 <li class=
"md-nav__item">
1264 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1275 <li class=
"md-nav__item">
1276 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1287 <li class=
"md-nav__item">
1288 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1299 <li class=
"md-nav__item">
1300 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1311 <li class=
"md-nav__item">
1312 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1313 userNotificationEvent
1323 <li class=
"md-nav__item">
1324 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1335 <li class=
"md-nav__item">
1336 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1353 <li class=
"md-nav__item">
1354 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1375 <li class=
"md-nav__item md-nav__item--nested">
1378 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1380 <label class=
"md-nav__link" for=
"__nav_6">
1382 <span class=
"md-nav__icon md-icon"></span>
1384 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1385 <label class=
"md-nav__title" for=
"__nav_6">
1386 <span class=
"md-nav__icon md-icon"></span>
1389 <ul class=
"md-nav__list" data-md-scrollfix
>
1396 <li class=
"md-nav__item md-nav__item--nested">
1399 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1401 <label class=
"md-nav__link" for=
"__nav_6_1">
1402 Migrating from WSC
5.3
1403 <span class=
"md-nav__icon md-icon"></span>
1405 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1406 <label class=
"md-nav__title" for=
"__nav_6_1">
1407 <span class=
"md-nav__icon md-icon"></span>
1408 Migrating from WSC
5.3
1410 <ul class=
"md-nav__list" data-md-scrollfix
>
1416 <li class=
"md-nav__item">
1417 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1428 <li class=
"md-nav__item">
1429 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1430 Session Handling and Authentication
1440 <li class=
"md-nav__item">
1441 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1442 TypeScript and JavaScript
1452 <li class=
"md-nav__item">
1453 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1464 <li class=
"md-nav__item">
1465 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1466 Third Party Libraries
1483 <li class=
"md-nav__item md-nav__item--nested">
1486 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1488 <label class=
"md-nav__link" for=
"__nav_6_2">
1489 Migrating from WSC
5.2
1490 <span class=
"md-nav__icon md-icon"></span>
1492 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1493 <label class=
"md-nav__title" for=
"__nav_6_2">
1494 <span class=
"md-nav__icon md-icon"></span>
1495 Migrating from WSC
5.2
1497 <ul class=
"md-nav__list" data-md-scrollfix
>
1503 <li class=
"md-nav__item">
1504 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1515 <li class=
"md-nav__item">
1516 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1517 Templates and Languages
1527 <li class=
"md-nav__item">
1528 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1529 Third Party Libraries
1546 <li class=
"md-nav__item md-nav__item--nested">
1549 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1551 <label class=
"md-nav__link" for=
"__nav_6_3">
1552 Migrating from WSC
3.1
1553 <span class=
"md-nav__icon md-icon"></span>
1555 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1556 <label class=
"md-nav__title" for=
"__nav_6_3">
1557 <span class=
"md-nav__icon md-icon"></span>
1558 Migrating from WSC
3.1
1560 <ul class=
"md-nav__list" data-md-scrollfix
>
1566 <li class=
"md-nav__item">
1567 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1585 <li class=
"md-nav__item md-nav__item--nested">
1588 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1590 <label class=
"md-nav__link" for=
"__nav_6_4">
1591 Migrating from WSC
3.0
1592 <span class=
"md-nav__icon md-icon"></span>
1594 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1595 <label class=
"md-nav__title" for=
"__nav_6_4">
1596 <span class=
"md-nav__icon md-icon"></span>
1597 Migrating from WSC
3.0
1599 <ul class=
"md-nav__list" data-md-scrollfix
>
1605 <li class=
"md-nav__item">
1606 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1617 <li class=
"md-nav__item">
1618 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1629 <li class=
"md-nav__item">
1630 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1641 <li class=
"md-nav__item">
1642 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1653 <li class=
"md-nav__item">
1654 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1672 <li class=
"md-nav__item md-nav__item--nested">
1675 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1677 <label class=
"md-nav__link" for=
"__nav_6_5">
1678 Migrating from WCF
2.1
1679 <span class=
"md-nav__icon md-icon"></span>
1681 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1682 <label class=
"md-nav__title" for=
"__nav_6_5">
1683 <span class=
"md-nav__icon md-icon"></span>
1684 Migrating from WCF
2.1
1686 <ul class=
"md-nav__list" data-md-scrollfix
>
1692 <li class=
"md-nav__item">
1693 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1704 <li class=
"md-nav__item">
1705 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1716 <li class=
"md-nav__item">
1717 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1728 <li class=
"md-nav__item">
1729 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1758 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1761 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" checked
>
1763 <label class=
"md-nav__link" for=
"__nav_7">
1765 <span class=
"md-nav__icon md-icon"></span>
1767 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1768 <label class=
"md-nav__title" for=
"__nav_7">
1769 <span class=
"md-nav__icon md-icon"></span>
1772 <ul class=
"md-nav__list" data-md-scrollfix
>
1781 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
1784 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" checked
>
1786 <label class=
"md-nav__link" for=
"__nav_7_1">
1788 <span class=
"md-nav__icon md-icon"></span>
1790 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1791 <label class=
"md-nav__title" for=
"__nav_7_1">
1792 <span class=
"md-nav__icon md-icon"></span>
1795 <ul class=
"md-nav__list" data-md-scrollfix
>
1801 <li class=
"md-nav__item">
1802 <a href=
"../overview/" class=
"md-nav__link">
1813 <li class=
"md-nav__item">
1814 <a href=
"../part_1/" class=
"md-nav__link">
1827 <li class=
"md-nav__item md-nav__item--active">
1829 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
1834 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
1836 <span class=
"md-nav__icon md-icon"></span>
1839 <a href=
"./" class=
"md-nav__link md-nav__link--active">
1844 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1850 <label class=
"md-nav__title" for=
"__toc">
1851 <span class=
"md-nav__icon md-icon"></span>
1854 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1856 <li class=
"md-nav__item">
1857 <a href=
"#package-functionality" class=
"md-nav__link">
1858 Package Functionality
1863 <li class=
"md-nav__item">
1864 <a href=
"#used-components" class=
"md-nav__link">
1870 <li class=
"md-nav__item">
1871 <a href=
"#package-structure" class=
"md-nav__link">
1877 <li class=
"md-nav__item">
1878 <a href=
"#extending-person-model-installsql" class=
"md-nav__link">
1879 Extending Person Model (install.sql)
1884 <li class=
"md-nav__item">
1885 <a href=
"#setting-birthday-in-acp" class=
"md-nav__link">
1886 Setting Birthday in ACP
1891 <li class=
"md-nav__item">
1892 <a href=
"#adding-birthday-table-column-in-acp" class=
"md-nav__link">
1893 Adding Birthday Table Column in ACP
1898 <li class=
"md-nav__item">
1899 <a href=
"#adding-birthday-in-front-end" class=
"md-nav__link">
1900 Adding Birthday in Front End
1905 <li class=
"md-nav__item">
1906 <a href=
"#templatelistenerxml" class=
"md-nav__link">
1907 templateListener.xml
1912 <li class=
"md-nav__item">
1913 <a href=
"#eventlistenerxml" class=
"md-nav__link">
1919 <li class=
"md-nav__item">
1920 <a href=
"#packagexml" class=
"md-nav__link">
1938 <li class=
"md-nav__item">
1939 <a href=
"../part_3/" class=
"md-nav__link">
1966 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
1967 <div class=
"md-sidebar__scrollwrap">
1968 <div class=
"md-sidebar__inner">
1970 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
1976 <label class=
"md-nav__title" for=
"__toc">
1977 <span class=
"md-nav__icon md-icon"></span>
1980 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
1982 <li class=
"md-nav__item">
1983 <a href=
"#package-functionality" class=
"md-nav__link">
1984 Package Functionality
1989 <li class=
"md-nav__item">
1990 <a href=
"#used-components" class=
"md-nav__link">
1996 <li class=
"md-nav__item">
1997 <a href=
"#package-structure" class=
"md-nav__link">
2003 <li class=
"md-nav__item">
2004 <a href=
"#extending-person-model-installsql" class=
"md-nav__link">
2005 Extending Person Model (install.sql)
2010 <li class=
"md-nav__item">
2011 <a href=
"#setting-birthday-in-acp" class=
"md-nav__link">
2012 Setting Birthday in ACP
2017 <li class=
"md-nav__item">
2018 <a href=
"#adding-birthday-table-column-in-acp" class=
"md-nav__link">
2019 Adding Birthday Table Column in ACP
2024 <li class=
"md-nav__item">
2025 <a href=
"#adding-birthday-in-front-end" class=
"md-nav__link">
2026 Adding Birthday in Front End
2031 <li class=
"md-nav__item">
2032 <a href=
"#templatelistenerxml" class=
"md-nav__link">
2033 templateListener.xml
2038 <li class=
"md-nav__item">
2039 <a href=
"#eventlistenerxml" class=
"md-nav__link">
2045 <li class=
"md-nav__item">
2046 <a href=
"#packagexml" class=
"md-nav__link">
2060 <div class=
"md-content" data-md-component=
"content">
2061 <article class=
"md-content__inner md-typeset">
2064 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/tutorial/series/part_2.md" title=
"Edit this page" class=
"md-content__button md-icon">
2065 <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>
2069 <h1 id=
"part-2-event-listeners-and-template-listeners">Part
2: Event Listeners and Template Listeners
<a class=
"headerlink" href=
"#part-2-event-listeners-and-template-listeners" title=
"Permanent link">#
</a></h1>
2070 <div class=
"admonition warning">
2071 <p class=
"admonition-title">This part of the tutorial series is currently outdated while the tutorial series is updated.
</p>
2073 <p>In the
<a href=
"../part_1/">first part
</a> of this tutorial series, we have created the base structure of our people management package.
2074 In further parts, we will use the package of the first part as a basis to directly add new features.
2075 In order to explain how event listeners and template works, however, we will not directly adding a new feature to the package by altering it in this part, but we will assume that somebody else created the package and that we want to extend it the “correct” way by creating a plugin.
</p>
2076 <p>The goal of the small plugin that will be created in this part is to add the birthday of the managed people.
2077 As in the first part, we will not bother with careful validation of the entered date but just make sure that it is a valid date.
</p>
2078 <h2 id=
"package-functionality">Package Functionality
<a class=
"headerlink" href=
"#package-functionality" title=
"Permanent link">#
</a></h2>
2079 <p>The package should provide the following possibilities/functions:
</p>
2081 <li>List person’s birthday (if set) in people list in the ACP
</li>
2082 <li>Sort people list by birthday in the ACP
</li>
2083 <li>Add or remove birthday when adding or editing person
</li>
2084 <li>List person’s birthday (if set) in people list in the front end
</li>
2085 <li>Sort people list by birthday in the front end
</li>
2087 <h2 id=
"used-components">Used Components
<a class=
"headerlink" href=
"#used-components" title=
"Permanent link">#
</a></h2>
2088 <p>We will use the following package installation plugins:
</p>
2090 <li><a href=
"../../../package/pip/acp-template/">acpTemplate package installation plugin
</a>,
</li>
2091 <li><a href=
"../../../package/pip/event-listener/">eventListener package installation plugin
</a>,
</li>
2092 <li><a href=
"../../../package/pip/file/">file package installation plugin
</a>,
</li>
2093 <li><a href=
"../../../package/pip/language/">language package installation plugin
</a>,
</li>
2094 <li><a href=
"../../../package/pip/sql/">sql package installation plugin
</a>,
</li>
2095 <li><a href=
"../../../package/pip/template/">template package installation plugin
</a>,
</li>
2096 <li><a href=
"../../../package/pip/template-listener/">templateListener package installation plugin
</a>.
</li>
2098 <p>For more information about the event system, please refer to the
<a href=
"../../../php/api/events/">dedicated page on events
</a>.
</p>
2099 <h2 id=
"package-structure">Package Structure
<a class=
"headerlink" href=
"#package-structure" title=
"Permanent link">#
</a></h2>
2100 <p>The package will have the following file structure:
</p>
2101 <div class=
"highlight"><pre><span></span><code>├── acptemplates
2102 │ └── __personAddBirthday.tpl
2103 ├── eventListener.xml
2109 │ ├── BirthdayPersonAddFormListener.class.php
2110 │ └── BirthdaySortFieldPersonListPageListener.class.php
2116 ├── templateListener.xml
2118 ├── __personListBirthday.tpl
2119 └── __personListBirthdaySortField.tpl
2121 <h2 id=
"extending-person-model-installsql">Extending Person Model (
<code>install.sql
</code>)
<a class=
"headerlink" href=
"#extending-person-model-installsql" title=
"Permanent link">#
</a></h2>
2122 <p>The existing model of a person only contains the person’s first name and their last name (in additional to the id used to identify created people).
2123 To add the birthday to the model, we need to create an additional database table column using the
<a href=
"../../../package/pip/sql/">sql package installation plugin
</a>:
</p>
2124 <div class=
"highlight"><pre><span></span><code><span class=
"k">ALTER
</span> <span class=
"k">TABLE
</span> <span class=
"n">wcf1_person
</span> <span class=
"k">ADD
</span> <span class=
"n">birthday
</span> <span class=
"nb">DATE
</span> <span class=
"k">NOT
</span> <span class=
"k">NULL
</span><span class=
"p">;
</span>
2126 <p>If we have a
<a href=
"../part_1/#person">Person object
</a>, this new property can be accessed the same way as the
<code>personID
</code> property, the
<code>firstName
</code> property, or the
<code>lastName
</code> property from the base package:
<code>$person-
>birthday
</code>.
</p>
2127 <h2 id=
"setting-birthday-in-acp">Setting Birthday in ACP
<a class=
"headerlink" href=
"#setting-birthday-in-acp" title=
"Permanent link">#
</a></h2>
2128 <p>To set the birthday of a person, we need to extend the
<code>personAdd
</code> template to add an additional birthday field.
2129 This can be achieved using the
<code>dataFields
</code> template event at whose position we inject the following template code:
</p>
2130 <div class=
"highlight"><pre><span></span><code><span class=
"o"><</span><span class=
"n">dl
</span><span class=
"err">{
</span><span class=
"k">if
</span> <span class=
"err">$
</span><span class=
"n">errorField
</span> <span class=
"o">==
</span> <span class=
"s1">'birthday
'</span><span class=
"err">}
</span> <span class=
"k">class
</span><span class=
"o">=
</span><span class=
"ss">"formError
"</span><span class=
"err">{
</span><span class=
"o">/
</span><span class=
"k">if
</span><span class=
"err">}
</span><span class=
"o">></span>
2131 <span class=
"o"><</span><span class=
"n">dt
</span><span class=
"o">><</span><span class=
"n">label
</span> <span class=
"k">for
</span><span class=
"o">=
</span><span class=
"ss">"birthday
"</span><span class=
"o">></span><span class=
"err">{
</span><span class=
"n">lang
</span><span class=
"err">}
</span><span class=
"n">wcf
</span><span class=
"p">.
</span><span class=
"n">person
</span><span class=
"p">.
</span><span class=
"n">birthday
</span><span class=
"err">{
</span><span class=
"o">/
</span><span class=
"n">lang
</span><span class=
"err">}
</span><span class=
"o"></
</span><span class=
"n">label
</span><span class=
"o">></
</span><span class=
"n">dt
</span><span class=
"o">></span>
2132 <span class=
"o"><</span><span class=
"n">dd
</span><span class=
"o">></span>
2133 <span class=
"o"><</span><span class=
"k">input
</span> <span class=
"k">type
</span><span class=
"o">=
</span><span class=
"ss">"date
"</span> <span class=
"n">id
</span><span class=
"o">=
</span><span class=
"ss">"birthday
"</span> <span class=
"n">name
</span><span class=
"o">=
</span><span class=
"ss">"birthday
"</span> <span class=
"n">value
</span><span class=
"o">=
</span><span class=
"ss">"{$birthday}
"</span><span class=
"o">></span>
2134 <span class=
"err">{
</span><span class=
"k">if
</span> <span class=
"err">$
</span><span class=
"n">errorField
</span> <span class=
"o">==
</span> <span class=
"s1">'birthday
'</span><span class=
"err">}
</span>
2135 <span class=
"o"><</span><span class=
"n">small
</span> <span class=
"k">class
</span><span class=
"o">=
</span><span class=
"ss">"innerError
"</span><span class=
"o">></span>
2136 <span class=
"err">{
</span><span class=
"k">if
</span> <span class=
"err">$
</span><span class=
"n">errorType
</span> <span class=
"o">==
</span> <span class=
"s1">'noValidSelection
'</span><span class=
"err">}
</span>
2137 <span class=
"err">{
</span><span class=
"n">lang
</span><span class=
"err">}
</span><span class=
"n">wcf
</span><span class=
"p">.
</span><span class=
"k">global
</span><span class=
"p">.
</span><span class=
"n">form
</span><span class=
"p">.
</span><span class=
"n">error
</span><span class=
"p">.
</span><span class=
"n">noValidSelection
</span><span class=
"err">{
</span><span class=
"o">/
</span><span class=
"n">lang
</span><span class=
"err">}
</span>
2138 <span class=
"err">{
</span><span class=
"k">else
</span><span class=
"err">}
</span>
2139 <span class=
"err">{
</span><span class=
"n">lang
</span><span class=
"err">}
</span><span class=
"n">wcf
</span><span class=
"p">.
</span><span class=
"n">acp
</span><span class=
"p">.
</span><span class=
"n">person
</span><span class=
"p">.
</span><span class=
"n">birthday
</span><span class=
"p">.
</span><span class=
"n">error
</span><span class=
"p">.
</span><span class=
"err">{$
</span><span class=
"n">errorType
</span><span class=
"err">}{
</span><span class=
"o">/
</span><span class=
"n">lang
</span><span class=
"err">}
</span>
2140 <span class=
"err">{
</span><span class=
"o">/
</span><span class=
"k">if
</span><span class=
"err">}
</span>
2141 <span class=
"o"></
</span><span class=
"n">small
</span><span class=
"o">></span>
2142 <span class=
"err">{
</span><span class=
"o">/
</span><span class=
"k">if
</span><span class=
"err">}
</span>
2143 <span class=
"o"></
</span><span class=
"n">dd
</span><span class=
"o">></span>
2144 <span class=
"o"></
</span><span class=
"n">dl
</span><span class=
"o">></span>
2146 <p>which we store in a
<code>__personAddBirthday.tpl
</code> template file.
2147 The used language item
<code>wcf.person.birthday
</code> is actually the only new one for this package:
</p>
2148 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"n">xml
</span> <span class=
"k">version
</span><span class=
"o">=
</span><span class=
"ss">"1.0"</span> <span class=
"k">encoding
</span><span class=
"o">=
</span><span class=
"ss">"UTF-
8"</span><span class=
"o">?
></span>
2149 <span class=
"o"><</span><span class=
"k">language
</span> <span class=
"n">xmlns
</span><span class=
"o">=
</span><span class=
"ss">"http://www.woltlab.com
"</span> <span class=
"n">xmlns
</span><span class=
"p">:
</span><span class=
"n">xsi
</span><span class=
"o">=
</span><span class=
"ss">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"n">xsi
</span><span class=
"p">:
</span><span class=
"n">schemaLocation
</span><span class=
"o">=
</span><span class=
"ss">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/language.xsd
"</span> <span class=
"n">languagecode
</span><span class=
"o">=
</span><span class=
"ss">"de
"</span><span class=
"o">></span>
2150 <span class=
"o"><</span><span class=
"n">category
</span> <span class=
"n">name
</span><span class=
"o">=
</span><span class=
"ss">"wcf.person
"</span><span class=
"o">></span>
2151 <span class=
"o"><</span><span class=
"n">item
</span> <span class=
"n">name
</span><span class=
"o">=
</span><span class=
"ss">"wcf.person.birthday
"</span><span class=
"o">><!
</span><span class=
"p">[
</span><span class=
"n">CDATA
</span><span class=
"p">[
</span><span class=
"n">Geburtstag
</span><span class=
"p">]]
</span><span class=
"o">></
</span><span class=
"n">item
</span><span class=
"o">></span>
2152 <span class=
"o"></
</span><span class=
"n">category
</span><span class=
"o">></span>
2153 <span class=
"o"></
</span><span class=
"k">language
</span><span class=
"o">></span>
2155 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"n">xml
</span> <span class=
"k">version
</span><span class=
"o">=
</span><span class=
"ss">"1.0"</span> <span class=
"k">encoding
</span><span class=
"o">=
</span><span class=
"ss">"UTF-
8"</span><span class=
"o">?
></span>
2156 <span class=
"o"><</span><span class=
"k">language
</span> <span class=
"n">xmlns
</span><span class=
"o">=
</span><span class=
"ss">"http://www.woltlab.com
"</span> <span class=
"n">xmlns
</span><span class=
"p">:
</span><span class=
"n">xsi
</span><span class=
"o">=
</span><span class=
"ss">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"n">xsi
</span><span class=
"p">:
</span><span class=
"n">schemaLocation
</span><span class=
"o">=
</span><span class=
"ss">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/language.xsd
"</span> <span class=
"n">languagecode
</span><span class=
"o">=
</span><span class=
"ss">"en
"</span><span class=
"o">></span>
2157 <span class=
"o"><</span><span class=
"n">category
</span> <span class=
"n">name
</span><span class=
"o">=
</span><span class=
"ss">"wcf.person
"</span><span class=
"o">></span>
2158 <span class=
"o"><</span><span class=
"n">item
</span> <span class=
"n">name
</span><span class=
"o">=
</span><span class=
"ss">"wcf.person.birthday
"</span><span class=
"o">><!
</span><span class=
"p">[
</span><span class=
"n">CDATA
</span><span class=
"p">[
</span><span class=
"n">Birthday
</span><span class=
"p">]]
</span><span class=
"o">></
</span><span class=
"n">item
</span><span class=
"o">></span>
2159 <span class=
"o"></
</span><span class=
"n">category
</span><span class=
"o">></span>
2160 <span class=
"o"></
</span><span class=
"k">language
</span><span class=
"o">></span>
2162 <p>The template listener needs to be registered using the
<a href=
"../../../package/pip/template-listener/">templateListener package installation plugin
</a>.
2163 The corresponding complete
<code>templateListener.xml
</code> file is included
<a href=
"#templatelistenerxml">below
</a>.
</p>
2164 <p>The template code alone is not sufficient because the
<code>birthday
</code> field is, at the moment, neither read, nor processed, nor saved by any PHP code.
2165 This can be be achieved, however, by adding event listeners to
<code>PersonAddForm
</code> and
<code>PersonEditForm
</code> which allow us to execute further code at specific location of the program.
2166 Before we take a look at the event listener code, we need to identify exactly which additional steps we need to undertake:
</p>
2168 <li>If a person is edited and the form has not been submitted, the existing birthday of that person needs to be read.
</li>
2169 <li>If a person is added or edited and the form has been submitted, the new birthday value needs to be read.
</li>
2170 <li>If a person is added or edited and the form has been submitted, the new birthday value needs to be validated.
</li>
2171 <li>If a person is added or edited and the new birthday value has been successfully validated, the new birthday value needs to be saved.
</li>
2172 <li>If a person is added and the new birthday value has been successfully saved, the internally stored birthday needs to be reset so that the birthday field is empty when the form is shown again.
</li>
2173 <li>The internally stored birthday value needs to be assigned to the template.
</li>
2175 <p>The following event listeners achieves these requirements:
</p>
2176 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2177 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\event\listener
</span><span class=
"p">;
</span>
2178 <span class=
"k">use
</span> <span class=
"nx">wcf\acp\form\PersonAddForm
</span><span class=
"p">;
</span>
2179 <span class=
"k">use
</span> <span class=
"nx">wcf\acp\form\PersonEditForm
</span><span class=
"p">;
</span>
2180 <span class=
"k">use
</span> <span class=
"nx">wcf\form\IForm
</span><span class=
"p">;
</span>
2181 <span class=
"k">use
</span> <span class=
"nx">wcf\page\IPage
</span><span class=
"p">;
</span>
2182 <span class=
"k">use
</span> <span class=
"nx">wcf\system\exception\UserInputException
</span><span class=
"p">;
</span>
2183 <span class=
"k">use
</span> <span class=
"nx">wcf\system\WCF
</span><span class=
"p">;
</span>
2184 <span class=
"k">use
</span> <span class=
"nx">wcf\util\StringUtil
</span><span class=
"p">;
</span>
2186 <span class=
"sd">/**
</span>
2187 <span class=
"sd"> * Handles setting the birthday when adding and editing people.
</span>
2188 <span class=
"sd"> *
</span>
2189 <span class=
"sd"> * @author Matthias Schmidt
</span>
2190 <span class=
"sd"> * @copyright
2001-
2020 WoltLab GmbH
</span>
2191 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
2192 <span class=
"sd"> * @package WoltLabSuite\Core\System\Event\Listener
</span>
2193 <span class=
"sd"> */
</span>
2194 <span class=
"k">class
</span> <span class=
"nc">BirthdayPersonAddFormListener
</span> <span class=
"k">extends
</span> <span class=
"nx">AbstractEventListener
</span> <span class=
"p">{
</span>
2195 <span class=
"sd">/**
</span>
2196 <span class=
"sd"> * birthday of the created or edited person
</span>
2197 <span class=
"sd"> * @var string
</span>
2198 <span class=
"sd"> */
</span>
2199 <span class=
"k">protected
</span> <span class=
"nv">$birthday
</span> <span class=
"o">=
</span> <span class=
"s1">''</span><span class=
"p">;
</span>
2201 <span class=
"sd">/**
</span>
2202 <span class=
"sd"> * @see IPage::assignVariables()
</span>
2203 <span class=
"sd"> */
</span>
2204 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onAssignVariables
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2205 <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getTPL
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">assign
</span><span class=
"p">(
</span><span class=
"s1">'birthday
'</span><span class=
"p">,
</span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"p">);
</span>
2206 <span class=
"p">}
</span>
2208 <span class=
"sd">/**
</span>
2209 <span class=
"sd"> * @see IPage::readData()
</span>
2210 <span class=
"sd"> */
</span>
2211 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onReadData
</span><span class=
"p">(
</span><span class=
"nx">PersonEditForm
</span> <span class=
"nv">$form
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2212 <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>
2213 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">=
</span> <span class=
"nv">$form
</span><span class=
"o">-
></span><span class=
"na">person
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"p">;
</span>
2215 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">===
</span> <span class=
"s1">'0000-
00-
00'</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2216 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">=
</span> <span class=
"s1">''</span><span class=
"p">;
</span>
2217 <span class=
"p">}
</span>
2218 <span class=
"p">}
</span>
2219 <span class=
"p">}
</span>
2221 <span class=
"sd">/**
</span>
2222 <span class=
"sd"> * @see IForm::readFormParameters()
</span>
2223 <span class=
"sd"> */
</span>
2224 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onReadFormParameters
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2225 <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">'birthday
'</span><span class=
"p">]))
</span> <span class=
"p">{
</span>
2226 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</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">'birthday
'</span><span class=
"p">]);
</span>
2227 <span class=
"p">}
</span>
2228 <span class=
"p">}
</span>
2230 <span class=
"sd">/**
</span>
2231 <span class=
"sd"> * @see IForm::save()
</span>
2232 <span class=
"sd"> */
</span>
2233 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onSave
</span><span class=
"p">(
</span><span class=
"nx">PersonAddForm
</span> <span class=
"nv">$form
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2234 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2235 <span class=
"nv">$form
</span><span class=
"o">-
></span><span class=
"na">additionalFields
</span><span class=
"p">[
</span><span class=
"s1">'birthday
'</span><span class=
"p">]
</span> <span class=
"o">=
</span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"p">;
</span>
2236 <span class=
"p">}
</span>
2237 <span class=
"k">else
</span> <span class=
"p">{
</span>
2238 <span class=
"nv">$form
</span><span class=
"o">-
></span><span class=
"na">additionalFields
</span><span class=
"p">[
</span><span class=
"s1">'birthday
'</span><span class=
"p">]
</span> <span class=
"o">=
</span> <span class=
"s1">'0000-
00-
00'</span><span class=
"p">;
</span>
2239 <span class=
"p">}
</span>
2240 <span class=
"p">}
</span>
2242 <span class=
"sd">/**
</span>
2243 <span class=
"sd"> * @see IForm::saved()
</span>
2244 <span class=
"sd"> */
</span>
2245 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onSaved
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2246 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">=
</span> <span class=
"s1">''</span><span class=
"p">;
</span>
2247 <span class=
"p">}
</span>
2249 <span class=
"sd">/**
</span>
2250 <span class=
"sd"> * @see IForm::validate()
</span>
2251 <span class=
"sd"> */
</span>
2252 <span class=
"k">protected
</span> <span class=
"k">function
</span> <span class=
"nf">onValidate
</span><span class=
"p">()
</span> <span class=
"p">{
</span>
2253 <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">-
></span><span class=
"na">birthday
</span><span class=
"p">))
</span> <span class=
"p">{
</span>
2254 <span class=
"k">return
</span><span class=
"p">;
</span>
2255 <span class=
"p">}
</span>
2257 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"o">!
</span><span class=
"nb">preg_match
</span><span class=
"p">(
</span><span class=
"s1">'/^(\d{
4})-(\d{
2})-(\d{
2})$/
'</span><span class=
"p">,
</span> <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"p">,
</span> <span class=
"nv">$match
</span><span class=
"p">))
</span> <span class=
"p">{
</span>
2258 <span class=
"k">throw
</span> <span class=
"k">new
</span> <span class=
"nx">UserInputException
</span><span class=
"p">(
</span><span class=
"s1">'birthday
'</span><span class=
"p">,
</span> <span class=
"s1">'noValidSelection
'</span><span class=
"p">);
</span>
2259 <span class=
"p">}
</span>
2261 <span class=
"k">if
</span> <span class=
"p">(
</span><span class=
"o">!
</span><span class=
"nb">checkdate
</span><span class=
"p">(
</span><span class=
"nb">intval
</span><span class=
"p">(
</span><span class=
"nv">$match
</span><span class=
"p">[
</span><span class=
"mi">2</span><span class=
"p">]),
</span> <span class=
"nb">intval
</span><span class=
"p">(
</span><span class=
"nv">$match
</span><span class=
"p">[
</span><span class=
"mi">3</span><span class=
"p">]),
</span> <span class=
"nb">intval
</span><span class=
"p">(
</span><span class=
"nv">$match
</span><span class=
"p">[
</span><span class=
"mi">1</span><span class=
"p">])))
</span> <span class=
"p">{
</span>
2262 <span class=
"k">throw
</span> <span class=
"k">new
</span> <span class=
"nx">UserInputException
</span><span class=
"p">(
</span><span class=
"s1">'birthday
'</span><span class=
"p">,
</span> <span class=
"s1">'noValidSelection
'</span><span class=
"p">);
</span>
2263 <span class=
"p">}
</span>
2264 <span class=
"p">}
</span>
2265 <span class=
"p">}
</span>
2267 <p>Some notes on the code:
</p>
2269 <li>We are inheriting from
<code>AbstractEventListener
</code>, instead of just implementing the
<code>IParameterizedEventListener
</code> interface.
2270 The
<code>execute()
</code> method of
<code>AbstractEventListener
</code> contains a dispatcher that automatically calls methods called
<code>on
</code> followed by the event name with the first character uppercased, passing the event object and the
<code>$parameters
</code> array.
2271 This simple pattern results in the event
<code>foo
</code> being forwarded to the method
<code>onFoo($eventObj, $parameters)
</code>.
</li>
2272 <li>The
<code>birthday
</code> column has a default value of
<code>0000-
00-
00</code>, which we interpret as “birthday not set”.
2273 To show an empty input field in this case, we empty the
<code>birthday
</code> property after reading such a value in
<code>readData()
</code>.
</li>
2274 <li>The validation of the date is, as mentioned before, very basic and just checks the form of the string and uses PHP’s
<a href=
"https://secure.php.net/manual/en/function.checkdate.php">checkdate
</a> function to validate the components.
</li>
2275 <li>The
<code>save
</code> needs to make sure that the passed date is actually a valid date and set it to
<code>0000-
00-
00</code> if no birthday is given.
2276 To actually save the birthday in the database, we do not directly manipulate the database but can add an additional field to the data array passed to
<code>PersonAction::create()
</code> via
<code>AbstractForm::$additionalFields
</code>.
2277 As the
<code>save
</code> event is the last event fired before the actual save process happens, this is the perfect event to set this array element.
</li>
2279 <p>The event listeners are installed using the
<code>eventListener.xml
</code> file shown
<a href=
"#eventlistenerxml">below
</a>.
</p>
2280 <h2 id=
"adding-birthday-table-column-in-acp">Adding Birthday Table Column in ACP
<a class=
"headerlink" href=
"#adding-birthday-table-column-in-acp" title=
"Permanent link">#
</a></h2>
2281 <p>To add a birthday column to the person list page in the ACP, we need three parts:
</p>
2283 <li>an event listener that makes the
<code>birthday
</code> database table column a valid sort field,
</li>
2284 <li>a template listener that adds the birthday column to the table’s head, and
</li>
2285 <li>a template listener that adds the birthday column to the table’s rows.
</li>
2287 <p>The first part is a very simple class:
</p>
2288 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2289 <span class=
"k">namespace
</span> <span class=
"nx">wcf\system\event\listener
</span><span class=
"p">;
</span>
2290 <span class=
"k">use
</span> <span class=
"nx">wcf\page\SortablePage
</span><span class=
"p">;
</span>
2292 <span class=
"sd">/**
</span>
2293 <span class=
"sd"> * Makes people
's birthday a valid sort field in the ACP and the front end.
</span>
2294 <span class=
"sd"> *
</span>
2295 <span class=
"sd"> * @author Matthias Schmidt
</span>
2296 <span class=
"sd"> * @copyright
2001-
2019 WoltLab GmbH
</span>
2297 <span class=
"sd"> * @license GNU Lesser General Public License
<http://opensource.org/licenses/lgpl-license.php
></span>
2298 <span class=
"sd"> * @package WoltLabSuite\Core\System\Event\Listener
</span>
2299 <span class=
"sd"> */
</span>
2300 <span class=
"k">class
</span> <span class=
"nc">BirthdaySortFieldPersonListPageListener
</span> <span class=
"k">implements
</span> <span class=
"nx">IParameterizedEventListener
</span> <span class=
"p">{
</span>
2301 <span class=
"sd">/**
</span>
2302 <span class=
"sd"> * @inheritDoc
</span>
2303 <span class=
"sd"> */
</span>
2304 <span class=
"k">public
</span> <span class=
"k">function
</span> <span class=
"nf">execute
</span><span class=
"p">(
</span><span class=
"nv">$eventObj
</span><span class=
"p">,
</span> <span class=
"nv">$className
</span><span class=
"p">,
</span> <span class=
"nv">$eventName
</span><span class=
"p">,
</span> <span class=
"k">array
</span> <span class=
"o">&</span><span class=
"nv">$parameters
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2305 <span class=
"sd">/** @var SortablePage $eventObj */
</span>
2307 <span class=
"nv">$eventObj
</span><span class=
"o">-
></span><span class=
"na">validSortFields
</span><span class=
"p">[]
</span> <span class=
"o">=
</span> <span class=
"s1">'birthday
'</span><span class=
"p">;
</span>
2308 <span class=
"p">}
</span>
2309 <span class=
"p">}
</span>
2311 <div class=
"admonition info">
2312 <p class=
"admonition-title">We use
<code>SortablePage
</code> as a type hint instead of
<code>wcf\acp\page\PersonListPage
</code> because we will be using the same event listener class in the front end to also allow sorting that list by birthday.
</p>
2314 <p>As the relevant template codes are only one line each, we will simply put them directly in the
<code>templateListener.xml
</code> file that will be shown
<a href=
"#templatelistenerxml">later on
</a>.
2315 The code for the table head is similar to the other
<code>th
</code> elements:
</p>
2316 <div class=
"highlight"><pre><span></span><code><span class=
"x"><th class=
"columnDate columnBirthday
</span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$sortField
</span> <span class=
"o">==
</span> <span class=
"s1">'birthday
'</span><span class=
"cp">}
</span><span class=
"x"> active
</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$sortOrder
</span><span class=
"cp">}{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x">"><a href=
"</span><span class=
"cp">{
</span><span class=
"nf">link
</span> <span class=
"na">controller
</span><span class=
"o">=
</span><span class=
"s1">'PersonList
'</span><span class=
"cp">}
</span><span class=
"x">pageNo=
</span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$pageNo
</span><span class=
"cp">}
</span><span class=
"x">&sortField=birthday
&sortOrder=
</span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$sortField
</span> <span class=
"o">==
</span> <span class=
"s1">'birthday
'</span> <span class=
"o">&&</span> <span class=
"nv">$sortOrder
</span> <span class=
"o">==
</span> <span class=
"s1">'ASC
'</span><span class=
"cp">}
</span><span class=
"x">DESC
</span><span class=
"cp">{
</span><span class=
"nf">else
</span><span class=
"cp">}
</span><span class=
"x">ASC
</span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}{
</span><span class=
"nf">/link
</span><span class=
"cp">}
</span><span class=
"x">"></span><span class=
"cp">{
</span><span class=
"nf">lang
</span><span class=
"cp">}
</span><span class=
"x">wcf.person.birthday
</span><span class=
"cp">{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x"></a
></th
></span>
2318 <p>For the table body’s column, we need to make sure that the birthday is only show if it is actually set:
</p>
2319 <div class=
"highlight"><pre><span></span><code><span class=
"x"><td class=
"columnDate columnBirthday
"></span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$person
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">!==
</span> <span class=
"s1">'0000-
00-
00'</span><span class=
"cp">}{
</span><span class=
"o">@
</span><span class=
"nv">$person
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"o">|
</span><span class=
"na">strtotime
</span><span class=
"o">|
</span><span class=
"na">date
</span><span class=
"cp">}{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></td
></span>
2321 <h2 id=
"adding-birthday-in-front-end">Adding Birthday in Front End
<a class=
"headerlink" href=
"#adding-birthday-in-front-end" title=
"Permanent link">#
</a></h2>
2322 <p>In the front end, we also want to make the list sortable by birthday and show the birthday as part of each person’s “statistics”.
</p>
2323 <p>To add the birthday as a valid sort field, we use
<code>BirthdaySortFieldPersonListPageListener
</code> just as in the ACP.
2324 In the front end, we will now use a template (
<code>__personListBirthdaySortField.tpl
</code>) instead of a directly putting the template code in the
<code>templateListener.xml
</code> file:
</p>
2325 <div class=
"highlight"><pre><span></span><code><span class=
"x"><option value=
"birthday
"</span><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$sortField
</span> <span class=
"o">==
</span> <span class=
"s1">'birthday
'</span><span class=
"cp">}
</span><span class=
"x"> selected
</span><span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x">></span><span class=
"cp">{
</span><span class=
"nf">lang
</span><span class=
"cp">}
</span><span class=
"x">wcf.person.birthday
</span><span class=
"cp">{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x"></option
></span>
2327 <div class=
"admonition info">
2328 <p class=
"admonition-title">You might have noticed the two underscores at the beginning of the template file. For templates that are included via template listeners, this is the naming convention we use.
</p>
2330 <p>Putting the template code into a file has the advantage that in the administrator is able to edit the code directly via a custom template group, even though in this case this might not be very probable.
</p>
2331 <p>To show the birthday, we use the following template code for the
<code>personStatistics
</code> template event, which again makes sure that the birthday is only shown if it is actually set:
</p>
2332 <div class=
"highlight"><pre><span></span><code><span class=
"cp">{
</span><span class=
"nf">if
</span> <span class=
"nv">$person
</span><span class=
"o">-
></span><span class=
"na">birthday
</span> <span class=
"o">!==
</span> <span class=
"s1">'0000-
00-
00'</span><span class=
"cp">}
</span><span class=
"x"></span>
2333 <span class=
"x"> <dt
></span><span class=
"cp">{
</span><span class=
"nf">lang
</span><span class=
"cp">}
</span><span class=
"x">wcf.person.birthday
</span><span class=
"cp">{
</span><span class=
"nf">/lang
</span><span class=
"cp">}
</span><span class=
"x"></dt
></span>
2334 <span class=
"x"> <dd
></span><span class=
"cp">{
</span><span class=
"o">@
</span><span class=
"nv">$person
</span><span class=
"o">-
></span><span class=
"na">birthday
</span><span class=
"o">|
</span><span class=
"na">strtotime
</span><span class=
"o">|
</span><span class=
"na">date
</span><span class=
"cp">}
</span><span class=
"x"></dd
></span>
2335 <span class=
"cp">{
</span><span class=
"nf">/if
</span><span class=
"cp">}
</span><span class=
"x"></span>
2337 <h2 id=
"templatelistenerxml"><code>templateListener.xml
</code><a class=
"headerlink" href=
"#templatelistenerxml" title=
"Permanent link">#
</a></h2>
2338 <p>The following code shows the
<code>templateListener.xml
</code> file used to install all mentioned template listeners:
</p>
2339 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2340 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/tornado/XSD/templateListener.xsd
"</span><span class=
"nt">></span>
2341 <span class=
"nt"><import
></span>
2342 <span class=
"c"><!-- admin --
></span>
2343 <span class=
"nt"><templatelistener
</span> <span class=
"na">name=
</span><span class=
"s">"personListBirthdayColumnHead
"</span><span class=
"nt">></span>
2344 <span class=
"nt"><eventname
></span>columnHeads
<span class=
"nt"></eventname
></span>
2345 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2346 <span class=
"nt"><templatecode
></span><span class=
"cp"><![CDATA[
<th class=
"columnDate columnBirthday{if $sortField ==
'birthday
'} active {@$sortOrder}{/if}
"><a href=
"{link controller=
'PersonList
'}pageNo={@$pageNo}
&sortField=birthday
&sortOrder={if $sortField ==
'birthday
' && $sortOrder ==
'ASC
'}DESC{else}ASC{/if}{/link}
">{lang}wcf.person.birthday{/lang}
</a
></th
>]]
></span><span class=
"nt"></templatecode
></span>
2347 <span class=
"nt"><templatename
></span>personList
<span class=
"nt"></templatename
></span>
2348 <span class=
"nt"></templatelistener
></span>
2349 <span class=
"nt"><templatelistener
</span> <span class=
"na">name=
</span><span class=
"s">"personListBirthdayColumn
"</span><span class=
"nt">></span>
2350 <span class=
"nt"><eventname
></span>columns
<span class=
"nt"></eventname
></span>
2351 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2352 <span class=
"nt"><templatecode
></span><span class=
"cp"><![CDATA[
<td class=
"columnDate columnBirthday
">{if $person-
>birthday !==
'0000-
00-
00'}{@$person-
>birthday|strtotime|date}{/if}
</td
>]]
></span><span class=
"nt"></templatecode
></span>
2353 <span class=
"nt"><templatename
></span>personList
<span class=
"nt"></templatename
></span>
2354 <span class=
"nt"></templatelistener
></span>
2355 <span class=
"nt"><templatelistener
</span> <span class=
"na">name=
</span><span class=
"s">"personAddBirthday
"</span><span class=
"nt">></span>
2356 <span class=
"nt"><eventname
></span>dataFields
<span class=
"nt"></eventname
></span>
2357 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2358 <span class=
"nt"><templatecode
></span><span class=
"cp"><![CDATA[{include file=
'__personAddBirthday
'}]]
></span><span class=
"nt"></templatecode
></span>
2359 <span class=
"nt"><templatename
></span>personAdd
<span class=
"nt"></templatename
></span>
2360 <span class=
"nt"></templatelistener
></span>
2361 <span class=
"c"><!-- /admin --
></span>
2363 <span class=
"c"><!-- user --
></span>
2364 <span class=
"nt"><templatelistener
</span> <span class=
"na">name=
</span><span class=
"s">"personListBirthday
"</span><span class=
"nt">></span>
2365 <span class=
"nt"><eventname
></span>personStatistics
<span class=
"nt"></eventname
></span>
2366 <span class=
"nt"><environment
></span>user
<span class=
"nt"></environment
></span>
2367 <span class=
"nt"><templatecode
></span><span class=
"cp"><![CDATA[{include file=
'__personListBirthday
'}]]
></span><span class=
"nt"></templatecode
></span>
2368 <span class=
"nt"><templatename
></span>personList
<span class=
"nt"></templatename
></span>
2369 <span class=
"nt"></templatelistener
></span>
2370 <span class=
"nt"><templatelistener
</span> <span class=
"na">name=
</span><span class=
"s">"personListBirthdaySortField
"</span><span class=
"nt">></span>
2371 <span class=
"nt"><eventname
></span>sortField
<span class=
"nt"></eventname
></span>
2372 <span class=
"nt"><environment
></span>user
<span class=
"nt"></environment
></span>
2373 <span class=
"nt"><templatecode
></span><span class=
"cp"><![CDATA[{include file=
'__personListBirthdaySortField
'}]]
></span><span class=
"nt"></templatecode
></span>
2374 <span class=
"nt"><templatename
></span>personList
<span class=
"nt"></templatename
></span>
2375 <span class=
"nt"></templatelistener
></span>
2376 <span class=
"c"><!-- /user --
></span>
2377 <span class=
"nt"></import
></span>
2378 <span class=
"nt"></data
></span>
2380 <p>In cases where a template is used, we simply use the
<code>include
</code> syntax to load the template.
</p>
2381 <h2 id=
"eventlistenerxml"><code>eventListener.xml
</code><a class=
"headerlink" href=
"#eventlistenerxml" title=
"Permanent link">#
</a></h2>
2382 <p>There are two event listeners,
<code>birthdaySortFieldAdminPersonList
</code> and
<code>birthdaySortFieldPersonList
</code>, that make
<code>birthday
</code> a valid sort field in the ACP and the front end, respectively, and the rest takes care of setting the birthday.
2383 The event listener
<code>birthdayPersonAddFormInherited
</code> takes care of the events that are relevant for both adding and editing people, thus it listens to the
<code>PersonAddForm
</code> class but has
<code>inherit
</code> set to
<code>1</code> so that it also listens to the events of the
<code>PersonEditForm
</code> class.
2384 In contrast, reading the existing birthday from a person is only relevant for editing so that the event listener
<code>birthdayPersonEditForm
</code> only listens to that class.
</p>
2385 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2386 <span class=
"nt"><data
</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/eventListener.xsd
"</span><span class=
"nt">></span>
2387 <span class=
"nt"><import
></span>
2388 <span class=
"c"><!-- admin --
></span>
2389 <span class=
"nt"><eventlistener
</span> <span class=
"na">name=
</span><span class=
"s">"birthdaySortFieldAdminPersonList
"</span><span class=
"nt">></span>
2390 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2391 <span class=
"nt"><eventclassname
></span>wcf\acp\page\PersonListPage
<span class=
"nt"></eventclassname
></span>
2392 <span class=
"nt"><eventname
></span>validateSortField
<span class=
"nt"></eventname
></span>
2393 <span class=
"nt"><listenerclassname
></span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener
<span class=
"nt"></listenerclassname
></span>
2394 <span class=
"nt"></eventlistener
></span>
2395 <span class=
"nt"><eventlistener
</span> <span class=
"na">name=
</span><span class=
"s">"birthdayPersonAddForm
"</span><span class=
"nt">></span>
2396 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2397 <span class=
"nt"><eventclassname
></span>wcf\acp\form\PersonAddForm
<span class=
"nt"></eventclassname
></span>
2398 <span class=
"nt"><eventname
></span>saved
<span class=
"nt"></eventname
></span>
2399 <span class=
"nt"><listenerclassname
></span>wcf\system\event\listener\BirthdayPersonAddFormListener
<span class=
"nt"></listenerclassname
></span>
2400 <span class=
"nt"></eventlistener
></span>
2401 <span class=
"nt"><eventlistener
</span> <span class=
"na">name=
</span><span class=
"s">"birthdayPersonAddFormInherited
"</span><span class=
"nt">></span>
2402 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2403 <span class=
"nt"><eventclassname
></span>wcf\acp\form\PersonAddForm
<span class=
"nt"></eventclassname
></span>
2404 <span class=
"nt"><eventname
></span>assignVariables,readFormParameters,save,validate
<span class=
"nt"></eventname
></span>
2405 <span class=
"nt"><listenerclassname
></span>wcf\system\event\listener\BirthdayPersonAddFormListener
<span class=
"nt"></listenerclassname
></span>
2406 <span class=
"nt"><inherit
></span>1<span class=
"nt"></inherit
></span>
2407 <span class=
"nt"></eventlistener
></span>
2408 <span class=
"nt"><eventlistener
</span> <span class=
"na">name=
</span><span class=
"s">"birthdayPersonEditForm
"</span><span class=
"nt">></span>
2409 <span class=
"nt"><environment
></span>admin
<span class=
"nt"></environment
></span>
2410 <span class=
"nt"><eventclassname
></span>wcf\acp\form\PersonEditForm
<span class=
"nt"></eventclassname
></span>
2411 <span class=
"nt"><eventname
></span>readData
<span class=
"nt"></eventname
></span>
2412 <span class=
"nt"><listenerclassname
></span>wcf\system\event\listener\BirthdayPersonAddFormListener
<span class=
"nt"></listenerclassname
></span>
2413 <span class=
"nt"></eventlistener
></span>
2414 <span class=
"c"><!-- /admin --
></span>
2416 <span class=
"c"><!-- user --
></span>
2417 <span class=
"nt"><eventlistener
</span> <span class=
"na">name=
</span><span class=
"s">"birthdaySortFieldPersonList
"</span><span class=
"nt">></span>
2418 <span class=
"nt"><environment
></span>user
<span class=
"nt"></environment
></span>
2419 <span class=
"nt"><eventclassname
></span>wcf\page\PersonListPage
<span class=
"nt"></eventclassname
></span>
2420 <span class=
"nt"><eventname
></span>validateSortField
<span class=
"nt"></eventname
></span>
2421 <span class=
"nt"><listenerclassname
></span>wcf\system\event\listener\BirthdaySortFieldPersonListPageListener
<span class=
"nt"></listenerclassname
></span>
2422 <span class=
"nt"></eventlistener
></span>
2423 <span class=
"c"><!-- /user --
></span>
2424 <span class=
"nt"></import
></span>
2425 <span class=
"nt"></data
></span>
2427 <h2 id=
"packagexml"><code>package.xml
</code><a class=
"headerlink" href=
"#packagexml" title=
"Permanent link">#
</a></h2>
2428 <p>The only relevant difference between the
<code>package.xml
</code> file of the base page from part
1 and the
<code>package.xml
</code> file of this package is that this package requires the base package
<code>com.woltlab.wcf.people
</code> (see
<code><requiredpackages
></code>):
</p>
2429 <div class=
"highlight"><pre><span></span><code><span class=
"cp"><?xml version=
"1.0" encoding=
"UTF-
8"?
></span>
2430 <span class=
"nt"><package
</span> <span class=
"na">name=
</span><span class=
"s">"com.woltlab.wcf.people.birthday
"</span> <span class=
"na">xmlns=
</span><span class=
"s">"http://www.woltlab.com
"</span> <span class=
"na">xmlns:xsi=
</span><span class=
"s">"http://www.w3.org/
2001/XMLSchema-instance
"</span> <span class=
"na">xsi:schemaLocation=
</span><span class=
"s">"http://www.woltlab.com http://www.woltlab.com/XSD/tornado/package.xsd
"</span><span class=
"nt">></span>
2431 <span class=
"nt"><packageinformation
></span>
2432 <span class=
"nt"><packagename
></span>WoltLab Suite Core Tutorial: People (Birthday)
<span class=
"nt"></packagename
></span>
2433 <span class=
"nt"><packagedescription
></span>Adds a birthday field to the people management system as part of a tutorial to create packages.
<span class=
"nt"></packagedescription
></span>
2434 <span class=
"nt"><version
></span>3.1.0<span class=
"nt"></version
></span>
2435 <span class=
"nt"><date
></span>2018-
03-
30<span class=
"nt"></date
></span>
2436 <span class=
"nt"></packageinformation
></span>
2438 <span class=
"nt"><authorinformation
></span>
2439 <span class=
"nt"><author
></span>WoltLab GmbH
<span class=
"nt"></author
></span>
2440 <span class=
"nt"><authorurl
></span>http://www.woltlab.com
<span class=
"nt"></authorurl
></span>
2441 <span class=
"nt"></authorinformation
></span>
2443 <span class=
"nt"><requiredpackages
></span>
2444 <span class=
"nt"><requiredpackage
</span> <span class=
"na">minversion=
</span><span class=
"s">"3.1.0"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></requiredpackage
></span>
2445 <span class=
"nt"><requiredpackage
</span> <span class=
"na">minversion=
</span><span class=
"s">"3.1.0"</span><span class=
"nt">></span>com.woltlab.wcf.people
<span class=
"nt"></requiredpackage
></span>
2446 <span class=
"nt"></requiredpackages
></span>
2448 <span class=
"nt"><excludedpackages
></span>
2449 <span class=
"nt"><excludedpackage
</span> <span class=
"na">version=
</span><span class=
"s">"3.2.0 Alpha
1"</span><span class=
"nt">></span>com.woltlab.wcf
<span class=
"nt"></excludedpackage
></span>
2450 <span class=
"nt"></excludedpackages
></span>
2452 <span class=
"nt"><compatibility
></span>
2453 <span class=
"nt"><api
</span> <span class=
"na">version=
</span><span class=
"s">"2018"</span> <span class=
"nt">/
></span>
2454 <span class=
"nt"></compatibility
></span>
2456 <span class=
"nt"><instructions
</span> <span class=
"na">type=
</span><span class=
"s">"install
"</span><span class=
"nt">></span>
2457 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"acpTemplate
"</span> <span class=
"nt">/
></span>
2458 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"file
"</span> <span class=
"nt">/
></span>
2459 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"sql
"</span> <span class=
"nt">/
></span>
2460 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"template
"</span> <span class=
"nt">/
></span>
2461 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"language
"</span> <span class=
"nt">/
></span>
2463 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"eventListener
"</span> <span class=
"nt">/
></span>
2464 <span class=
"nt"><instruction
</span> <span class=
"na">type=
</span><span class=
"s">"templateListener
"</span> <span class=
"nt">/
></span>
2465 <span class=
"nt"></instructions
></span>
2466 <span class=
"nt"></package
></span>
2469 <p>This concludes the second part of our tutorial series after which you now have extended the base package using event listeners and template listeners that allow you to enter the birthday of the people.
</p>
2470 <p>The complete source code of this part can be found on
<a href=
"https://github.com/WoltLab/docs.woltlab.com/tree/5.4/snippets/tutorial/tutorial-series/part-2">GitHub
</a>.
</p>
2476 <div class=
"md-source-date">
2479 Last update:
2021-
04-
20
2498 <footer class=
"md-footer">
2500 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2502 <a href=
"../part_1/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2503 <div class=
"md-footer__button md-icon">
2504 <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>
2506 <div class=
"md-footer__title">
2507 <div class=
"md-ellipsis">
2508 <span class=
"md-footer__direction">
2517 <a href=
"../part_3/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2518 <div class=
"md-footer__title">
2519 <div class=
"md-ellipsis">
2520 <span class=
"md-footer__direction">
2526 <div class=
"md-footer__button md-icon">
2527 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2533 <div class=
"md-footer-meta md-typeset">
2534 <div class=
"md-footer-meta__inner md-grid">
2535 <div class=
"md-footer-copyright">
2537 <div class=
"md-footer-copyright__highlight">
2538 Copyright ©
2020 WoltLab GmbH
2542 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2547 <div class=
"md-footer-copyright">
2548 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2549 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2556 <div class=
"md-dialog" data-md-component=
"dialog">
2557 <div class=
"md-dialog__inner md-typeset"></div>
2559 <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.fe42c31b.min.js",
"version": {
"provider":
"mike"}}
</script>
2562 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>