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>Package Installation Plugins - 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=
"#package-installation-plugins" 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">
100 Package Installation Plugins
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">
222 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
225 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
227 <label class=
"md-nav__link" for=
"__nav_2">
229 <span class=
"md-nav__icon md-icon"></span>
231 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
232 <label class=
"md-nav__title" for=
"__nav_2">
233 <span class=
"md-nav__icon md-icon"></span>
236 <ul class=
"md-nav__list" data-md-scrollfix
>
242 <li class=
"md-nav__item">
243 <a href=
"../../pages/" class=
"md-nav__link">
254 <li class=
"md-nav__item">
255 <a href=
"../../database-objects/" class=
"md-nav__link">
266 <li class=
"md-nav__item">
267 <a href=
"../../database-access/" class=
"md-nav__link">
278 <li class=
"md-nav__item">
279 <a href=
"../../exceptions/" class=
"md-nav__link">
293 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
296 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
298 <label class=
"md-nav__link" for=
"__nav_2_5">
300 <span class=
"md-nav__icon md-icon"></span>
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>
307 <ul class=
"md-nav__list" data-md-scrollfix
>
314 <li class=
"md-nav__item md-nav__item--nested">
317 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
319 <label class=
"md-nav__link" for=
"__nav_2_5_1">
321 <span class=
"md-nav__icon md-icon"></span>
323 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
324 <label class=
"md-nav__title" for=
"__nav_2_5_1">
325 <span class=
"md-nav__icon md-icon"></span>
328 <ul class=
"md-nav__list" data-md-scrollfix
>
334 <li class=
"md-nav__item">
335 <a href=
"../caches/" class=
"md-nav__link">
346 <li class=
"md-nav__item">
347 <a href=
"../caches_persistent-caches/" class=
"md-nav__link">
358 <li class=
"md-nav__item">
359 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
376 <li class=
"md-nav__item">
377 <a href=
"../comments/" class=
"md-nav__link">
388 <li class=
"md-nav__item">
389 <a href=
"../cronjobs/" class=
"md-nav__link">
400 <li class=
"md-nav__item">
401 <a href=
"../events/" class=
"md-nav__link">
413 <li class=
"md-nav__item md-nav__item--nested">
416 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
418 <label class=
"md-nav__link" for=
"__nav_2_5_5">
420 <span class=
"md-nav__icon md-icon"></span>
422 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
423 <label class=
"md-nav__title" for=
"__nav_2_5_5">
424 <span class=
"md-nav__icon md-icon"></span>
427 <ul class=
"md-nav__list" data-md-scrollfix
>
433 <li class=
"md-nav__item">
434 <a href=
"../form_builder/overview/" class=
"md-nav__link">
445 <li class=
"md-nav__item">
446 <a href=
"../form_builder/structure/" class=
"md-nav__link">
457 <li class=
"md-nav__item">
458 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
469 <li class=
"md-nav__item">
470 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
481 <li class=
"md-nav__item">
482 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
501 <li class=
"md-nav__item md-nav__item--active">
503 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
508 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
509 Package Installation Plugins
510 <span class=
"md-nav__icon md-icon"></span>
513 <a href=
"./" class=
"md-nav__link md-nav__link--active">
514 Package Installation Plugins
518 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
524 <label class=
"md-nav__title" for=
"__toc">
525 <span class=
"md-nav__icon md-icon"></span>
528 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
530 <li class=
"md-nav__item">
531 <a href=
"#abstractpackageinstallationplugin" class=
"md-nav__link">
532 AbstractPackageInstallationPlugin
535 <nav class=
"md-nav" aria-label=
"AbstractPackageInstallationPlugin">
536 <ul class=
"md-nav__list">
538 <li class=
"md-nav__item">
539 <a href=
"#class-members" class=
"md-nav__link">
543 <nav class=
"md-nav" aria-label=
"Class Members">
544 <ul class=
"md-nav__list">
546 <li class=
"md-nav__item">
547 <a href=
"#installation" class=
"md-nav__link">
553 <li class=
"md-nav__item">
554 <a href=
"#application" class=
"md-nav__link">
570 <li class=
"md-nav__item">
571 <a href=
"#abstractxmlpackageinstallationplugin" class=
"md-nav__link">
572 AbstractXMLPackageInstallationPlugin
575 <nav class=
"md-nav" aria-label=
"AbstractXMLPackageInstallationPlugin">
576 <ul class=
"md-nav__list">
578 <li class=
"md-nav__item">
579 <a href=
"#class-members_1" class=
"md-nav__link">
583 <nav class=
"md-nav" aria-label=
"Class Members">
584 <ul class=
"md-nav__list">
586 <li class=
"md-nav__item">
587 <a href=
"#classname" class=
"md-nav__link">
593 <li class=
"md-nav__item">
594 <a href=
"#tagname" class=
"md-nav__link">
600 <li class=
"md-nav__item">
601 <a href=
"#prepareimportarray-data" class=
"md-nav__link">
602 prepareImport(array $data)
607 <li class=
"md-nav__item">
608 <a href=
"#validateimportarray-data" class=
"md-nav__link">
609 validateImport(array $data)
614 <li class=
"md-nav__item">
615 <a href=
"#findexistingitemarray-data" class=
"md-nav__link">
616 findExistingItem(array $data)
621 <li class=
"md-nav__item">
622 <a href=
"#253-example" class=
"md-nav__link">
628 <li class=
"md-nav__item">
629 <a href=
"#handledeletearray-items" class=
"md-nav__link">
630 handleDelete(array $items)
635 <li class=
"md-nav__item">
636 <a href=
"#postimport" class=
"md-nav__link">
652 <li class=
"md-nav__item">
653 <a href=
"#abstractoptionpackageinstallationplugin" class=
"md-nav__link">
654 AbstractOptionPackageInstallationPlugin
657 <nav class=
"md-nav" aria-label=
"AbstractOptionPackageInstallationPlugin">
658 <ul class=
"md-nav__list">
660 <li class=
"md-nav__item">
661 <a href=
"#differences-to-abstractxmlpackageinstallationplugin" class=
"md-nav__link">
662 Differences to AbstractXMLPackageInstallationPlugin
665 <nav class=
"md-nav" aria-label=
"Differences to AbstractXMLPackageInstallationPlugin">
666 <ul class=
"md-nav__list">
668 <li class=
"md-nav__item">
669 <a href=
"#reservedtags" class=
"md-nav__link">
697 <li class=
"md-nav__item">
698 <a href=
"../user_activity_points/" class=
"md-nav__link">
709 <li class=
"md-nav__item">
710 <a href=
"../user_notifications/" class=
"md-nav__link">
721 <li class=
"md-nav__item">
722 <a href=
"../sitemaps/" class=
"md-nav__link">
739 <li class=
"md-nav__item">
740 <a href=
"../../code-style/" class=
"md-nav__link">
751 <li class=
"md-nav__item">
752 <a href=
"../../apps/" class=
"md-nav__link">
763 <li class=
"md-nav__item">
764 <a href=
"../../gdpr/" class=
"md-nav__link">
785 <li class=
"md-nav__item md-nav__item--nested">
788 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
790 <label class=
"md-nav__link" for=
"__nav_3">
791 Languages, Templates & CSS
792 <span class=
"md-nav__icon md-icon"></span>
794 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
795 <label class=
"md-nav__title" for=
"__nav_3">
796 <span class=
"md-nav__icon md-icon"></span>
797 Languages, Templates & CSS
799 <ul class=
"md-nav__list" data-md-scrollfix
>
805 <li class=
"md-nav__item">
806 <a href=
"../../../view/languages/" class=
"md-nav__link">
817 <li class=
"md-nav__item">
818 <a href=
"../../../view/templates/" class=
"md-nav__link">
829 <li class=
"md-nav__item">
830 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
841 <li class=
"md-nav__item">
842 <a href=
"../../../view/css/" class=
"md-nav__link">
863 <li class=
"md-nav__item md-nav__item--nested">
866 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
868 <label class=
"md-nav__link" for=
"__nav_4">
869 TypeScript and JavaScript API
870 <span class=
"md-nav__icon md-icon"></span>
872 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
873 <label class=
"md-nav__title" for=
"__nav_4">
874 <span class=
"md-nav__icon md-icon"></span>
875 TypeScript and JavaScript API
877 <ul class=
"md-nav__list" data-md-scrollfix
>
883 <li class=
"md-nav__item">
884 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
895 <li class=
"md-nav__item">
896 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
908 <li class=
"md-nav__item md-nav__item--nested">
911 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
913 <label class=
"md-nav__link" for=
"__nav_4_3">
915 <span class=
"md-nav__icon md-icon"></span>
917 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
918 <label class=
"md-nav__title" for=
"__nav_4_3">
919 <span class=
"md-nav__icon md-icon"></span>
922 <ul class=
"md-nav__list" data-md-scrollfix
>
928 <li class=
"md-nav__item">
929 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
940 <li class=
"md-nav__item">
941 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
952 <li class=
"md-nav__item">
953 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
964 <li class=
"md-nav__item">
965 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
976 <li class=
"md-nav__item">
977 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
988 <li class=
"md-nav__item">
989 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1000 <li class=
"md-nav__item">
1001 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1012 <li class=
"md-nav__item">
1013 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1014 Browser and Screen Sizes
1024 <li class=
"md-nav__item">
1025 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1042 <li class=
"md-nav__item">
1043 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1054 <li class=
"md-nav__item">
1055 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
1066 <li class=
"md-nav__item">
1067 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1088 <li class=
"md-nav__item md-nav__item--nested">
1091 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1093 <label class=
"md-nav__link" for=
"__nav_5">
1095 <span class=
"md-nav__icon md-icon"></span>
1097 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1098 <label class=
"md-nav__title" for=
"__nav_5">
1099 <span class=
"md-nav__icon md-icon"></span>
1102 <ul class=
"md-nav__list" data-md-scrollfix
>
1108 <li class=
"md-nav__item">
1109 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1121 <li class=
"md-nav__item md-nav__item--nested">
1124 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1126 <label class=
"md-nav__link" for=
"__nav_5_2">
1128 <span class=
"md-nav__icon md-icon"></span>
1130 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1131 <label class=
"md-nav__title" for=
"__nav_5_2">
1132 <span class=
"md-nav__icon md-icon"></span>
1135 <ul class=
"md-nav__list" data-md-scrollfix
>
1141 <li class=
"md-nav__item">
1142 <a href=
"../../../package/pip/" class=
"md-nav__link">
1153 <li class=
"md-nav__item">
1154 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1165 <li class=
"md-nav__item">
1166 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1177 <li class=
"md-nav__item">
1178 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1189 <li class=
"md-nav__item">
1190 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1201 <li class=
"md-nav__item">
1202 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1213 <li class=
"md-nav__item">
1214 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1225 <li class=
"md-nav__item">
1226 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1237 <li class=
"md-nav__item">
1238 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1249 <li class=
"md-nav__item">
1250 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1261 <li class=
"md-nav__item">
1262 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1273 <li class=
"md-nav__item">
1274 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1285 <li class=
"md-nav__item">
1286 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1297 <li class=
"md-nav__item">
1298 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1309 <li class=
"md-nav__item">
1310 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1321 <li class=
"md-nav__item">
1322 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1333 <li class=
"md-nav__item">
1334 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1345 <li class=
"md-nav__item">
1346 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1357 <li class=
"md-nav__item">
1358 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1359 objectTypeDefinition
1369 <li class=
"md-nav__item">
1370 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1381 <li class=
"md-nav__item">
1382 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1393 <li class=
"md-nav__item">
1394 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1405 <li class=
"md-nav__item">
1406 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1417 <li class=
"md-nav__item">
1418 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1429 <li class=
"md-nav__item">
1430 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1441 <li class=
"md-nav__item">
1442 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1453 <li class=
"md-nav__item">
1454 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1465 <li class=
"md-nav__item">
1466 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1477 <li class=
"md-nav__item">
1478 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1489 <li class=
"md-nav__item">
1490 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1501 <li class=
"md-nav__item">
1502 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1503 userNotificationEvent
1513 <li class=
"md-nav__item">
1514 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1525 <li class=
"md-nav__item">
1526 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1543 <li class=
"md-nav__item">
1544 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1565 <li class=
"md-nav__item md-nav__item--nested">
1568 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1570 <label class=
"md-nav__link" for=
"__nav_6">
1572 <span class=
"md-nav__icon md-icon"></span>
1574 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1575 <label class=
"md-nav__title" for=
"__nav_6">
1576 <span class=
"md-nav__icon md-icon"></span>
1579 <ul class=
"md-nav__list" data-md-scrollfix
>
1586 <li class=
"md-nav__item md-nav__item--nested">
1589 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1591 <label class=
"md-nav__link" for=
"__nav_6_1">
1592 Migrating from WSC
5.3
1593 <span class=
"md-nav__icon md-icon"></span>
1595 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1596 <label class=
"md-nav__title" for=
"__nav_6_1">
1597 <span class=
"md-nav__icon md-icon"></span>
1598 Migrating from WSC
5.3
1600 <ul class=
"md-nav__list" data-md-scrollfix
>
1606 <li class=
"md-nav__item">
1607 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1618 <li class=
"md-nav__item">
1619 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1620 Session Handling and Authentication
1630 <li class=
"md-nav__item">
1631 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1632 TypeScript and JavaScript
1642 <li class=
"md-nav__item">
1643 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1654 <li class=
"md-nav__item">
1655 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1656 Third Party Libraries
1673 <li class=
"md-nav__item md-nav__item--nested">
1676 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1678 <label class=
"md-nav__link" for=
"__nav_6_2">
1679 Migrating from WSC
5.2
1680 <span class=
"md-nav__icon md-icon"></span>
1682 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1683 <label class=
"md-nav__title" for=
"__nav_6_2">
1684 <span class=
"md-nav__icon md-icon"></span>
1685 Migrating from WSC
5.2
1687 <ul class=
"md-nav__list" data-md-scrollfix
>
1693 <li class=
"md-nav__item">
1694 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1705 <li class=
"md-nav__item">
1706 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1707 Templates and Languages
1717 <li class=
"md-nav__item">
1718 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1719 Third Party Libraries
1736 <li class=
"md-nav__item md-nav__item--nested">
1739 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1741 <label class=
"md-nav__link" for=
"__nav_6_3">
1742 Migrating from WSC
3.1
1743 <span class=
"md-nav__icon md-icon"></span>
1745 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1746 <label class=
"md-nav__title" for=
"__nav_6_3">
1747 <span class=
"md-nav__icon md-icon"></span>
1748 Migrating from WSC
3.1
1750 <ul class=
"md-nav__list" data-md-scrollfix
>
1756 <li class=
"md-nav__item">
1757 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1775 <li class=
"md-nav__item md-nav__item--nested">
1778 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1780 <label class=
"md-nav__link" for=
"__nav_6_4">
1781 Migrating from WSC
3.0
1782 <span class=
"md-nav__icon md-icon"></span>
1784 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1785 <label class=
"md-nav__title" for=
"__nav_6_4">
1786 <span class=
"md-nav__icon md-icon"></span>
1787 Migrating from WSC
3.0
1789 <ul class=
"md-nav__list" data-md-scrollfix
>
1795 <li class=
"md-nav__item">
1796 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1807 <li class=
"md-nav__item">
1808 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1819 <li class=
"md-nav__item">
1820 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1831 <li class=
"md-nav__item">
1832 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1843 <li class=
"md-nav__item">
1844 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1862 <li class=
"md-nav__item md-nav__item--nested">
1865 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1867 <label class=
"md-nav__link" for=
"__nav_6_5">
1868 Migrating from WCF
2.1
1869 <span class=
"md-nav__icon md-icon"></span>
1871 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1872 <label class=
"md-nav__title" for=
"__nav_6_5">
1873 <span class=
"md-nav__icon md-icon"></span>
1874 Migrating from WCF
2.1
1876 <ul class=
"md-nav__list" data-md-scrollfix
>
1882 <li class=
"md-nav__item">
1883 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1894 <li class=
"md-nav__item">
1895 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1906 <li class=
"md-nav__item">
1907 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1918 <li class=
"md-nav__item">
1919 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1946 <li class=
"md-nav__item md-nav__item--nested">
1949 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1951 <label class=
"md-nav__link" for=
"__nav_7">
1953 <span class=
"md-nav__icon md-icon"></span>
1955 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1956 <label class=
"md-nav__title" for=
"__nav_7">
1957 <span class=
"md-nav__icon md-icon"></span>
1960 <ul class=
"md-nav__list" data-md-scrollfix
>
1967 <li class=
"md-nav__item md-nav__item--nested">
1970 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1972 <label class=
"md-nav__link" for=
"__nav_7_1">
1974 <span class=
"md-nav__icon md-icon"></span>
1976 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1977 <label class=
"md-nav__title" for=
"__nav_7_1">
1978 <span class=
"md-nav__icon md-icon"></span>
1981 <ul class=
"md-nav__list" data-md-scrollfix
>
1987 <li class=
"md-nav__item">
1988 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
1999 <li class=
"md-nav__item">
2000 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2011 <li class=
"md-nav__item">
2012 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2023 <li class=
"md-nav__item">
2024 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2051 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2052 <div class=
"md-sidebar__scrollwrap">
2053 <div class=
"md-sidebar__inner">
2055 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2061 <label class=
"md-nav__title" for=
"__toc">
2062 <span class=
"md-nav__icon md-icon"></span>
2065 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2067 <li class=
"md-nav__item">
2068 <a href=
"#abstractpackageinstallationplugin" class=
"md-nav__link">
2069 AbstractPackageInstallationPlugin
2072 <nav class=
"md-nav" aria-label=
"AbstractPackageInstallationPlugin">
2073 <ul class=
"md-nav__list">
2075 <li class=
"md-nav__item">
2076 <a href=
"#class-members" class=
"md-nav__link">
2080 <nav class=
"md-nav" aria-label=
"Class Members">
2081 <ul class=
"md-nav__list">
2083 <li class=
"md-nav__item">
2084 <a href=
"#installation" class=
"md-nav__link">
2090 <li class=
"md-nav__item">
2091 <a href=
"#application" class=
"md-nav__link">
2107 <li class=
"md-nav__item">
2108 <a href=
"#abstractxmlpackageinstallationplugin" class=
"md-nav__link">
2109 AbstractXMLPackageInstallationPlugin
2112 <nav class=
"md-nav" aria-label=
"AbstractXMLPackageInstallationPlugin">
2113 <ul class=
"md-nav__list">
2115 <li class=
"md-nav__item">
2116 <a href=
"#class-members_1" class=
"md-nav__link">
2120 <nav class=
"md-nav" aria-label=
"Class Members">
2121 <ul class=
"md-nav__list">
2123 <li class=
"md-nav__item">
2124 <a href=
"#classname" class=
"md-nav__link">
2130 <li class=
"md-nav__item">
2131 <a href=
"#tagname" class=
"md-nav__link">
2137 <li class=
"md-nav__item">
2138 <a href=
"#prepareimportarray-data" class=
"md-nav__link">
2139 prepareImport(array $data)
2144 <li class=
"md-nav__item">
2145 <a href=
"#validateimportarray-data" class=
"md-nav__link">
2146 validateImport(array $data)
2151 <li class=
"md-nav__item">
2152 <a href=
"#findexistingitemarray-data" class=
"md-nav__link">
2153 findExistingItem(array $data)
2158 <li class=
"md-nav__item">
2159 <a href=
"#253-example" class=
"md-nav__link">
2165 <li class=
"md-nav__item">
2166 <a href=
"#handledeletearray-items" class=
"md-nav__link">
2167 handleDelete(array $items)
2172 <li class=
"md-nav__item">
2173 <a href=
"#postimport" class=
"md-nav__link">
2189 <li class=
"md-nav__item">
2190 <a href=
"#abstractoptionpackageinstallationplugin" class=
"md-nav__link">
2191 AbstractOptionPackageInstallationPlugin
2194 <nav class=
"md-nav" aria-label=
"AbstractOptionPackageInstallationPlugin">
2195 <ul class=
"md-nav__list">
2197 <li class=
"md-nav__item">
2198 <a href=
"#differences-to-abstractxmlpackageinstallationplugin" class=
"md-nav__link">
2199 Differences to AbstractXMLPackageInstallationPlugin
2202 <nav class=
"md-nav" aria-label=
"Differences to AbstractXMLPackageInstallationPlugin">
2203 <ul class=
"md-nav__list">
2205 <li class=
"md-nav__item">
2206 <a href=
"#reservedtags" class=
"md-nav__link">
2230 <div class=
"md-content" data-md-component=
"content">
2231 <article class=
"md-content__inner md-typeset">
2234 <a href=
"https://github.com/WoltLab/docs.woltlab.com/edit/5.4/docs/php/api/package_installation_plugins.md" title=
"Edit this page" class=
"md-content__button md-icon">
2235 <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>
2239 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
2240 <p>A package installation plugin (PIP) defines the behavior to handle a specific
<a href=
"../../../package/package-xml/#instruction">instruction
</a> during package installation, update or uninstallation.
</p>
2241 <h2 id=
"abstractpackageinstallationplugin"><code>AbstractPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2242 <p>Any package installation plugin has to implement the
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/IPackageInstallationPlugin.class.php">IPackageInstallationPlugin
</a> interface.
2243 It is recommended however, to extend the abstract implementation
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractPackageInstallationPlugin.class.php">AbstractPackageInstallationPlugin
</a> of this interface instead of directly implementing the interface.
2244 The abstract implementation will always provide sane methods in case of any API changes.
</p>
2245 <h3 id=
"class-members">Class Members
<a class=
"headerlink" href=
"#class-members" title=
"Permanent link">#
</a></h3>
2246 <p>Package Installation Plugins have a few notable class members easing your work:
</p>
2247 <h4 id=
"installation"><code>$installation
</code><a class=
"headerlink" href=
"#installation" title=
"Permanent link">#
</a></h4>
2248 <p>This member contains an instance of
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php">PackageInstallationDispatcher
</a> which provides you with all meta data related to the current package being processed.
2249 The most common usage is the retrieval of the package ID via
<code>$this-
>installation-
>getPackageID()
</code>.
</p>
2250 <h4 id=
"application"><code>$application
</code><a class=
"headerlink" href=
"#application" title=
"Permanent link">#
</a></h4>
2251 <p>Represents the abbreviation of the target application, e.g.
<code>wbb
</code> (default value:
<code>wcf
</code>), used for the name of database table in which the installed data is stored.
</p>
2252 <h2 id=
"abstractxmlpackageinstallationplugin"><code>AbstractXMLPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractxmlpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2253 <p><a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractPackageInstallationPlugin.class.php">AbstractPackageInstallationPlugin
</a> is the default implementation for all package installation plugins based upon a single XML document.
2254 It handles the evaluation of the document and provide you an object-orientated approach to handle its data.
</p>
2255 <h3 id=
"class-members_1">Class Members
<a class=
"headerlink" href=
"#class-members_1" title=
"Permanent link">#
</a></h3>
2256 <h4 id=
"classname"><code>$className
</code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h4>
2257 <p>Value must be the qualified name of a class deriving from
<a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/data/DatabaseObjectEditor.class.php">DatabaseObjectEditor
</a> which is used to create and update objects.
</p>
2258 <h4 id=
"tagname"><code>$tagName
</code><a class=
"headerlink" href=
"#tagname" title=
"Permanent link">#
</a></h4>
2259 <p>Specifies the tag name within a
<code><import
></code> or
<code><delete
></code> section of the XML document used for each installed object.
</p>
2260 <h4 id=
"prepareimportarray-data"><code>prepareImport(array $data)
</code><a class=
"headerlink" href=
"#prepareimportarray-data" title=
"Permanent link">#
</a></h4>
2261 <p>The passed array
<code>$data
</code> contains the parsed value from each evaluated tag in the
<code><import
></code> section:
</p>
2263 <li><code>$data['elements']
</code> contains a list of tag names and their value.
</li>
2264 <li><code>$data['attributes']
</code> contains a list of attributes present on the tag identified by
<a href=
"#tagname">$tagName
</a>.
</li>
2266 <p>This method should return an one-dimensional array, where each key maps to the corresponding database column name (key names are case-sensitive).
2267 It will be passed to either
<code>DatabaseObjectEditor::create()
</code> or
<code>DatabaseObjectEditor::update()
</code>.
</p>
2269 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2270 <span class=
"k">return
</span> <span class=
"p">[
</span>
2271 <span class=
"s1">'environment
'</span> <span class=
"o">=
></span> <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'elements
'</span><span class=
"p">][
</span><span class=
"s1">'environment
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">],
</span>
2272 <span class=
"s1">'eventName
'</span> <span class=
"o">=
></span> <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'elements
'</span><span class=
"p">][
</span><span class=
"s1">'eventname
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">],
</span>
2273 <span class=
"s1">'name
'</span> <span class=
"o">=
></span> <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'attributes
'</span><span class=
"p">][
</span><span class=
"s1">'name
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">]
</span>
2274 <span class=
"p">];
</span>
2276 <h4 id=
"validateimportarray-data"><code>validateImport(array $data)
</code><a class=
"headerlink" href=
"#validateimportarray-data" title=
"Permanent link">#
</a></h4>
2277 <p>The passed array
<code>$data
</code> equals the data returned by
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2278 This method has no return value, instead you should throw an exception if the passed data is invalid.
</p>
2279 <h4 id=
"findexistingitemarray-data"><code>findExistingItem(array $data)
</code><a class=
"headerlink" href=
"#findexistingitemarray-data" title=
"Permanent link">#
</a></h4>
2280 <p>The passed array
<code>$data
</code> equals the data returned by
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2281 This method is expected to return an array with two keys:
</p>
2283 <li><code>sql
</code> contains the SQL query with placeholders.
</li>
2284 <li><code>parameters
</code> contains an array with values used for the SQL query.
</li>
2286 <h4 id=
"253-example">2.5.3. Example
<a class=
"headerlink" href=
"#253-example" title=
"Permanent link">#
</a></h4>
2287 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2288 <span class=
"nv">$sql
</span> <span class=
"o">=
</span> <span class=
"s2">"SELECT *
</span>
2289 <span class=
"s2"> FROM wcf
"</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s2">"_
"</span><span class=
"o">.
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">tableName
</span><span class=
"o">.
</span><span class=
"s2">"</span>
2290 <span class=
"s2"> WHERE packageID = ?
</span>
2291 <span class=
"s2"> AND name = ?
</span>
2292 <span class=
"s2"> AND templateName = ?
</span>
2293 <span class=
"s2"> AND eventName = ?
</span>
2294 <span class=
"s2"> AND environment = ?
"</span><span class=
"p">;
</span>
2295 <span class=
"nv">$parameters
</span> <span class=
"o">=
</span> <span class=
"p">[
</span>
2296 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">installation
</span><span class=
"o">-
></span><span class=
"na">getPackageID
</span><span class=
"p">(),
</span>
2297 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'name
'</span><span class=
"p">],
</span>
2298 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'templateName
'</span><span class=
"p">],
</span>
2299 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'eventName
'</span><span class=
"p">],
</span>
2300 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'environment
'</span><span class=
"p">]
</span>
2301 <span class=
"p">];
</span>
2303 <span class=
"k">return
</span> <span class=
"p">[
</span>
2304 <span class=
"s1">'sql
'</span> <span class=
"o">=
></span> <span class=
"nv">$sql
</span><span class=
"p">,
</span>
2305 <span class=
"s1">'parameters
'</span> <span class=
"o">=
></span> <span class=
"nv">$parameters
</span>
2306 <span class=
"p">];
</span>
2308 <h4 id=
"handledeletearray-items"><code>handleDelete(array $items)
</code><a class=
"headerlink" href=
"#handledeletearray-items" title=
"Permanent link">#
</a></h4>
2309 <p>The passed array
<code>$items
</code> contains the original node data, similar to
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2310 You should make use of this data to remove the matching element from database.
</p>
2312 <div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2313 <span class=
"nv">$sql
</span> <span class=
"o">=
</span> <span class=
"s2">"DELETE FROM wcf
"</span><span class=
"o">.
</span><span class=
"nx">WCF_N
</span><span class=
"o">.
</span><span class=
"s2">"_
"</span><span class=
"o">.
</span><span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">tableName
</span><span class=
"o">.
</span><span class=
"s2">"</span>
2314 <span class=
"s2"> WHERE packageID = ?
</span>
2315 <span class=
"s2"> AND environment = ?
</span>
2316 <span class=
"s2"> AND eventName = ?
</span>
2317 <span class=
"s2"> AND name = ?
</span>
2318 <span class=
"s2"> AND templateName = ?
"</span><span class=
"p">;
</span>
2319 <span class=
"nv">$statement
</span> <span class=
"o">=
</span> <span class=
"nx">WCF
</span><span class=
"o">::
</span><span class=
"na">getDB
</span><span class=
"p">()
</span><span class=
"o">-
></span><span class=
"na">prepareStatement
</span><span class=
"p">(
</span><span class=
"nv">$sql
</span><span class=
"p">);
</span>
2320 <span class=
"k">foreach
</span> <span class=
"p">(
</span><span class=
"nv">$items
</span> <span class=
"k">as
</span> <span class=
"nv">$item
</span><span class=
"p">)
</span> <span class=
"p">{
</span>
2321 <span class=
"nv">$statement
</span><span class=
"o">-
></span><span class=
"na">execute
</span><span class=
"p">([
</span>
2322 <span class=
"nv">$this
</span><span class=
"o">-
></span><span class=
"na">installation
</span><span class=
"o">-
></span><span class=
"na">getPackageID
</span><span class=
"p">(),
</span>
2323 <span class=
"nv">$item
</span><span class=
"p">[
</span><span class=
"s1">'elements
'</span><span class=
"p">][
</span><span class=
"s1">'environment
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">],
</span>
2324 <span class=
"nv">$item
</span><span class=
"p">[
</span><span class=
"s1">'elements
'</span><span class=
"p">][
</span><span class=
"s1">'eventname
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">],
</span>
2325 <span class=
"nv">$item
</span><span class=
"p">[
</span><span class=
"s1">'attributes
'</span><span class=
"p">][
</span><span class=
"s1">'name
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">],
</span>
2326 <span class=
"nv">$item
</span><span class=
"p">[
</span><span class=
"s1">'elements
'</span><span class=
"p">][
</span><span class=
"s1">'templatename
'</span><span class=
"o">.
</span><span class=
"nx">md
</span><span class=
"p">]
</span>
2327 <span class=
"p">]);
</span>
2328 <span class=
"p">}
</span>
2329 </code></pre></div></p>
2330 <h4 id=
"postimport"><code>postImport()
</code><a class=
"headerlink" href=
"#postimport" title=
"Permanent link">#
</a></h4>
2331 <p>Allows you to (optionally) run additionally actions after all elements were processed.
</p>
2332 <h2 id=
"abstractoptionpackageinstallationplugin"><code>AbstractOptionPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractoptionpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2333 <p><a href=
"https://github.com/WoltLab/WCF/blob/master/wcfsetup/install/files/lib/system/package/plugin/AbstractOptionPackageInstallationPlugin.class.php">AbstractOptionPackageInstallationPlugin
</a> is an abstract implementation for options, used for:
</p>
2335 <li>ACL Options
</li>
2337 <li>User Options
</li>
2338 <li>User Group Options
</li>
2340 <h3 id=
"differences-to-abstractxmlpackageinstallationplugin">Differences to
<code>AbstractXMLPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#differences-to-abstractxmlpackageinstallationplugin" title=
"Permanent link">#
</a></h3>
2341 <h4 id=
"reservedtags"><code>$reservedTags
</code><a class=
"headerlink" href=
"#reservedtags" title=
"Permanent link">#
</a></h4>
2342 <p><code>$reservedTags
</code> is a list of reserved tag names so that any tag encountered but not listed here will be added to the database column
<code>additionalData
</code>.
2343 This allows options to store arbitrary data which can be accessed but were not initially part of the PIP specifications.
</p>
2349 <div class=
"md-source-date">
2352 Last update:
2021-
01-
08
2371 <footer class=
"md-footer">
2373 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2375 <a href=
"../form_builder/dependencies/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2376 <div class=
"md-footer__button md-icon">
2377 <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>
2379 <div class=
"md-footer__title">
2380 <div class=
"md-ellipsis">
2381 <span class=
"md-footer__direction">
2390 <a href=
"../user_activity_points/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2391 <div class=
"md-footer__title">
2392 <div class=
"md-ellipsis">
2393 <span class=
"md-footer__direction">
2396 User Activity Points
2399 <div class=
"md-footer__button md-icon">
2400 <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>
2406 <div class=
"md-footer-meta md-typeset">
2407 <div class=
"md-footer-meta__inner md-grid">
2408 <div class=
"md-footer-copyright">
2410 <div class=
"md-footer-copyright__highlight">
2411 Copyright ©
2020 WoltLab GmbH
2415 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2420 <div class=
"md-footer-copyright">
2421 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2422 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2429 <div class=
"md-dialog" data-md-component=
"dialog">
2430 <div class=
"md-dialog__inner md-typeset"></div>
2432 <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>
2435 <script src=
"../../../assets/javascripts/bundle.d892486b.min.js"></script>