Document new `MultipleBoardSelectionFormField` (#196)

See WoltLab/com.woltlab.wbb#478

diff --git a/docs/migration/wsc54/php.md b/docs/migration/wsc54/php.md
index b07638ed7b13bc0dfa248359a465b15b5bde93db..fb878ebac5a4ffb7ee5dc45ab76d94fc48dcddfa 100644 (file)
--- a/docs/migration/wsc54/php.md
+++ b/docs/migration/wsc54/php.md
@@ -162,3 +162,4 @@ While these runtime caches are only available since version 5.5, the viewable li
 ## Miscellaneous Additions
 
 - [`ValueIntervalFormFieldDependency`](../../php/api/form_builder/dependencies.md#valueintervalformfielddependency)
+- [`MultipleBoardSelectionFormField`](../../php/api/form_builder/form_fields/#multipleboardselectionformfield)

diff --git a/docs/php/api/form_builder/form_fields.md b/docs/php/api/form_builder/form_fields.md
index 4d22d08b5e609ad9f5d74b8b2c57ec6e81d33ba0..33e1207af6c8dc3ecbfb4fd9c856526f2ba471fc 100644 (file)
--- a/docs/php/api/form_builder/form_fields.md
+++ b/docs/php/api/form_builder/form_fields.md
@@ -437,6 +437,30 @@ This trait provides `getWysiwygId()` and `wysiwygId($wysiwygId)` to get and set
 
 
 
+## Application-Specific Form Fields
+
+### WoltLab Suite Forum
+
+#### `MultipleBoardSelectionFormField`
+
+!!! info "Only available since version 5.5."
+
+`MultipleBoardSelectionFormField` is used to select multiple forums.
+The class implements `IAttributeFormField`, `ICssClassFormField`, and `IImmutableFormField`.
+
+The field supports additional settings:
+
+- `boardNodeList(BoardNodeList $boardNodeList): self` and `getBoardNodeList(): BoardNodeList` are used to set and get the list of board nodes used to render the board selection.
+  `boardNodeList(BoardNodeList $boardNodeList): self` will automatically call `readNodeTree()` on the given board node list.
+- `categoriesSelectable(bool $categoriesSelectable = true): self` and `areCategoriesSelectable(): bool` are used to set and check if the categories in the board node list are selectable.
+  By default, categories are selectable.
+  This option is useful if only actual boards, in which threads can be posted, should be selectable but the categories must still be shown so that the overall forum structure is still properly shown.
+- `supportExternalLinks(bool $supportExternalLinks): self` and `supportsExternalLinks(): bool` are used to set and check if external links will be shown in the selection list.
+  By default, external links are shown.
+  Like in the example given before, in cases where only actual boards, in which threads can be posted, are relevant, this option allows to exclude external links.
+
+
+
 ## Single-Use Form Fields
 
 The following form fields are specific for certain forms and hardly reusable in other contexts.