<link rel="canonical" href="https://docs.woltlab.com/6.0/migration/wsc55/php/">
+
+ <link rel="prev" href="../../../package/database-php-api/">
+
+
+ <link rel="next" href="../javascript/">
+
<link rel="icon" href="../../../assets/default.favicon.ico">
- <meta name="generator" content="mkdocs-1.4.1, mkdocs-material-8.5.7">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.8">
- <link rel="stylesheet" href="../../../assets/stylesheets/main.20d9efc8.min.css">
+ <link rel="stylesheet" href="../../../assets/stylesheets/main.ded33207.min.css">
- <link rel="stylesheet" href="../../../assets/stylesheets/palette.cbb835fc.min.css">
-
-
-
- <meta name="theme-color" content="#009485">
-
+ <link rel="stylesheet" href="../../../assets/stylesheets/palette.a0c5b2b5.min.css">
- <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="indigo">
</div>
- <div data-md-component="outdated" hidden>
+ <div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
-<header class="md-header" data-md-component="header">
+
+
+<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation" data-md-component="logo">
</div>
</div>
+
+
<label class="md-header__button md-icon" for="__search">
<div class="md-search-result__meta">
Initializing search
</div>
- <ol class="md-search-result__list"></ol>
+ <ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.
2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><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>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.
4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
</div>
<div class="md-source__repository">
GitHub
<a href="https://github.com/WoltLab/docs.woltlab.com/" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
- <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.
2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><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>
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.
4.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><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>
</div>
<div class="md-source__repository">
GitHub
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
+
- <label class="md-nav__link" for="__nav_2">
+ <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
PHP API
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="PHP API" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
PHP API
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
- <label class="md-nav__link" for="__nav_2_5">
+
+ <label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
API
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="API" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_5">
<span class="md-nav__icon md-icon"></span>
API
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_1" type="checkbox" id="__nav_2_5_1" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
+
- <label class="md-nav__link" for="__nav_2_5_1">
+ <label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
Caches
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Caches" data-md-level="3">
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_5_1">
<span class="md-nav__icon md-icon"></span>
Caches
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_5" >
- <label class="md-nav__link" for="__nav_2_5_5">
+
+ <label class="md-nav__link" for="__nav_2_5_5" id="__nav_2_5_5_label" tabindex="0">
Form Builder
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2_5_5">
<span class="md-nav__icon md-icon"></span>
Form Builder
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
+
- <label class="md-nav__link" for="__nav_3">
+ <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
Languages, Templates & CSS
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Languages, Templates & CSS
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
- <label class="md-nav__link" for="__nav_4">
+
+ <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
TypeScript and JavaScript API
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="TypeScript and JavaScript API" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
TypeScript and JavaScript API
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_3" type="checkbox" id="__nav_4_3" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
+
- <label class="md-nav__link" for="__nav_4_3">
+ <label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
Components
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Components" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Components
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../javascript/components_google_maps/" class="md-nav__link">
+ Google Maps
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../javascript/components_pagination/" class="md-nav__link">
+ Pagination
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_4" type="checkbox" id="__nav_4_4" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
- <label class="md-nav__link" for="__nav_4_4">
+
+ <label class="md-nav__link" for="__nav_4_4" id="__nav_4_4_label" tabindex="0">
New API
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="New API" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
New API
- <li class="md-nav__item">
- <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
- Data Structures
- </a>
- </li>
-
-
-
-
-
-
-
-
-
<li class="md-nav__item">
<a href="../../../javascript/new-api_core/" class="md-nav__link">
Core Functions
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+
- <label class="md-nav__link" for="__nav_5">
+ <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
Package Components
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Package Components" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Package Components
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
- <label class="md-nav__link" for="__nav_5_2">
+
+ <label class="md-nav__link" for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
PIPs
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="PIPs" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5_2">
<span class="md-nav__icon md-icon"></span>
PIPs
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" checked>
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
+
- <label class="md-nav__link" for="__nav_6">
+ <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
Migration
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Migration" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Migration
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" checked>
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_1" checked>
+
- <label class="md-nav__link" for="__nav_6_1">
+ <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
From WoltLab Suite 5.5
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 5.5" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_1">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 5.5
<li class="md-nav__item md-nav__item--active">
- <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
Request-specific logic will no longer happen during boot
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#bootstrap-scripts" class="md-nav__link">
+ Bootstrap Scripts
+ </a>
+
+ <nav class="md-nav" aria-label="Bootstrap Scripts">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#registering-ievent-listeners" class="md-nav__link">
+ Registering IEvent listeners
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#request-processing" class="md-nav__link">
+ Request Processing
+ </a>
+
+ <nav class="md-nav" aria-label="Request Processing">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#recommended-changes-for-woltlab-suite-60" class="md-nav__link">
+ Recommended changes for WoltLab Suite 6.0
+ </a>
+
+ <nav class="md-nav" aria-label="Recommended changes for WoltLab Suite 6.0">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#querying-requesthandlerinterface-based-controllers-via-javascript" class="md-nav__link">
+ Querying RequestHandlerInterface-based controllers via JavaScript
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#formbuilder" class="md-nav__link">
+ FormBuilder
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#example" class="md-nav__link">
+ Example
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
<nav class="md-nav" aria-label="Package System">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#required-minversion-for-required-packages" class="md-nav__link">
+ Required “minversion” for required packages
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#rejection-of-pl-versions" class="md-nav__link">
Rejection of “pl” versions
<nav class="md-nav" aria-label="Package Installation Plugins">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#eventlistener" class="md-nav__link">
+ EventListener
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#cronjob" class="md-nav__link">
+ Cronjob
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#database" class="md-nav__link">
Database
</ul>
</nav>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#internationalization" class="md-nav__link">
+ Internationalization
+ </a>
+
</li>
<li class="md-nav__item">
Indicating parameters that hold sensitive information
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#conditions" class="md-nav__link">
+ Conditions
+ </a>
+
+ <nav class="md-nav" aria-label="Conditions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#abstractintegercondition" class="md-nav__link">
+ AbstractIntegerCondition
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#rebuild-workers" class="md-nav__link">
+ Rebuild Workers
+ </a>
+
</li>
</ul>
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_2" >
- <label class="md-nav__link" for="__nav_6_2">
+
+ <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
From WoltLab Suite 5.4
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 5.4" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_2">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 5.4
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" >
+
- <label class="md-nav__link" for="__nav_6_3">
+ <label class="md-nav__link" for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
From WoltLab Suite 5.3
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 5.3" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_3">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 5.3
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
- <label class="md-nav__link" for="__nav_6_4">
+
+ <label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
From WoltLab Suite 5.2
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 5.2" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_4">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 5.2
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
+
- <label class="md-nav__link" for="__nav_6_5">
+ <label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
From WoltLab Suite 3.1
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 3.1" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_5">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 3.1
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_6" type="checkbox" id="__nav_6_6" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_6" >
+
- <label class="md-nav__link" for="__nav_6_6">
+ <label class="md-nav__link" for="__nav_6_6" id="__nav_6_6_label" tabindex="0">
From WoltLab Suite 3.0
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WoltLab Suite 3.0" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_6">
<span class="md-nav__icon md-icon"></span>
From WoltLab Suite 3.0
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_7" type="checkbox" id="__nav_6_7" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_7" >
- <label class="md-nav__link" for="__nav_6_7">
+
+ <label class="md-nav__link" for="__nav_6_7" id="__nav_6_7_label" tabindex="0">
From WCF 2.1
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="From WCF 2.1" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6_7">
<span class="md-nav__icon md-icon"></span>
From WCF 2.1
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
+
- <label class="md-nav__link" for="__nav_7">
+ <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Tutorials
<li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_1" >
- <label class="md-nav__link" for="__nav_7_1">
+
+ <label class="md-nav__link" for="__nav_7_1" id="__nav_7_1_label" tabindex="0">
Tutorial Series
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7_1">
<span class="md-nav__icon md-icon"></span>
Tutorial Series
Request-specific logic will no longer happen during boot
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#bootstrap-scripts" class="md-nav__link">
+ Bootstrap Scripts
+ </a>
+
+ <nav class="md-nav" aria-label="Bootstrap Scripts">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#registering-ievent-listeners" class="md-nav__link">
+ Registering IEvent listeners
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#request-processing" class="md-nav__link">
+ Request Processing
+ </a>
+
+ <nav class="md-nav" aria-label="Request Processing">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#recommended-changes-for-woltlab-suite-60" class="md-nav__link">
+ Recommended changes for WoltLab Suite 6.0
+ </a>
+
+ <nav class="md-nav" aria-label="Recommended changes for WoltLab Suite 6.0">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#querying-requesthandlerinterface-based-controllers-via-javascript" class="md-nav__link">
+ Querying RequestHandlerInterface-based controllers via JavaScript
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#formbuilder" class="md-nav__link">
+ FormBuilder
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#example" class="md-nav__link">
+ Example
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
<nav class="md-nav" aria-label="Package System">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#required-minversion-for-required-packages" class="md-nav__link">
+ Required “minversion” for required packages
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#rejection-of-pl-versions" class="md-nav__link">
Rejection of “pl” versions
<nav class="md-nav" aria-label="Package Installation Plugins">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#eventlistener" class="md-nav__link">
+ EventListener
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#cronjob" class="md-nav__link">
+ Cronjob
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#database" class="md-nav__link">
Database
</ul>
</nav>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#internationalization" class="md-nav__link">
+ Internationalization
+ </a>
+
</li>
<li class="md-nav__item">
Indicating parameters that hold sensitive information
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#conditions" class="md-nav__link">
+ Conditions
+ </a>
+
+ <nav class="md-nav" aria-label="Conditions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#abstractintegercondition" class="md-nav__link">
+ AbstractIntegerCondition
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#rebuild-workers" class="md-nav__link">
+ Rebuild Workers
+ </a>
+
</li>
</ul>
- <a href="https://github.com/WoltLab/docs.woltlab.com/edit/6.0/docs/migration/wsc55/php.md" title="Edit this page" class="md-content__button md-icon">
-
- <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>
- </a>
+
+
<h1 id="migrating-from-woltlab-suite-55-php">Migrating from WoltLab Suite 5.5 - PHP<a class="headerlink" href="#migrating-from-woltlab-suite-55-php" title="Permanent link">#</a></h1>
Instead of having a <code>$myObject->canView()</code> method that uses <code>WCF::getSession()</code> or <code>WCF::getUser()</code> internally, the user should explicitly be passed to the method as a parameter, allowing for permission checks to happen in a different context, for example send sending notification emails.</p>
<p>Likewise event listeners should not access these request-specific values at all, because they are unable to know whether the event was fired based on these request-specific values or whether some programmatic action fired the event for another arbitrary user.
Instead they must retrieve the appropriate information from the event data only.</p>
+<h3 id="bootstrap-scripts">Bootstrap Scripts<a class="headerlink" href="#bootstrap-scripts" title="Permanent link">#</a></h3>
+<p>WoltLab Suite 6.0 adds package-specific bootstrap scripts allowing a package to execute logic during the application boot to prepare the environment before the request is passed through the middleware pipeline into the controller in <code>RequestHandler</code>.</p>
+<p>Bootstrap scripts are stored in the <code>lib/bootstrap/</code> directory of WoltLab Suite Core with the package identifier as the file name.
+They do not need to be registered explicitly, as one future goal of the bootstrap scripts is reducing the amount of system state that needs to be stored within the database.
+Instead WoltLab Suite Core will automatically create a bootstrap loader that includes all installed bootstrap scripts as part of the package installation and uninstallation process.</p>
+<p>Bootstrap scripts will be loaded and the bootstrap functions will executed based on a topological sorting of all installed packages.
+A package can rely on all bootstrap scripts of its dependencies being loaded before its own bootstrap script is loaded.
+It can also rely on all bootstrap functions of its dependencies having executed before its own bootstrap functions is executed.
+However it cannot rely on any specific loading and execution order of non-dependencies.</p>
+<p>As hinted at in the previous paragraph, executing the bootstrap scripts happens in two phases:</p>
+<ol>
+<li>All bootstrap scripts will be <code>include()</code>d in topological order. The script is expected to return a <code>Closure</code> that is executed in phase 2.</li>
+<li>Once all bootstrap scripts have been included, the returned <code>Closure</code>s will be executed in the same order the bootstrap scripts were loaded.</li>
+</ol>
+<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/bootstrap/com.example.foo.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span>
+<span class="normal">5</span>
+<span class="normal">6</span>
+<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
+<span class="c1">// Phase (1).</span>
+
+<span class="k">return</span> <span class="k">static</span> <span class="k">function</span> <span class="p">()</span><span class="o">:</span> <span class="nx">void</span> <span class="p">{</span>
+ <span class="c1">// Phase (2).</span>
+<span class="p">};</span>
+</code></pre></div></td></tr></table></div>
+<p>For the vast majority of packages it is expected that the phase (1) bootstrapping is not used, except to return the <code>Closure</code>.
+Instead the logic should reside in the <code>Closure</code>s body that is executed in phase (2).</p>
+<h4 id="registering-ievent-listeners">Registering <code>IEvent</code> listeners<a class="headerlink" href="#registering-ievent-listeners" title="Permanent link">#</a></h4>
+<p>An example use case for bootstrap scripts with WoltLab Suite 6.0 is registering event listeners for <code>IEvent</code>-based events that <a href="../../wsc54/php/#events">were added with WoltLab Suite 5.5</a>, instead of using the <a href="../../../package/pip/event-listener/">eventListener PIP</a>.
+Registering event listeners within the bootstrap script allows you to leverage your IDE’s autocompletion for class names and and prevents forgetting the explicit uninstallation of old event listeners during a package upgrade.</p>
+<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/bootstrap/com.example.bar.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
+<span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">wcf\system\event\listener\ValueDumpListener</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">wcf\system\foo\event\ValueAvailable</span><span class="p">;</span>
+
+<span class="k">return</span> <span class="k">static</span> <span class="k">function</span> <span class="p">()</span><span class="o">:</span> <span class="nx">void</span> <span class="p">{</span>
+ <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">register</span><span class="p">(</span>
+ <span class="nx">ValueAvailable</span><span class="o">::</span><span class="na">class</span><span class="p">,</span>
+ <span class="nx">ValueDumpListener</span><span class="o">::</span><span class="na">class</span>
+ <span class="p">);</span>
+
+ <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">()</span><span class="o">-></span><span class="na">register</span><span class="p">(</span>
+ <span class="nx">ValueAvailable</span><span class="o">::</span><span class="na">class</span><span class="p">,</span>
+ <span class="k">static</span> <span class="k">function</span> <span class="p">(</span><span class="nx">ValueAvailable</span> <span class="nv">$event</span><span class="p">)</span><span class="o">:</span> <span class="nx">void</span> <span class="p">{</span>
+ <span class="c1">// For simple use cases a `Closure` instead of a class name may be used.</span>
+ <span class="nx">\var_dump</span><span class="p">(</span><span class="nv">$event</span><span class="o">-></span><span class="na">getValue</span><span class="p">());</span>
+ <span class="p">}</span>
+ <span class="p">);</span>
+<span class="p">};</span>
+</code></pre></div></td></tr></table></div>
+<h2 id="request-processing">Request Processing<a class="headerlink" href="#request-processing" title="Permanent link">#</a></h2>
+<p>As previously mentioned in the <a href="#application-boot">Application Boot</a> section, WoltLab Suite 6.0 improves support for PSR-7/PSR-15-based request processing <a href="../../wsc54/php/#initial-psr-7-support">that was initially announced with WoltLab Suite 5.5</a>.</p>
+<p>WoltLab Suite 5.5 added support for returning a PSR-7 <code>ResponseInterface</code> from a controller and recommended to migrate existing controllers based on <code>AbstractAction</code> to make use of <code>RedirectResponse</code> and <code>JsonResponse</code> instead of using <code>HeaderUtil::redirect()</code> or manually emitting JSON with appropriate headers.
+Processing the request values still used PHP’s superglobals (specifically <code>$_GET</code> and <code>$_POST</code>).</p>
+<p>WoltLab Suite 6.0 adds support for controllers based on PSR-15’s <code>RequestHandlerInterface</code>, supporting request processing based on a provided PSR-7 <code>ServerRequestInterface</code> object.</p>
+<h3 id="recommended-changes-for-woltlab-suite-60">Recommended changes for WoltLab Suite 6.0<a class="headerlink" href="#recommended-changes-for-woltlab-suite-60" title="Permanent link">#</a></h3>
+<p>It is recommended to use <code>RequestHandlerInterface</code>-based controllers whenever an <code>AbstractAction</code> would previously be used.
+Furthermore any AJAX-based logic that would previously rely on <code>AJAXProxyAction</code> combined with a method in an <code>AbstractDatabaseObjectAction</code> should also be implemented using a dedicated <code>RequestHandlerInterface</code>-based controller.
+Both <code>AbstractAction</code> and <code>AJAXProxyAction</code>-based AJAX requests should be considered soft-deprecated going forward.</p>
+<p>When creating a <code>RequestHandlerInterface</code>-based controller, care should be taken to ensure no mutable state is stored in object properties of the controller itself.
+The state of the controller object must be identical before, during and after a request was processed.
+Any required values must be passed explicitly by means of method parameters and return values.
+Likewise any functionality called by the controller’s <code>handle()</code> method should not rely on implicit global values, such as <code>WCF::getUser()</code>, as was explained in the previous <a href="#request-specific-logic-will-no-longer-happen-during-boot">section about request-specific logic</a>.</p>
+<p>The recommended pattern for a <code>RequestHandlerInterface</code>-based controller looks as follows:</p>
+<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/action/MyFancyAction.class.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span>
+<span class="normal">24</span>
+<span class="normal">25</span>
+<span class="normal">26</span>
+<span class="normal">27</span>
+<span class="normal">28</span>
+<span class="normal">29</span>
+<span class="normal">30</span>
+<span class="normal">31</span>
+<span class="normal">32</span>
+<span class="normal">33</span>
+<span class="normal">34</span>
+<span class="normal">35</span>
+<span class="normal">36</span>
+<span class="normal">37</span>
+<span class="normal">38</span>
+<span class="normal">39</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
+<span class="k">namespace</span> <span class="nx">wcf\action</span><span class="p">;</span>
+
+<span class="k">use</span> <span class="nx">Laminas\Diactoros\Response</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">Psr\Http\Message\ServerRequestInterface</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">Psr\Http\Message\ResponseInterface</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">Psr\Http\Server\RequestHandlerInterface</span><span class="p">;</span>
+
+<span class="k">final</span> <span class="k">class</span> <span class="nc">MyFancyAction</span> <span class="k">implements</span> <span class="nx">RequestHandlerInterface</span>
+<span class="p">{</span>
+ <span class="k">public</span> <span class="k">function</span> <span class="fm">__construct</span><span class="p">()</span>
+ <span class="p">{</span>
+ <span class="cm">/* 0. Explicitly register services used by the controller, to</span>
+<span class="cm"> * make dependencies explicit and to avoid accidentally using</span>
+<span class="cm"> * global state outside of a controller.</span>
+<span class="cm"> */</span>
+ <span class="p">}</span>
+
+ <span class="k">public</span> <span class="k">function</span> <span class="nf">handle</span><span class="p">(</span><span class="nx">ServerRequestInterface</span> <span class="nv">$request</span><span class="p">)</span><span class="o">:</span> <span class="nx">ResponseInterface</span>
+ <span class="p">{</span>
+ <span class="cm">/* 1. Perform permission checks and input validation. */</span>
+
+ <span class="cm">/* 2. Perform the action. The action must not rely on global state,</span>
+<span class="cm"> * but instead only on explicitly passed values. It should assume</span>
+<span class="cm"> * that permissions have already been validated by the controller,</span>
+<span class="cm"> * allowing it to be reusable programmatically.</span>
+<span class="cm"> */</span>
+
+ <span class="cm">/* 3. Perform post processing. */</span>
+
+ <span class="cm">/* 4. Prepare the response, e.g. by querying an updated object from</span>
+<span class="cm"> * the database.</span>
+<span class="cm"> */</span>
+
+ <span class="cm">/* 5. Send the response. */</span>
+ <span class="k">return</span> <span class="k">new</span> <span class="nx">Response</span><span class="p">();</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</code></pre></div></td></tr></table></div>
+<p>It is recommended to leverage <a href="../libraries/#input-validation">Valinor</a> for structural validation of input values if using the <a href="../../../php/api/form_builder/overview/">FormBuilder</a> is not a good fit, specifically for any values that are provided implicitly and are expected to be correct.
+WoltLab Suite includes a middleware that will automatically convert unhandled <code>MappingError</code>s into a response with status HTTP 400 Bad Request.</p>
+<p>XSRF validation will implicitly be performed for any request that uses a HTTP verb other than <code>GET</code>.
+Likewise any requests with a JSON body will automatically be decoded by a middleware and stored as the <code>ServerRequestInterface</code>’s parsed body.</p>
+<h4 id="querying-requesthandlerinterface-based-controllers-via-javascript">Querying RequestHandlerInterface-based controllers via JavaScript<a class="headerlink" href="#querying-requesthandlerinterface-based-controllers-via-javascript" title="Permanent link">#</a></h4>
+<p>The new <code>WoltLabSuite/Core/Ajax/Backend</code> module may be used to easily query a <code>RequestHandlerInterface</code>-based controller.
+The JavaScript code must not make any assumptions about the URI structure to reach the controller.
+Instead the endpoint must be generated using <code>LinkHandler</code> and explicitly provided, e.g. by storing it in a <code>data-endpoint</code> attribute:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="x"><button</span>
+<span class="x"> class="button fancyButton"</span>
+<span class="x"> data-endpoint="</span><span class="cp">{</span><span class="nf">link</span> <span class="na">controller</span><span class="o">=</span><span class="s1">'MyFancy'</span><span class="cp">}{</span><span class="nf">/link</span><span class="cp">}</span><span class="x">"</span>
+<span class="x">>Click me!</button></span>
+</code></pre></div></td></tr></table></div>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span>
+<span class="normal">5</span>
+<span class="normal">6</span>
+<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="kd">const</span><span class="w"> </span><span class="nx">button</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">document</span><span class="p">.</span><span class="nx">querySelector</span><span class="p">(</span><span class="s1">'.fancyButton'</span><span class="p">);</span>
+<span class="nx">button</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span><span class="w"> </span><span class="k">async</span><span class="w"> </span><span class="p">(</span><span class="nx">event</span><span class="p">)</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="p">{</span>
+<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">request</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">prepareRequest</span><span class="p">(</span><span class="nx">button</span><span class="p">.</span><span class="nx">dataset</span><span class="p">.</span><span class="nx">endpoint</span><span class="p">)</span>
+<span class="w"> </span><span class="p">.</span><span class="nx">get</span><span class="p">();</span><span class="w"> </span><span class="c1">// or: .post(…)</span>
+
+<span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">request</span><span class="p">.</span><span class="nx">fetchAsResponse</span><span class="p">();</span><span class="w"> </span><span class="c1">// or: .fetchAsJson()</span>
+<span class="p">});</span>
+</code></pre></div></td></tr></table></div>
+<h4 id="formbuilder">FormBuilder<a class="headerlink" href="#formbuilder" title="Permanent link">#</a></h4>
+<p>The <code>Psr15DialogForm</code> class combined with the <code>usingFormBuilder()</code> method of <a href="../dialogs/"><code>dialogFactory()</code></a> provides a “batteries-included” solution to create a AJAX- and <a href="../../../php/api/form_builder/overview/">FormBuilder</a>-based <code>RequestHandlerInterface</code>-based controller.</p>
+<p>Within the JavaScript code the endpoint is queried using:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="kd">const</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">ok</span><span class="p">,</span><span class="w"> </span><span class="nx">result</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">dialogFactory</span><span class="p">()</span>
+<span class="w"> </span><span class="p">.</span><span class="nx">usingFormBuilder</span><span class="p">()</span>
+<span class="w"> </span><span class="p">.</span><span class="nx">fromEndpoint</span><span class="p">(</span><span class="nx">url</span><span class="p">);</span>
+</code></pre></div></td></tr></table></div>
+<p>The returned <code>Promise</code> will resolve when the dialog is closed, either by successfully submitting the form or by manually closing it and thus aborting the process.
+If the form was submitted successfully <code>ok</code> will be <code>true</code> and <code>result</code> will contain the controller’s response.
+If the dialog was closed without successfully submitting the form, <code>ok</code> will be <code>false</code> and <code>result</code> will be set to <code>undefined</code>.</p>
+<p>Within the PHP code, the form may be created as usual, but use <code>Psr15DialogForm</code> as the form document.
+The controller must return <code>$dialogForm->toJsonResponse()</code> for <code>GET</code> requests and validate the <code>ServerRequestInterface</code> using <code>$dialogForm->validateRequest($request)</code> for <code>POST</code> requests.
+The latter will return a <code>ResponseInterface</code> to be returned if the validation fails, otherwise <code>null</code> is returned.
+If validation succeeded, the controller must perform the resulting action and return a <code>JsonResponse</code> with the <code>result</code> key:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span>
+<span class="normal">13</span>
+<span class="normal">14</span>
+<span class="normal">15</span>
+<span class="normal">16</span>
+<span class="normal">17</span>
+<span class="normal">18</span>
+<span class="normal">19</span>
+<span class="normal">20</span>
+<span class="normal">21</span>
+<span class="normal">22</span>
+<span class="normal">23</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">if</span> <span class="p">(</span><span class="nv">$request</span><span class="o">-></span><span class="na">getMethod</span><span class="p">()</span> <span class="o">===</span> <span class="s1">'GET'</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nv">$dialogForm</span><span class="o">-></span><span class="na">toResponse</span><span class="p">();</span>
+<span class="p">}</span> <span class="k">elseif</span> <span class="p">(</span><span class="nv">$request</span><span class="o">-></span><span class="na">getMethod</span><span class="p">()</span> <span class="o">===</span> <span class="s1">'POST'</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nv">$response</span> <span class="o">=</span> <span class="nv">$dialogForm</span><span class="o">-></span><span class="na">validateRequest</span><span class="p">(</span><span class="nv">$request</span><span class="p">);</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nv">$response</span> <span class="o">!==</span> <span class="k">null</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nv">$response</span><span class="p">;</span>
+ <span class="p">}</span>
+
+ <span class="nv">$data</span> <span class="o">=</span> <span class="nv">$dialogForm</span><span class="o">-></span><span class="na">getData</span><span class="p">();</span>
+
+ <span class="c1">// Use $data.</span>
+
+ <span class="k">return</span> <span class="k">new</span> <span class="nx">JsonResponse</span><span class="p">([</span>
+ <span class="s1">'result'</span> <span class="o">=></span> <span class="p">[</span>
+ <span class="s1">'some'</span> <span class="o">=></span> <span class="s1">'value'</span><span class="p">,</span>
+ <span class="p">],</span>
+ <span class="p">]);</span>
+<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="c1">// The used method is validated by a middleware. Methods that are not</span>
+ <span class="c1">// GET or POST need to be explicitly allowed using the 'AllowHttpMethod'</span>
+ <span class="c1">// attribute.</span>
+ <span class="k">throw</span> <span class="k">new</span> <span class="nx">\LogicException</span><span class="p">(</span><span class="s1">'Unreachable'</span><span class="p">);</span>
+<span class="p">}</span>
+</code></pre></div></td></tr></table></div>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h4>
+<p>A complete example, showcasing all the patterns can be found in <a href="https://github.com/WoltLab/WCF/pull/5106">WoltLab/WCF#5106</a>.
+This example showcases how to:</p>
+<ul>
+<li>Store used services within the controller’s constructor.</li>
+<li>Perform validation of inputs using Valinor.</li>
+<li>Perform permission checks.</li>
+<li>Use the FormBuilder.</li>
+<li>Delegate the actual processing to a reusable command that does not rely on global state.</li>
+<li>Store the request endpoint as a <code>data-*</code> attribute.</li>
+</ul>
<h2 id="package-system">Package System<a class="headerlink" href="#package-system" title="Permanent link">#</a></h2>
+<h3 id="required-minversion-for-required-packages">Required “minversion” for required packages<a class="headerlink" href="#required-minversion-for-required-packages" title="Permanent link">#</a></h3>
+<p>The <code>minversion</code> attribute of the <code><requiredpackage></code> tag is now required.</p>
<h3 id="rejection-of-pl-versions">Rejection of “pl” versions<a class="headerlink" href="#rejection-of-pl-versions" title="Permanent link">#</a></h3>
<p>Woltlab Suite 6.0 no longer accepts package versions with the “pl” suffix as valid.</p>
<h3 id="removal-of-api-compatibility">Removal of API compatibility<a class="headerlink" href="#removal-of-api-compatibility" title="Permanent link">#</a></h3>
Furthermore any packages without an explicit requirement for <code>com.woltlab.wcf</code> in at least version <code>5.4.22</code> are also assumed to not have been updated for WoltLab Suite 6.0 and will also be rejected.
The latter check is intended to reject old and most likely incompatible packages where the author forgot to add either an <code><excludedpackage></code> or a <code><compatibility></code> tag before releasing it.</p>
<h3 id="package-installation-plugins">Package Installation Plugins<a class="headerlink" href="#package-installation-plugins" title="Permanent link">#</a></h3>
+<h4 id="eventlistener">EventListener<a class="headerlink" href="#eventlistener" title="Permanent link">#</a></h4>
+<p>Installing unnamed event listeners is no longer supported.
+The <code>name</code> attribute needs to be specified for all event listeners.</p>
+<p>Deleting unnamed event listeners still is possible to allow for a clean migration of existing listeners.</p>
+<h4 id="cronjob">Cronjob<a class="headerlink" href="#cronjob" title="Permanent link">#</a></h4>
+<p>Installing unnamed cronjobs is no longer supported.
+The <code>name</code> attribute needs to be specified for all event listeners.</p>
+<p>Deleting unnamed cronjobs still is possible to allow for a clean migration of existing cronjobs.</p>
+<p>The cronjob PIP now supports the <code><expression></code> element, allowing to define the cronjob schedule using a full expression instead of specifying the five elements separately.</p>
<h4 id="database">Database<a class="headerlink" href="#database" title="Permanent link">#</a></h4>
<p>The <code>$name</code> parameter of <code>DatabaseTableIndex::create()</code> is no longer optional.
Relying on the auto-generated index name is strongly discouraged, because of unfixable inconsistent behavior between the SQL PIP and the PHP DDL API.
<p>The autogenerated name can still be requested by passing an empty string as the <code>$name</code>.
This should only be done for backwards compatibility purposes and to migrate an index with an autogenerated name to an index with an explicit name.
An example script can be found in <a href="https://github.com/WoltLab/com.woltlab.wcf.conversation/commit/a33677ca051f76e1ddda1de7f8dc62a5484de16e">WoltLab/com.woltlab.wcf.conversation@a33677ca051f</a>.</p>
+<h2 id="internationalization">Internationalization<a class="headerlink" href="#internationalization" title="Permanent link">#</a></h2>
+<p>WoltLab Suite 6.0 <a href="#minimum-requirements">increases the System Requirements</a> to require <a href="https://www.php.net/manual/en/book.intl.php">PHP’s intl extension</a> to be installed and enabled, allowing you to rely on the functionality provided by it to better match the rules and conventions of the different languages and regions of the world.</p>
+<p>One example would be the formatting of numbers.
+WoltLab Suite included a feature to group digits within large numbers since early versions using the <code>StringUtil::addThousandsSeparator()</code> method.
+While this method was able to account for <em>some</em> language-specific differences, e.g. by selecting an appropriate separator character based on a phrase, it failed to account for all the differences in number formatting across countries and cultures.</p>
+<p>As an example, English as written in the United States of America uses commas to create groups of three digits within large numbers: 123,456,789.
+English as written in India on the other hand also uses commas, but digits are not grouped into groups of three.
+Instead the right-most three digits form a group and then another comma is added every <em>two</em> digits: 12,34,56,789.</p>
+<p>Another example would be German as used within Germany and Switzerland.
+While both countries use groups of three, the separator character differs.
+Germany uses a dot (123.456.789), whereas Switzerland uses an apostrophe (123’456’789).
+The correct choice of separator could already be configured using the afore-mentioned phrase, but this is both inconvenient and fails to account for other differences between the two countries.
+It also made it hard to keep the behavior up to date when rules change.</p>
+<p>PHP’s intl extension on the other hand builds on the official Unicode rules, by relying on the ICU library published by the Unicode consortium.
+As such it is aware of the rules of all relevant languages and regions of the world and it is already kept up to date by the operating system’s package manager.</p>
+<p>For the four example regions (en_US, en_IN, de_DE, de_CH) intl’s <code>NumberFormatter</code> class will format the number 123456789 as follows, correctly implementing the rules:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span>
+<span class="normal">5</span>
+<span class="normal">6</span>
+<span class="normal">7</span>
+<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><code>php > var_dump((new NumberFormatter('en_US', \NumberFormatter::DEFAULT_STYLE))->format(123_456_789));
+string(11) "123,456,789"
+php > var_dump((new NumberFormatter('en_IN', \NumberFormatter::DEFAULT_STYLE))->format(123_456_789));
+string(12) "12,34,56,789"
+php > var_dump((new NumberFormatter('de_DE', \NumberFormatter::DEFAULT_STYLE))->format(123_456_789));
+string(11) "123.456.789"
+php > var_dump((new NumberFormatter('de_CH', \NumberFormatter::DEFAULT_STYLE))->format(123_456_789));
+string(15) "123’456’789"
+</code></pre></div></td></tr></table></div>
+<p>WoltLab Suite’s <code>StringUtil::formatNumeric()</code> method is updated to leverage the <code>NumberFormatter</code> internally.
+However your package might have special requirements regarding formatting, for example when formatting currencies where the position of the currency symbol differs across languages.
+In those cases your package should manually create an appropriately configured class from Intl’s feature set.
+The correct locale can be queried by the new <code>Language::getLocale()</code> method.</p>
+<p>Another use case that showcases the <code>Language::getLocale()</code> method might be localizing a country name using <a href="https://www.php.net/manual/en/locale.getdisplayregion.php"><code>locale_get_display_region()</code></a>:</p>
+<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span><code>php > var_dump(\wcf\system\WCF::getLanguage()->getLocale());
+string(5) "en_US"
+php > var_dump(locale_get_display_region('_DE', \wcf\system\WCF::getLanguage()->getLocale()));
+string(7) "Germany"
+php > var_dump(locale_get_display_region('_US', \wcf\system\WCF::getLanguage()->getLocale()));
+string(13) "United States"
+php > var_dump(locale_get_display_region('_IN', \wcf\system\WCF::getLanguage()->getLocale()));
+string(5) "India"
+php > var_dump(locale_get_display_region('_BR', \wcf\system\WCF::getLanguage()->getLocale()));
+string(6) "Brazil"
+</code></pre></div></td></tr></table></div>
+<p>See <a href="https://github.com/WoltLab/WCF/pull/5048">WoltLab/WCF#5048</a> for details.</p>
<h2 id="indicating-parameters-that-hold-sensitive-information">Indicating parameters that hold sensitive information<a class="headerlink" href="#indicating-parameters-that-hold-sensitive-information" title="Permanent link">#</a></h2>
<p>PHP 8.2 adds native support for redacting parameters holding sensitive information in stack traces.
Parameters with the <code>#[\SensitiveParameter]</code> attribute will show a placeholder value within the stack trace and the error log.</p>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">function</span> <span class="nf">checkPassword</span><span class="p">(</span>
- <span class="c1">#[\SensitiveParameter]</span>
+ <span class="p">#[</span><span class="nd">\SensitiveParameter</span><span class="p">]</span>
<span class="nv">$password</span><span class="p">,</span>
<span class="p">)</span><span class="o">:</span> <span class="nx">bool</span> <span class="p">{</span>
<span class="c1">// …</span>
<span class="p">}</span>
</code></pre></div></td></tr></table></div>
<p>See the <a href="https://wiki.php.net/rfc/redact_parameters_in_back_traces">PHP RFC: Redacting parameters in back traces</a> for more details.</p>
+<h2 id="conditions">Conditions<a class="headerlink" href="#conditions" title="Permanent link">#</a></h2>
+<h3 id="abstractintegercondition">AbstractIntegerCondition<a class="headerlink" href="#abstractintegercondition" title="Permanent link">#</a></h3>
+<p>Deriving from <code>AbstractIntegerCondition</code> now requires to explicitly implement <code>protected function getIdentifier(): string</code>, instead of setting the <code>$identifier</code> property.
+This is to ensure that all conditions specify a unique identifier, instead of accidentally relying on a default value.
+The <code>$identifier</code> property will no longer be used and may be removed.</p>
+<p>See <a href="https://github.com/WoltLab/WCF/pull/5077">WoltLab/WCF#5077</a> for details.</p>
+<h2 id="rebuild-workers">Rebuild Workers<a class="headerlink" href="#rebuild-workers" title="Permanent link">#</a></h2>
+<p>Rebuild workers should no longer be registered using the <code>com.woltlab.wcf.rebuildData</code> object type definition.
+You can attach an event listener to the <code>wcf\system\worker\event\RebuildWorkerCollecting</code> event inside a <a href="#bootstrap-scripts">bootstrap script</a> to lazily register workers.
+The class name of the worker is registered using the event’s <code>register()</code> method:</p>
+<div class="highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">files/lib/bootstrap/com.example.bar.php</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 1</span>
+<span class="normal"> 2</span>
+<span class="normal"> 3</span>
+<span class="normal"> 4</span>
+<span class="normal"> 5</span>
+<span class="normal"> 6</span>
+<span class="normal"> 7</span>
+<span class="normal"> 8</span>
+<span class="normal"> 9</span>
+<span class="normal">10</span>
+<span class="normal">11</span>
+<span class="normal">12</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="o"><?</span><span class="nx">php</span>
+
+<span class="k">use</span> <span class="nx">wcf\system\event\EventHandler</span><span class="p">;</span>
+<span class="k">use</span> <span class="nx">wcf\system\worker\event\RebuildWorkerCollecting</span><span class="p">;</span>
+
+<span class="k">return</span> <span class="k">static</span> <span class="k">function</span> <span class="p">()</span><span class="o">:</span> <span class="nx">void</span> <span class="p">{</span>
+ <span class="nv">$eventHandler</span> <span class="o">=</span> <span class="nx">EventHandler</span><span class="o">::</span><span class="na">getInstance</span><span class="p">();</span>
+
+ <span class="nv">$eventHandler</span><span class="o">-></span><span class="na">register</span><span class="p">(</span><span class="nx">RebuildWorkerCollecting</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="k">static</span> <span class="k">function</span> <span class="p">(</span><span class="nx">RebuildWorkerCollecting</span> <span class="nv">$event</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nv">$event</span><span class="o">-></span><span class="na">register</span><span class="p">(</span><span class="nx">\bar\system\worker\BazWorker</span><span class="o">::</span><span class="na">class</span><span class="p">,</span> <span class="mi">0</span><span class="p">);</span>
+ <span class="p">});</span>
+<span class="p">};</span>
+</code></pre></div></td></tr></table></div>
<hr>
<div class="md-source-file">
<small>
Last update:
- 2022-10-24
+ 2023-02-24
</small>
</div>
<footer class="md-footer">
-
- <nav class="md-footer__inner md-grid" aria-label="Footer" >
-
-
- <a href="../../../package/database-php-api/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Database PHP API" rel="prev">
- <div class="md-footer__button md-icon">
- <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>
- </div>
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Previous
- </span>
- Database PHP API
- </div>
- </div>
- </a>
-
-
-
- <a href="../javascript/" class="md-footer__link md-footer__link--next" aria-label="Next: TypeScript and JavaScript" rel="next">
- <div class="md-footer__title">
- <div class="md-ellipsis">
- <span class="md-footer__direction">
- Next
- </span>
- TypeScript and JavaScript
- </div>
- </div>
- <div class="md-footer__button md-icon">
- <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>
- </div>
- </a>
-
- </nav>
-
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "version": {"provider": "mike"}}</script>
+ <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.tracking"], "search": "../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
- <script src="../../../assets/javascripts/bundle.8492ddcf.min.js"></script>
+ <script src="../../../assets/javascripts/bundle.51198bba.min.js"></script>
</body>
projects / GitHub / WoltLab / woltlab.github.io.git / blobdiff