Document `CurrencyFormField`
authorMarcel Werk <burntime@woltlab.com>
Thu, 25 Apr 2024 12:42:01 +0000 (14:42 +0200)
committerMarcel Werk <burntime@woltlab.com>
Thu, 25 Apr 2024 12:42:01 +0000 (14:42 +0200)
Closes #423

docs/php/api/form_builder/form_fields.md

index 7e58873d88d1d6801344b77d5a7c7163c4e9a20e..039048bbc0f09fb479437f45f149170074157e27 100644 (file)
@@ -59,6 +59,19 @@ The class implements `IAttributeFormField`, `IAutoFocusFormField`, `ICssClassFor
 Additionally, the default id of a `ClassNameFormField` object is `className`, the default label is `wcf.form.field.className`, and if either an interface or a parent class is required, a default description is set if no description has already been set (`wcf.form.field.className.description.interface` and `wcf.form.field.className.description.parentClass`, respectively).
 
 
+### `CurrencyFormField`
+
+`CurrencyFormField` is an implementation designed for two-decimal currencies like EUR or USD. The API expect amounts to be provided in the smallest unit. For example, to set a value to 10 USD, provide an amount value of 1000 (i.e., 1000 cents).
+
+Example:
+
+```php
+CurrencyFormField::create('name')
+  ->currency('USD')
+  ->value(1000); // = USD 10
+```
+
+
 ### `DateFormField`
 
 `DateFormField` is a form field to enter a date (and optionally a time).