Mark since when new form builder features are available
authorMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jan 2021 15:54:17 +0000 (16:54 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jan 2021 15:54:17 +0000 (16:54 +0100)
docs/php/api/form_builder/form_fields.md
docs/php/api/form_builder/structure.md

index 892bb28bd99cf87530a1ace58ec047dd1f6b418f..a54843de6fadb3c9619ec63367c64db460761261 100644 (file)
@@ -32,7 +32,9 @@ Objects of this class require a label.
 The return value of `getSaveValue()` is the integer representation of the boolean value, i.e. `0` or `1`.
 
 
-### <span class="label label-info">5.3.2+</span> `CheckboxFormField`
+### `CheckboxFormField`
+
+!!! info "Only available since version 5.3.2."
 
 `CheckboxFormField` extends `BooleanFormField` and offers a simple HTML checkbox.
 
@@ -283,6 +285,8 @@ The relevant `UserProfile` objects can be accessed via the `getUsers()` method.
 
 ### `UserPasswordField`
 
+!!! info "Only available since version 5.4."
+
 `UserPasswordField` is a form field for users' to enter their current password.
 The class implements `IAttributeFormField`, `IAutoCompleteFormField`, `IAutoFocusFormField`, and `IPlaceholderFormField`
 
index 29be4d4a684a45f1f6ab8a47560d0e4e716887be..a1d7e3447be64f002f36ee325945a81be68861f8 100644 (file)
@@ -155,7 +155,7 @@ WoltLab Suite provides a default implementation with the `FormDocument` class.
   If the form contains a `IFileFormField`, `multipart/form-data` is returned, otherwise `null` is returned.
 - `loadValues(array $data, IStorableObject $object)` is used when editing an existing object to set the form field values by calling `IFormField::loadValue()` for all form fields.
   Additionally, the form mode is set to `IFormDocument::FORM_MODE_UPDATE`.
-- `markRequiredFields(bool $markRequiredFields = true): self` and `marksRequiredFields(): bool` can be used to set and check whether fields that are required are marked (with an asterisk in the label) in the output.
+- <span class="label label-info">5.4+</span> `markRequiredFields(bool $markRequiredFields = true): self` and `marksRequiredFields(): bool` can be used to set and check whether fields that are required are marked (with an asterisk in the label) in the output.
 - `method($method)` and `getMethod()` can be used to set and get the `method` attribute of the `<form>` HTML element.
   By default, the method is `post`.
 - `prefix($prefix)` and `getPrefix()` can be used to set and get a global form prefix that is prepended to form elements’ names and ids to avoid conflicts with other forms.
@@ -247,6 +247,8 @@ WoltLab Suite Core provides a variety of interfaces and matching traits with def
 
 #### `IAutoCompleteFormField`
 
+!!! info "Only available since version 5.4."
+
 `IAutoCompleteFormField` has to be implemented by form fields that support the [`autocomplete` attribute](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute).
 The implementing class has to implement the methods `autoComplete(?string $autoComplete): self` and `getAutoComplete(): ?string`, which are used to set and get the autocomplete value, respectively.
 `TAutoCompleteFormField` provides a default implementation of these two methods and `TTextAutoCompleteFormField` specializes the trait for text form fields.
@@ -299,6 +301,8 @@ By default, form field are mutable.
 
 #### `IInputModeFormField`
 
+!!! info "Only available since version 5.4."
+
 `IInputModeFormField` has to be implemented by form fields that support the [`inputmode` attribute](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute).
 The implementing class has to implement the methods `inputMode(?string $inputMode): self` and `getInputMode(): ?string`, which are used to set and get the input mode, respectively.
 `TInputModeFormField` provides a default implementation of these two methods.
@@ -380,6 +384,8 @@ The implementing class has to implement the methods `packageIDs(array $packageID
 
 #### `IPatternFormField`
 
+!!! info "Only available since version 5.4."
+
 `IPatternFormField` has to be implemented by form fields that support the [`pattern` attribute](https://html.spec.whatwg.org/multipage/input.html#the-pattern-attribute).
 The implementing class has to implement the methods `pattern(?string $pattern): self` and `getPattern(): ?string`, which are used to set and get the pattern, respectively.
 `TPatternFormField` provides a default implementation of these two methods.