Document `IPatternFormField` (#120)
authorMatthias Schmidt <gravatronics@live.com>
Fri, 15 Jan 2021 11:04:42 +0000 (12:04 +0100)
committerGitHub <noreply@github.com>
Fri, 15 Jan 2021 11:04:42 +0000 (12:04 +0100)
docs/php/api/form_builder-form_fields.md
docs/php/api/form_builder-structure.md

index 5c0d0e2676c8ca7499407422600d3f91881f417a..2832c69d73fd06604669b68a86ddfa34c87fd00a 100644 (file)
@@ -166,7 +166,7 @@ If the field is nullable and the current form field value is considered `empty`
 ### `TextFormField`
 
 `TextFormField` is a form field that allows entering a single line of text.
-The class implements `IImmutableFormField`, `II18nFormField`, `IMaximumLengthFormField`, `IMinimumLengthFormField`, and `IPlaceholderFormField`.
+The class implements `IImmutableFormField`, `II18nFormField`, `IMaximumLengthFormField`, `IMinimumLengthFormField`, `IPatternFormField`, and `IPlaceholderFormField`.
 
 
 ### `TitleFormField`
index adfe1cf02256c08ddc5fce8e55b758979b0924ca..c25d45dad27b07133d88156bc98f1b431364d990 100644 (file)
@@ -362,6 +362,13 @@ The implementing class has to implement the methods `packageIDs(array $packageID
 `TPackagesFormField` provides a default implementation of these two methods.
 
 
+#### `IPatternFormField`
+
+`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.
+
+
 #### `IPlaceholderFormField`
 
 `IPlaceholderFormField` has to be implemented by form fields that support a placeholder value for empty fields.