3 <html lang=
"en" class=
"no-js">
7 <meta name=
"viewport" content=
"width=device-width,initial-scale=1">
12 <link rel=
"canonical" href=
"https://docs.woltlab.com/5.4/php/api/package_installation_plugins/">
14 <link rel=
"icon" href=
"../../../assets/default.favicon.ico">
15 <meta name=
"generator" content=
"mkdocs-1.1.2, mkdocs-material-7.1.2">
19 <title>Package Installation Plugins - WoltLab Suite Documentation
</title>
23 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/main.6f955dcd.min.css">
26 <link rel=
"stylesheet" href=
"../../../assets/stylesheets/palette.ef6f36e2.min.css">
30 <meta name=
"theme-color" content=
"#009485">
40 <link rel=
"stylesheet" href=
"../../../stylesheets/extra.css">
54 <body dir=
"ltr" data-md-color-scheme=
"" data-md-color-primary=
"teal" data-md-color-accent=
"">
57 <script>function __prefix(e){return new URL(
"../../..",location).pathname+
"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}
</script>
59 <input class=
"md-toggle" data-md-toggle=
"drawer" type=
"checkbox" id=
"__drawer" autocomplete=
"off">
60 <input class=
"md-toggle" data-md-toggle=
"search" type=
"checkbox" id=
"__search" autocomplete=
"off">
61 <label class=
"md-overlay" for=
"__drawer"></label>
62 <div data-md-component=
"skip">
65 <a href=
"#package-installation-plugins" class=
"md-skip">
70 <div data-md-component=
"announce">
72 <aside class=
"md-announce">
73 <div class=
"md-announce__inner md-grid md-typeset">
75 <a href=
"https://www.woltlab.com">Back to
<strong>woltlab.com
</strong></a>
82 <header class=
"md-header" data-md-component=
"header">
83 <nav class=
"md-header__inner md-grid" aria-label=
"Header">
84 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-header__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
86 <img src=
"../../../assets/logo.png" alt=
"logo">
89 <label class=
"md-header__button md-icon" for=
"__drawer">
90 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
92 <div class=
"md-header__title" data-md-component=
"header-title">
93 <div class=
"md-header__ellipsis">
94 <div class=
"md-header__topic">
95 <span class=
"md-ellipsis">
96 WoltLab Suite Documentation
99 <div class=
"md-header__topic" data-md-component=
"header-topic">
100 <span class=
"md-ellipsis">
102 Package Installation Plugins
111 <label class=
"md-header__button md-icon" for=
"__search">
112 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
115 <div class=
"md-search" data-md-component=
"search" role=
"dialog">
116 <label class=
"md-search__overlay" for=
"__search"></label>
117 <div class=
"md-search__inner" role=
"search">
118 <form class=
"md-search__form" name=
"search">
119 <input type=
"text" class=
"md-search__input" name=
"query" aria-label=
"Search" placeholder=
"Search" autocapitalize=
"off" autocorrect=
"off" autocomplete=
"off" spellcheck=
"false" data-md-component=
"search-query" data-md-state=
"active" required
>
120 <label class=
"md-search__icon md-icon" for=
"__search">
121 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
122 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
124 <button type=
"reset" class=
"md-search__icon md-icon" aria-label=
"Clear" tabindex=
"-1">
125 <svg xmlns=
"http://www.w3.org/2000/svg" viewBox=
"0 0 24 24"><path d=
"M19 6.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>
128 <div class=
"md-search__output">
129 <div class=
"md-search__scrollwrap" data-md-scrollfix
>
130 <div class=
"md-search-result" data-md-component=
"search-result">
131 <div class=
"md-search-result__meta">
134 <ol class=
"md-search-result__list"></ol>
142 <div class=
"md-header__source">
144 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
145 <div class=
"md-source__icon md-icon">
147 <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>
149 <div class=
"md-source__repository">
158 <div class=
"md-container" data-md-component=
"container">
163 <main class=
"md-main" data-md-component=
"main">
164 <div class=
"md-main__inner md-grid">
168 <div class=
"md-sidebar md-sidebar--primary" data-md-component=
"sidebar" data-md-type=
"navigation" >
169 <div class=
"md-sidebar__scrollwrap">
170 <div class=
"md-sidebar__inner">
174 <nav class=
"md-nav md-nav--primary" aria-label=
"Navigation" data-md-level=
"0">
175 <label class=
"md-nav__title" for=
"__drawer">
176 <a href=
"../../.." title=
"WoltLab Suite Documentation" class=
"md-nav__button md-logo" aria-label=
"WoltLab Suite Documentation" data-md-component=
"logo">
178 <img src=
"../../../assets/logo.png" alt=
"logo">
181 WoltLab Suite Documentation
184 <div class=
"md-nav__source">
186 <a href=
"https://github.com/WoltLab/docs.woltlab.com/" title=
"Go to repository" class=
"md-source" data-md-component=
"source">
187 <div class=
"md-source__icon md-icon">
189 <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>
191 <div class=
"md-source__repository">
197 <ul class=
"md-nav__list" data-md-scrollfix
>
206 <li class=
"md-nav__item">
207 <a href=
"../../../getting-started/" class=
"md-nav__link">
224 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
227 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2" type=
"checkbox" id=
"__nav_2" checked
>
229 <label class=
"md-nav__link" for=
"__nav_2">
231 <span class=
"md-nav__icon md-icon"></span>
233 <nav class=
"md-nav" aria-label=
"PHP API" data-md-level=
"1">
234 <label class=
"md-nav__title" for=
"__nav_2">
235 <span class=
"md-nav__icon md-icon"></span>
238 <ul class=
"md-nav__list" data-md-scrollfix
>
244 <li class=
"md-nav__item">
245 <a href=
"../../pages/" class=
"md-nav__link">
256 <li class=
"md-nav__item">
257 <a href=
"../../database-objects/" class=
"md-nav__link">
268 <li class=
"md-nav__item">
269 <a href=
"../../database-access/" class=
"md-nav__link">
280 <li class=
"md-nav__item">
281 <a href=
"../../exceptions/" class=
"md-nav__link">
295 <li class=
"md-nav__item md-nav__item--active md-nav__item--nested">
298 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5" type=
"checkbox" id=
"__nav_2_5" checked
>
300 <label class=
"md-nav__link" for=
"__nav_2_5">
302 <span class=
"md-nav__icon md-icon"></span>
304 <nav class=
"md-nav" aria-label=
"API" data-md-level=
"2">
305 <label class=
"md-nav__title" for=
"__nav_2_5">
306 <span class=
"md-nav__icon md-icon"></span>
309 <ul class=
"md-nav__list" data-md-scrollfix
>
316 <li class=
"md-nav__item md-nav__item--nested">
319 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_1" type=
"checkbox" id=
"__nav_2_5_1" >
321 <label class=
"md-nav__link" for=
"__nav_2_5_1">
323 <span class=
"md-nav__icon md-icon"></span>
325 <nav class=
"md-nav" aria-label=
"Caches" data-md-level=
"3">
326 <label class=
"md-nav__title" for=
"__nav_2_5_1">
327 <span class=
"md-nav__icon md-icon"></span>
330 <ul class=
"md-nav__list" data-md-scrollfix
>
336 <li class=
"md-nav__item">
337 <a href=
"../caches/" class=
"md-nav__link">
348 <li class=
"md-nav__item">
349 <a href=
"../caches_persistent-caches/" class=
"md-nav__link">
360 <li class=
"md-nav__item">
361 <a href=
"../caches_runtime-caches/" class=
"md-nav__link">
378 <li class=
"md-nav__item">
379 <a href=
"../comments/" class=
"md-nav__link">
390 <li class=
"md-nav__item">
391 <a href=
"../cronjobs/" class=
"md-nav__link">
402 <li class=
"md-nav__item">
403 <a href=
"../events/" class=
"md-nav__link">
415 <li class=
"md-nav__item md-nav__item--nested">
418 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_2_5_5" type=
"checkbox" id=
"__nav_2_5_5" >
420 <label class=
"md-nav__link" for=
"__nav_2_5_5">
422 <span class=
"md-nav__icon md-icon"></span>
424 <nav class=
"md-nav" aria-label=
"Form Builder" data-md-level=
"3">
425 <label class=
"md-nav__title" for=
"__nav_2_5_5">
426 <span class=
"md-nav__icon md-icon"></span>
429 <ul class=
"md-nav__list" data-md-scrollfix
>
435 <li class=
"md-nav__item">
436 <a href=
"../form_builder/overview/" class=
"md-nav__link">
447 <li class=
"md-nav__item">
448 <a href=
"../form_builder/structure/" class=
"md-nav__link">
459 <li class=
"md-nav__item">
460 <a href=
"../form_builder/form_fields/" class=
"md-nav__link">
471 <li class=
"md-nav__item">
472 <a href=
"../form_builder/validation_data/" class=
"md-nav__link">
483 <li class=
"md-nav__item">
484 <a href=
"../form_builder/dependencies/" class=
"md-nav__link">
503 <li class=
"md-nav__item md-nav__item--active">
505 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"toc" type=
"checkbox" id=
"__toc">
511 <label class=
"md-nav__link md-nav__link--active" for=
"__toc">
512 Package Installation Plugins
513 <span class=
"md-nav__icon md-icon"></span>
516 <a href=
"./" class=
"md-nav__link md-nav__link--active">
517 Package Installation Plugins
521 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
528 <label class=
"md-nav__title" for=
"__toc">
529 <span class=
"md-nav__icon md-icon"></span>
532 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
534 <li class=
"md-nav__item">
535 <a href=
"#abstractpackageinstallationplugin" class=
"md-nav__link">
536 AbstractPackageInstallationPlugin
539 <nav class=
"md-nav" aria-label=
"AbstractPackageInstallationPlugin">
540 <ul class=
"md-nav__list">
542 <li class=
"md-nav__item">
543 <a href=
"#class-members" class=
"md-nav__link">
547 <nav class=
"md-nav" aria-label=
"Class Members">
548 <ul class=
"md-nav__list">
550 <li class=
"md-nav__item">
551 <a href=
"#installation" class=
"md-nav__link">
557 <li class=
"md-nav__item">
558 <a href=
"#application" class=
"md-nav__link">
574 <li class=
"md-nav__item">
575 <a href=
"#abstractxmlpackageinstallationplugin" class=
"md-nav__link">
576 AbstractXMLPackageInstallationPlugin
579 <nav class=
"md-nav" aria-label=
"AbstractXMLPackageInstallationPlugin">
580 <ul class=
"md-nav__list">
582 <li class=
"md-nav__item">
583 <a href=
"#class-members_1" class=
"md-nav__link">
587 <nav class=
"md-nav" aria-label=
"Class Members">
588 <ul class=
"md-nav__list">
590 <li class=
"md-nav__item">
591 <a href=
"#classname" class=
"md-nav__link">
597 <li class=
"md-nav__item">
598 <a href=
"#tagname" class=
"md-nav__link">
604 <li class=
"md-nav__item">
605 <a href=
"#prepareimportarray-data" class=
"md-nav__link">
606 prepareImport(array $data)
611 <li class=
"md-nav__item">
612 <a href=
"#validateimportarray-data" class=
"md-nav__link">
613 validateImport(array $data)
618 <li class=
"md-nav__item">
619 <a href=
"#findexistingitemarray-data" class=
"md-nav__link">
620 findExistingItem(array $data)
625 <li class=
"md-nav__item">
626 <a href=
"#253-example" class=
"md-nav__link">
632 <li class=
"md-nav__item">
633 <a href=
"#handledeletearray-items" class=
"md-nav__link">
634 handleDelete(array $items)
639 <li class=
"md-nav__item">
640 <a href=
"#postimport" class=
"md-nav__link">
656 <li class=
"md-nav__item">
657 <a href=
"#abstractoptionpackageinstallationplugin" class=
"md-nav__link">
658 AbstractOptionPackageInstallationPlugin
661 <nav class=
"md-nav" aria-label=
"AbstractOptionPackageInstallationPlugin">
662 <ul class=
"md-nav__list">
664 <li class=
"md-nav__item">
665 <a href=
"#differences-to-abstractxmlpackageinstallationplugin" class=
"md-nav__link">
666 Differences to AbstractXMLPackageInstallationPlugin
669 <nav class=
"md-nav" aria-label=
"Differences to AbstractXMLPackageInstallationPlugin">
670 <ul class=
"md-nav__list">
672 <li class=
"md-nav__item">
673 <a href=
"#reservedtags" class=
"md-nav__link">
701 <li class=
"md-nav__item">
702 <a href=
"../user_activity_points/" class=
"md-nav__link">
713 <li class=
"md-nav__item">
714 <a href=
"../user_notifications/" class=
"md-nav__link">
725 <li class=
"md-nav__item">
726 <a href=
"../sitemaps/" class=
"md-nav__link">
743 <li class=
"md-nav__item">
744 <a href=
"../../code-style/" class=
"md-nav__link">
755 <li class=
"md-nav__item">
756 <a href=
"../../apps/" class=
"md-nav__link">
767 <li class=
"md-nav__item">
768 <a href=
"../../gdpr/" class=
"md-nav__link">
789 <li class=
"md-nav__item md-nav__item--nested">
792 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_3" type=
"checkbox" id=
"__nav_3" >
794 <label class=
"md-nav__link" for=
"__nav_3">
795 Languages, Templates & CSS
796 <span class=
"md-nav__icon md-icon"></span>
798 <nav class=
"md-nav" aria-label=
"Languages, Templates & CSS" data-md-level=
"1">
799 <label class=
"md-nav__title" for=
"__nav_3">
800 <span class=
"md-nav__icon md-icon"></span>
801 Languages, Templates & CSS
803 <ul class=
"md-nav__list" data-md-scrollfix
>
809 <li class=
"md-nav__item">
810 <a href=
"../../../view/languages/" class=
"md-nav__link">
821 <li class=
"md-nav__item">
822 <a href=
"../../../view/templates/" class=
"md-nav__link">
833 <li class=
"md-nav__item">
834 <a href=
"../../../view/template-plugins/" class=
"md-nav__link">
845 <li class=
"md-nav__item">
846 <a href=
"../../../view/css/" class=
"md-nav__link">
867 <li class=
"md-nav__item md-nav__item--nested">
870 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4" type=
"checkbox" id=
"__nav_4" >
872 <label class=
"md-nav__link" for=
"__nav_4">
873 TypeScript and JavaScript API
874 <span class=
"md-nav__icon md-icon"></span>
876 <nav class=
"md-nav" aria-label=
"TypeScript and JavaScript API" data-md-level=
"1">
877 <label class=
"md-nav__title" for=
"__nav_4">
878 <span class=
"md-nav__icon md-icon"></span>
879 TypeScript and JavaScript API
881 <ul class=
"md-nav__list" data-md-scrollfix
>
887 <li class=
"md-nav__item">
888 <a href=
"../../../javascript/general-usage/" class=
"md-nav__link">
899 <li class=
"md-nav__item">
900 <a href=
"../../../javascript/typescript/" class=
"md-nav__link">
912 <li class=
"md-nav__item md-nav__item--nested">
915 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_4_3" type=
"checkbox" id=
"__nav_4_3" >
917 <label class=
"md-nav__link" for=
"__nav_4_3">
919 <span class=
"md-nav__icon md-icon"></span>
921 <nav class=
"md-nav" aria-label=
"New API" data-md-level=
"2">
922 <label class=
"md-nav__title" for=
"__nav_4_3">
923 <span class=
"md-nav__icon md-icon"></span>
926 <ul class=
"md-nav__list" data-md-scrollfix
>
932 <li class=
"md-nav__item">
933 <a href=
"../../../javascript/new-api_writing-a-module/" class=
"md-nav__link">
944 <li class=
"md-nav__item">
945 <a href=
"../../../javascript/new-api_data-structures/" class=
"md-nav__link">
956 <li class=
"md-nav__item">
957 <a href=
"../../../javascript/new-api_core/" class=
"md-nav__link">
968 <li class=
"md-nav__item">
969 <a href=
"../../../javascript/new-api_dom/" class=
"md-nav__link">
980 <li class=
"md-nav__item">
981 <a href=
"../../../javascript/new-api_events/" class=
"md-nav__link">
992 <li class=
"md-nav__item">
993 <a href=
"../../../javascript/new-api_ajax/" class=
"md-nav__link">
1004 <li class=
"md-nav__item">
1005 <a href=
"../../../javascript/new-api_dialogs/" class=
"md-nav__link">
1016 <li class=
"md-nav__item">
1017 <a href=
"../../../javascript/new-api_browser/" class=
"md-nav__link">
1018 Browser and Screen Sizes
1028 <li class=
"md-nav__item">
1029 <a href=
"../../../javascript/new-api_ui/" class=
"md-nav__link">
1046 <li class=
"md-nav__item">
1047 <a href=
"../../../javascript/legacy-api/" class=
"md-nav__link">
1058 <li class=
"md-nav__item">
1059 <a href=
"../../../javascript/helper-functions/" class=
"md-nav__link">
1070 <li class=
"md-nav__item">
1071 <a href=
"../../../javascript/code-snippets/" class=
"md-nav__link">
1092 <li class=
"md-nav__item md-nav__item--nested">
1095 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5" type=
"checkbox" id=
"__nav_5" >
1097 <label class=
"md-nav__link" for=
"__nav_5">
1099 <span class=
"md-nav__icon md-icon"></span>
1101 <nav class=
"md-nav" aria-label=
"Package Components" data-md-level=
"1">
1102 <label class=
"md-nav__title" for=
"__nav_5">
1103 <span class=
"md-nav__icon md-icon"></span>
1106 <ul class=
"md-nav__list" data-md-scrollfix
>
1112 <li class=
"md-nav__item">
1113 <a href=
"../../../package/package-xml/" class=
"md-nav__link">
1125 <li class=
"md-nav__item md-nav__item--nested">
1128 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_5_2" type=
"checkbox" id=
"__nav_5_2" >
1130 <label class=
"md-nav__link" for=
"__nav_5_2">
1132 <span class=
"md-nav__icon md-icon"></span>
1134 <nav class=
"md-nav" aria-label=
"PIPs" data-md-level=
"2">
1135 <label class=
"md-nav__title" for=
"__nav_5_2">
1136 <span class=
"md-nav__icon md-icon"></span>
1139 <ul class=
"md-nav__list" data-md-scrollfix
>
1145 <li class=
"md-nav__item">
1146 <a href=
"../../../package/pip/" class=
"md-nav__link">
1157 <li class=
"md-nav__item">
1158 <a href=
"../../../package/pip/acl-option/" class=
"md-nav__link">
1169 <li class=
"md-nav__item">
1170 <a href=
"../../../package/pip/acp-menu/" class=
"md-nav__link">
1181 <li class=
"md-nav__item">
1182 <a href=
"../../../package/pip/acp-search-provider/" class=
"md-nav__link">
1193 <li class=
"md-nav__item">
1194 <a href=
"../../../package/pip/acp-template/" class=
"md-nav__link">
1205 <li class=
"md-nav__item">
1206 <a href=
"../../../package/pip/bbcode/" class=
"md-nav__link">
1217 <li class=
"md-nav__item">
1218 <a href=
"../../../package/pip/box/" class=
"md-nav__link">
1229 <li class=
"md-nav__item">
1230 <a href=
"../../../package/pip/clipboard-action/" class=
"md-nav__link">
1241 <li class=
"md-nav__item">
1242 <a href=
"../../../package/pip/core-object/" class=
"md-nav__link">
1253 <li class=
"md-nav__item">
1254 <a href=
"../../../package/pip/cronjob/" class=
"md-nav__link">
1265 <li class=
"md-nav__item">
1266 <a href=
"../../../package/pip/database/" class=
"md-nav__link">
1277 <li class=
"md-nav__item">
1278 <a href=
"../../../package/pip/event-listener/" class=
"md-nav__link">
1289 <li class=
"md-nav__item">
1290 <a href=
"../../../package/pip/file/" class=
"md-nav__link">
1301 <li class=
"md-nav__item">
1302 <a href=
"../../../package/pip/language/" class=
"md-nav__link">
1313 <li class=
"md-nav__item">
1314 <a href=
"../../../package/pip/media-provider/" class=
"md-nav__link">
1325 <li class=
"md-nav__item">
1326 <a href=
"../../../package/pip/menu/" class=
"md-nav__link">
1337 <li class=
"md-nav__item">
1338 <a href=
"../../../package/pip/menu-item/" class=
"md-nav__link">
1349 <li class=
"md-nav__item">
1350 <a href=
"../../../package/pip/object-type/" class=
"md-nav__link">
1361 <li class=
"md-nav__item">
1362 <a href=
"../../../package/pip/object-type-definition/" class=
"md-nav__link">
1363 objectTypeDefinition
1373 <li class=
"md-nav__item">
1374 <a href=
"../../../package/pip/option/" class=
"md-nav__link">
1385 <li class=
"md-nav__item">
1386 <a href=
"../../../package/pip/page/" class=
"md-nav__link">
1397 <li class=
"md-nav__item">
1398 <a href=
"../../../package/pip/pip/" class=
"md-nav__link">
1409 <li class=
"md-nav__item">
1410 <a href=
"../../../package/pip/script/" class=
"md-nav__link">
1421 <li class=
"md-nav__item">
1422 <a href=
"../../../package/pip/smiley/" class=
"md-nav__link">
1433 <li class=
"md-nav__item">
1434 <a href=
"../../../package/pip/sql/" class=
"md-nav__link">
1445 <li class=
"md-nav__item">
1446 <a href=
"../../../package/pip/style/" class=
"md-nav__link">
1457 <li class=
"md-nav__item">
1458 <a href=
"../../../package/pip/template/" class=
"md-nav__link">
1469 <li class=
"md-nav__item">
1470 <a href=
"../../../package/pip/template-listener/" class=
"md-nav__link">
1481 <li class=
"md-nav__item">
1482 <a href=
"../../../package/pip/user-group-option/" class=
"md-nav__link">
1493 <li class=
"md-nav__item">
1494 <a href=
"../../../package/pip/user-menu/" class=
"md-nav__link">
1505 <li class=
"md-nav__item">
1506 <a href=
"../../../package/pip/user-notification-event/" class=
"md-nav__link">
1507 userNotificationEvent
1517 <li class=
"md-nav__item">
1518 <a href=
"../../../package/pip/user-option/" class=
"md-nav__link">
1529 <li class=
"md-nav__item">
1530 <a href=
"../../../package/pip/user-profile-menu/" class=
"md-nav__link">
1547 <li class=
"md-nav__item">
1548 <a href=
"../../../package/database-php-api/" class=
"md-nav__link">
1569 <li class=
"md-nav__item md-nav__item--nested">
1572 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6" type=
"checkbox" id=
"__nav_6" >
1574 <label class=
"md-nav__link" for=
"__nav_6">
1576 <span class=
"md-nav__icon md-icon"></span>
1578 <nav class=
"md-nav" aria-label=
"Migration" data-md-level=
"1">
1579 <label class=
"md-nav__title" for=
"__nav_6">
1580 <span class=
"md-nav__icon md-icon"></span>
1583 <ul class=
"md-nav__list" data-md-scrollfix
>
1590 <li class=
"md-nav__item md-nav__item--nested">
1593 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_1" type=
"checkbox" id=
"__nav_6_1" >
1595 <label class=
"md-nav__link" for=
"__nav_6_1">
1596 Migrating from WSC
5.3
1597 <span class=
"md-nav__icon md-icon"></span>
1599 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.3" data-md-level=
"2">
1600 <label class=
"md-nav__title" for=
"__nav_6_1">
1601 <span class=
"md-nav__icon md-icon"></span>
1602 Migrating from WSC
5.3
1604 <ul class=
"md-nav__list" data-md-scrollfix
>
1610 <li class=
"md-nav__item">
1611 <a href=
"../../../migration/wsc53/php/" class=
"md-nav__link">
1622 <li class=
"md-nav__item">
1623 <a href=
"../../../migration/wsc53/session/" class=
"md-nav__link">
1624 Session Handling and Authentication
1634 <li class=
"md-nav__item">
1635 <a href=
"../../../migration/wsc53/javascript/" class=
"md-nav__link">
1636 TypeScript and JavaScript
1646 <li class=
"md-nav__item">
1647 <a href=
"../../../migration/wsc53/templates/" class=
"md-nav__link">
1658 <li class=
"md-nav__item">
1659 <a href=
"../../../migration/wsc53/libraries/" class=
"md-nav__link">
1660 Third Party Libraries
1677 <li class=
"md-nav__item md-nav__item--nested">
1680 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_2" type=
"checkbox" id=
"__nav_6_2" >
1682 <label class=
"md-nav__link" for=
"__nav_6_2">
1683 Migrating from WSC
5.2
1684 <span class=
"md-nav__icon md-icon"></span>
1686 <nav class=
"md-nav" aria-label=
"Migrating from WSC 5.2" data-md-level=
"2">
1687 <label class=
"md-nav__title" for=
"__nav_6_2">
1688 <span class=
"md-nav__icon md-icon"></span>
1689 Migrating from WSC
5.2
1691 <ul class=
"md-nav__list" data-md-scrollfix
>
1697 <li class=
"md-nav__item">
1698 <a href=
"../../../migration/wsc52/php/" class=
"md-nav__link">
1709 <li class=
"md-nav__item">
1710 <a href=
"../../../migration/wsc52/templates/" class=
"md-nav__link">
1711 Templates and Languages
1721 <li class=
"md-nav__item">
1722 <a href=
"../../../migration/wsc52/libraries/" class=
"md-nav__link">
1723 Third Party Libraries
1740 <li class=
"md-nav__item md-nav__item--nested">
1743 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_3" type=
"checkbox" id=
"__nav_6_3" >
1745 <label class=
"md-nav__link" for=
"__nav_6_3">
1746 Migrating from WSC
3.1
1747 <span class=
"md-nav__icon md-icon"></span>
1749 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.1" data-md-level=
"2">
1750 <label class=
"md-nav__title" for=
"__nav_6_3">
1751 <span class=
"md-nav__icon md-icon"></span>
1752 Migrating from WSC
3.1
1754 <ul class=
"md-nav__list" data-md-scrollfix
>
1760 <li class=
"md-nav__item">
1761 <a href=
"../../../migration/wsc31/php/" class=
"md-nav__link">
1779 <li class=
"md-nav__item md-nav__item--nested">
1782 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_4" type=
"checkbox" id=
"__nav_6_4" >
1784 <label class=
"md-nav__link" for=
"__nav_6_4">
1785 Migrating from WSC
3.0
1786 <span class=
"md-nav__icon md-icon"></span>
1788 <nav class=
"md-nav" aria-label=
"Migrating from WSC 3.0" data-md-level=
"2">
1789 <label class=
"md-nav__title" for=
"__nav_6_4">
1790 <span class=
"md-nav__icon md-icon"></span>
1791 Migrating from WSC
3.0
1793 <ul class=
"md-nav__list" data-md-scrollfix
>
1799 <li class=
"md-nav__item">
1800 <a href=
"../../../migration/wsc30/php/" class=
"md-nav__link">
1811 <li class=
"md-nav__item">
1812 <a href=
"../../../migration/wsc30/javascript/" class=
"md-nav__link">
1823 <li class=
"md-nav__item">
1824 <a href=
"../../../migration/wsc30/templates/" class=
"md-nav__link">
1835 <li class=
"md-nav__item">
1836 <a href=
"../../../migration/wsc30/css/" class=
"md-nav__link">
1847 <li class=
"md-nav__item">
1848 <a href=
"../../../migration/wsc30/package/" class=
"md-nav__link">
1866 <li class=
"md-nav__item md-nav__item--nested">
1869 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_6_5" type=
"checkbox" id=
"__nav_6_5" >
1871 <label class=
"md-nav__link" for=
"__nav_6_5">
1872 Migrating from WCF
2.1
1873 <span class=
"md-nav__icon md-icon"></span>
1875 <nav class=
"md-nav" aria-label=
"Migrating from WCF 2.1" data-md-level=
"2">
1876 <label class=
"md-nav__title" for=
"__nav_6_5">
1877 <span class=
"md-nav__icon md-icon"></span>
1878 Migrating from WCF
2.1
1880 <ul class=
"md-nav__list" data-md-scrollfix
>
1886 <li class=
"md-nav__item">
1887 <a href=
"../../../migration/wcf21/php/" class=
"md-nav__link">
1898 <li class=
"md-nav__item">
1899 <a href=
"../../../migration/wcf21/templates/" class=
"md-nav__link">
1910 <li class=
"md-nav__item">
1911 <a href=
"../../../migration/wcf21/css/" class=
"md-nav__link">
1922 <li class=
"md-nav__item">
1923 <a href=
"../../../migration/wcf21/package/" class=
"md-nav__link">
1950 <li class=
"md-nav__item md-nav__item--nested">
1953 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7" type=
"checkbox" id=
"__nav_7" >
1955 <label class=
"md-nav__link" for=
"__nav_7">
1957 <span class=
"md-nav__icon md-icon"></span>
1959 <nav class=
"md-nav" aria-label=
"Tutorials" data-md-level=
"1">
1960 <label class=
"md-nav__title" for=
"__nav_7">
1961 <span class=
"md-nav__icon md-icon"></span>
1964 <ul class=
"md-nav__list" data-md-scrollfix
>
1971 <li class=
"md-nav__item md-nav__item--nested">
1974 <input class=
"md-nav__toggle md-toggle" data-md-toggle=
"__nav_7_1" type=
"checkbox" id=
"__nav_7_1" >
1976 <label class=
"md-nav__link" for=
"__nav_7_1">
1978 <span class=
"md-nav__icon md-icon"></span>
1980 <nav class=
"md-nav" aria-label=
"Tutorial Series" data-md-level=
"2">
1981 <label class=
"md-nav__title" for=
"__nav_7_1">
1982 <span class=
"md-nav__icon md-icon"></span>
1985 <ul class=
"md-nav__list" data-md-scrollfix
>
1991 <li class=
"md-nav__item">
1992 <a href=
"../../../tutorial/series/overview/" class=
"md-nav__link">
2003 <li class=
"md-nav__item">
2004 <a href=
"../../../tutorial/series/part_1/" class=
"md-nav__link">
2015 <li class=
"md-nav__item">
2016 <a href=
"../../../tutorial/series/part_2/" class=
"md-nav__link">
2027 <li class=
"md-nav__item">
2028 <a href=
"../../../tutorial/series/part_3/" class=
"md-nav__link">
2039 <li class=
"md-nav__item">
2040 <a href=
"../../../tutorial/series/part_4/" class=
"md-nav__link">
2051 <li class=
"md-nav__item">
2052 <a href=
"../../../tutorial/series/part_5/" class=
"md-nav__link">
2079 <div class=
"md-sidebar md-sidebar--secondary" data-md-component=
"sidebar" data-md-type=
"toc" >
2080 <div class=
"md-sidebar__scrollwrap">
2081 <div class=
"md-sidebar__inner">
2083 <nav class=
"md-nav md-nav--secondary" aria-label=
"Table of contents">
2090 <label class=
"md-nav__title" for=
"__toc">
2091 <span class=
"md-nav__icon md-icon"></span>
2094 <ul class=
"md-nav__list" data-md-component=
"toc" data-md-scrollfix
>
2096 <li class=
"md-nav__item">
2097 <a href=
"#abstractpackageinstallationplugin" class=
"md-nav__link">
2098 AbstractPackageInstallationPlugin
2101 <nav class=
"md-nav" aria-label=
"AbstractPackageInstallationPlugin">
2102 <ul class=
"md-nav__list">
2104 <li class=
"md-nav__item">
2105 <a href=
"#class-members" class=
"md-nav__link">
2109 <nav class=
"md-nav" aria-label=
"Class Members">
2110 <ul class=
"md-nav__list">
2112 <li class=
"md-nav__item">
2113 <a href=
"#installation" class=
"md-nav__link">
2119 <li class=
"md-nav__item">
2120 <a href=
"#application" class=
"md-nav__link">
2136 <li class=
"md-nav__item">
2137 <a href=
"#abstractxmlpackageinstallationplugin" class=
"md-nav__link">
2138 AbstractXMLPackageInstallationPlugin
2141 <nav class=
"md-nav" aria-label=
"AbstractXMLPackageInstallationPlugin">
2142 <ul class=
"md-nav__list">
2144 <li class=
"md-nav__item">
2145 <a href=
"#class-members_1" class=
"md-nav__link">
2149 <nav class=
"md-nav" aria-label=
"Class Members">
2150 <ul class=
"md-nav__list">
2152 <li class=
"md-nav__item">
2153 <a href=
"#classname" class=
"md-nav__link">
2159 <li class=
"md-nav__item">
2160 <a href=
"#tagname" class=
"md-nav__link">
2166 <li class=
"md-nav__item">
2167 <a href=
"#prepareimportarray-data" class=
"md-nav__link">
2168 prepareImport(array $data)
2173 <li class=
"md-nav__item">
2174 <a href=
"#validateimportarray-data" class=
"md-nav__link">
2175 validateImport(array $data)
2180 <li class=
"md-nav__item">
2181 <a href=
"#findexistingitemarray-data" class=
"md-nav__link">
2182 findExistingItem(array $data)
2187 <li class=
"md-nav__item">
2188 <a href=
"#253-example" class=
"md-nav__link">
2194 <li class=
"md-nav__item">
2195 <a href=
"#handledeletearray-items" class=
"md-nav__link">
2196 handleDelete(array $items)
2201 <li class=
"md-nav__item">
2202 <a href=
"#postimport" class=
"md-nav__link">
2218 <li class=
"md-nav__item">
2219 <a href=
"#abstractoptionpackageinstallationplugin" class=
"md-nav__link">
2220 AbstractOptionPackageInstallationPlugin
2223 <nav class=
"md-nav" aria-label=
"AbstractOptionPackageInstallationPlugin">
2224 <ul class=
"md-nav__list">
2226 <li class=
"md-nav__item">
2227 <a href=
"#differences-to-abstractxmlpackageinstallationplugin" class=
"md-nav__link">
2228 Differences to AbstractXMLPackageInstallationPlugin
2231 <nav class=
"md-nav" aria-label=
"Differences to AbstractXMLPackageInstallationPlugin">
2232 <ul class=
"md-nav__list">
2234 <li class=
"md-nav__item">
2235 <a href=
"#reservedtags" class=
"md-nav__link">
2259 <div class=
"md-content" data-md-component=
"content">
2260 <article class=
"md-content__inner md-typeset">
2263 <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">
2264 <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>
2268 <h1 id=
"package-installation-plugins">Package Installation Plugins
<a class=
"headerlink" href=
"#package-installation-plugins" title=
"Permanent link">#
</a></h1>
2269 <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>
2270 <h2 id=
"abstractpackageinstallationplugin"><code>AbstractPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2271 <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.
2272 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.
2273 The abstract implementation will always provide sane methods in case of any API changes.
</p>
2274 <h3 id=
"class-members">Class Members
<a class=
"headerlink" href=
"#class-members" title=
"Permanent link">#
</a></h3>
2275 <p>Package Installation Plugins have a few notable class members easing your work:
</p>
2276 <h4 id=
"installation"><code>$installation
</code><a class=
"headerlink" href=
"#installation" title=
"Permanent link">#
</a></h4>
2277 <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.
2278 The most common usage is the retrieval of the package ID via
<code>$this-
>installation-
>getPackageID()
</code>.
</p>
2279 <h4 id=
"application"><code>$application
</code><a class=
"headerlink" href=
"#application" title=
"Permanent link">#
</a></h4>
2280 <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>
2281 <h2 id=
"abstractxmlpackageinstallationplugin"><code>AbstractXMLPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractxmlpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2282 <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.
2283 It handles the evaluation of the document and provide you an object-orientated approach to handle its data.
</p>
2284 <h3 id=
"class-members_1">Class Members
<a class=
"headerlink" href=
"#class-members_1" title=
"Permanent link">#
</a></h3>
2285 <h4 id=
"classname"><code>$className
</code><a class=
"headerlink" href=
"#classname" title=
"Permanent link">#
</a></h4>
2286 <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>
2287 <h4 id=
"tagname"><code>$tagName
</code><a class=
"headerlink" href=
"#tagname" title=
"Permanent link">#
</a></h4>
2288 <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>
2289 <h4 id=
"prepareimportarray-data"><code>prepareImport(array $data)
</code><a class=
"headerlink" href=
"#prepareimportarray-data" title=
"Permanent link">#
</a></h4>
2290 <p>The passed array
<code>$data
</code> contains the parsed value from each evaluated tag in the
<code><import
></code> section:
</p>
2292 <li><code>$data['elements']
</code> contains a list of tag names and their value.
</li>
2293 <li><code>$data['attributes']
</code> contains a list of attributes present on the tag identified by
<a href=
"#tagname">$tagName
</a>.
</li>
2295 <p>This method should return an one-dimensional array, where each key maps to the corresponding database column name (key names are case-sensitive).
2296 It will be passed to either
<code>DatabaseObjectEditor::create()
</code> or
<code>DatabaseObjectEditor::update()
</code>.
</p>
2298 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal">1</span>
2299 <span class=
"normal">2</span>
2300 <span class=
"normal">3</span>
2301 <span class=
"normal">4</span>
2302 <span class=
"normal">5</span>
2303 <span class=
"normal">6</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2304 <span class=
"k">return
</span> <span class=
"p">[
</span>
2305 <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>
2306 <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>
2307 <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>
2308 <span class=
"p">];
</span>
2311 <h4 id=
"validateimportarray-data"><code>validateImport(array $data)
</code><a class=
"headerlink" href=
"#validateimportarray-data" title=
"Permanent link">#
</a></h4>
2312 <p>The passed array
<code>$data
</code> equals the data returned by
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2313 This method has no return value, instead you should throw an exception if the passed data is invalid.
</p>
2314 <h4 id=
"findexistingitemarray-data"><code>findExistingItem(array $data)
</code><a class=
"headerlink" href=
"#findexistingitemarray-data" title=
"Permanent link">#
</a></h4>
2315 <p>The passed array
<code>$data
</code> equals the data returned by
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2316 This method is expected to return an array with two keys:
</p>
2318 <li><code>sql
</code> contains the SQL query with placeholders.
</li>
2319 <li><code>parameters
</code> contains an array with values used for the SQL query.
</li>
2321 <h4 id=
"253-example">2.5.3. Example
<a class=
"headerlink" href=
"#253-example" title=
"Permanent link">#
</a></h4>
2322 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2323 <span class=
"normal"> 2</span>
2324 <span class=
"normal"> 3</span>
2325 <span class=
"normal"> 4</span>
2326 <span class=
"normal"> 5</span>
2327 <span class=
"normal"> 6</span>
2328 <span class=
"normal"> 7</span>
2329 <span class=
"normal"> 8</span>
2330 <span class=
"normal"> 9</span>
2331 <span class=
"normal">10</span>
2332 <span class=
"normal">11</span>
2333 <span class=
"normal">12</span>
2334 <span class=
"normal">13</span>
2335 <span class=
"normal">14</span>
2336 <span class=
"normal">15</span>
2337 <span class=
"normal">16</span>
2338 <span class=
"normal">17</span>
2339 <span class=
"normal">18</span>
2340 <span class=
"normal">19</span>
2341 <span class=
"normal">20</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2342 <span class=
"nv">$sql
</span> <span class=
"o">=
</span> <span class=
"s2">"SELECT *
</span>
2343 <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>
2344 <span class=
"s2"> WHERE packageID = ?
</span>
2345 <span class=
"s2"> AND name = ?
</span>
2346 <span class=
"s2"> AND templateName = ?
</span>
2347 <span class=
"s2"> AND eventName = ?
</span>
2348 <span class=
"s2"> AND environment = ?
"</span><span class=
"p">;
</span>
2349 <span class=
"nv">$parameters
</span> <span class=
"o">=
</span> <span class=
"p">[
</span>
2350 <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>
2351 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'name
'</span><span class=
"p">],
</span>
2352 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'templateName
'</span><span class=
"p">],
</span>
2353 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'eventName
'</span><span class=
"p">],
</span>
2354 <span class=
"nv">$data
</span><span class=
"p">[
</span><span class=
"s1">'environment
'</span><span class=
"p">]
</span>
2355 <span class=
"p">];
</span>
2357 <span class=
"k">return
</span> <span class=
"p">[
</span>
2358 <span class=
"s1">'sql
'</span> <span class=
"o">=
></span> <span class=
"nv">$sql
</span><span class=
"p">,
</span>
2359 <span class=
"s1">'parameters
'</span> <span class=
"o">=
></span> <span class=
"nv">$parameters
</span>
2360 <span class=
"p">];
</span>
2363 <h4 id=
"handledeletearray-items"><code>handleDelete(array $items)
</code><a class=
"headerlink" href=
"#handledeletearray-items" title=
"Permanent link">#
</a></h4>
2364 <p>The passed array
<code>$items
</code> contains the original node data, similar to
<a href=
"#prepareimportarray-data">prepareImport()
</a>.
2365 You should make use of this data to remove the matching element from database.
</p>
2367 <table class=
"highlighttable"><tr><td class=
"linenos"><div class=
"linenodiv"><pre><span></span><span class=
"normal"> 1</span>
2368 <span class=
"normal"> 2</span>
2369 <span class=
"normal"> 3</span>
2370 <span class=
"normal"> 4</span>
2371 <span class=
"normal"> 5</span>
2372 <span class=
"normal"> 6</span>
2373 <span class=
"normal"> 7</span>
2374 <span class=
"normal"> 8</span>
2375 <span class=
"normal"> 9</span>
2376 <span class=
"normal">10</span>
2377 <span class=
"normal">11</span>
2378 <span class=
"normal">12</span>
2379 <span class=
"normal">13</span>
2380 <span class=
"normal">14</span>
2381 <span class=
"normal">15</span>
2382 <span class=
"normal">16</span>
2383 <span class=
"normal">17</span></pre></div></td><td class=
"code"><div class=
"highlight"><pre><span></span><code><span class=
"o"><?
</span><span class=
"nx">php
</span>
2384 <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>
2385 <span class=
"s2"> WHERE packageID = ?
</span>
2386 <span class=
"s2"> AND environment = ?
</span>
2387 <span class=
"s2"> AND eventName = ?
</span>
2388 <span class=
"s2"> AND name = ?
</span>
2389 <span class=
"s2"> AND templateName = ?
"</span><span class=
"p">;
</span>
2390 <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>
2391 <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>
2392 <span class=
"nv">$statement
</span><span class=
"o">-
></span><span class=
"na">execute
</span><span class=
"p">([
</span>
2393 <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>
2394 <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>
2395 <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>
2396 <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>
2397 <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>
2398 <span class=
"p">]);
</span>
2399 <span class=
"p">}
</span>
2401 </td></tr></table></p>
2402 <h4 id=
"postimport"><code>postImport()
</code><a class=
"headerlink" href=
"#postimport" title=
"Permanent link">#
</a></h4>
2403 <p>Allows you to (optionally) run additionally actions after all elements were processed.
</p>
2404 <h2 id=
"abstractoptionpackageinstallationplugin"><code>AbstractOptionPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#abstractoptionpackageinstallationplugin" title=
"Permanent link">#
</a></h2>
2405 <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>
2407 <li>ACL Options
</li>
2409 <li>User Options
</li>
2410 <li>User Group Options
</li>
2412 <h3 id=
"differences-to-abstractxmlpackageinstallationplugin">Differences to
<code>AbstractXMLPackageInstallationPlugin
</code><a class=
"headerlink" href=
"#differences-to-abstractxmlpackageinstallationplugin" title=
"Permanent link">#
</a></h3>
2413 <h4 id=
"reservedtags"><code>$reservedTags
</code><a class=
"headerlink" href=
"#reservedtags" title=
"Permanent link">#
</a></h4>
2414 <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>.
2415 This allows options to store arbitrary data which can be accessed but were not initially part of the PIP specifications.
</p>
2421 <div class=
"md-source-date">
2424 Last update:
2021-
01-
08
2443 <footer class=
"md-footer">
2445 <nav class=
"md-footer__inner md-grid" aria-label=
"Footer">
2447 <a href=
"../form_builder/dependencies/" class=
"md-footer__link md-footer__link--prev" rel=
"prev">
2448 <div class=
"md-footer__button md-icon">
2449 <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>
2451 <div class=
"md-footer__title">
2452 <div class=
"md-ellipsis">
2453 <span class=
"md-footer__direction">
2462 <a href=
"../user_activity_points/" class=
"md-footer__link md-footer__link--next" rel=
"next">
2463 <div class=
"md-footer__title">
2464 <div class=
"md-ellipsis">
2465 <span class=
"md-footer__direction">
2468 User Activity Points
2471 <div class=
"md-footer__button md-icon">
2472 <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>
2478 <div class=
"md-footer-meta md-typeset">
2479 <div class=
"md-footer-meta__inner md-grid">
2480 <div class=
"md-footer-copyright">
2482 <div class=
"md-footer-copyright__highlight">
2483 Copyright ©
2020 WoltLab GmbH
2487 <a href=
"https://squidfunk.github.io/mkdocs-material/" target=
"_blank" rel=
"noopener">
2492 <div class=
"md-footer-copyright">
2493 <a href=
"https://www.woltlab.com/legal-notice/">Legal Notice
</a>
2494 <a href=
"https://www.woltlab.com/privacy-policy/">Privacy Policy
</a>
2501 <div class=
"md-dialog" data-md-component=
"dialog">
2502 <div class=
"md-dialog__inner md-typeset"></div>
2504 <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>
2507 <script src=
"../../../assets/javascripts/bundle.4ea5477f.min.js"></script>