Add option to define an unit for numeric form options

BurntimeX · BurntimeX · commit 0f7fa1fca422 · 2025-08-12T16:38:25.000+02:00
diff --git a/wcfsetup/install/files/lib/system/form/option/AbstractNumericFormOption.class.php b/wcfsetup/install/files/lib/system/form/option/AbstractNumericFormOption.class.php
@@ -43,13 +43,17 @@ public function applyFilter(DatabaseObjectList $list, string $columnName, mixed
     public function renderFilterValue(string $value, array $configuration = []): string
     {
         $values = $this->parseFilterValue($value);
+        $suffix = $this->getSuffix($configuration);
+        if ($suffix !== '') {
+            $suffix = ' ' . $suffix;
+        }
 
         if ($values['from'] && $values['to']) {
-            return $values['from'] . ' ‐ ' . $values['to'];
+            return $values['from'] . ' ‐ ' . $values['to'] . $suffix;
         } else if ($values['from']) {
-            return '>= ' . $values['from'];
+            return '>= ' . $values['from'] . $suffix;
         } else if ($values['to']) {
-            return '<= ' . $values['to'];
+            return '<= ' . $values['to'] . $suffix;
         }
 
         return '';
@@ -74,4 +78,12 @@ protected function parseFilterValue(string $value): array
             'to' => $to,
         ];
     }
+
+    /**
+     * @param array<string, mixed> $configuration
+     */
+    protected function getSuffix(array $configuration): string
+    {
+        return '';
+    }
 }
diff --git a/wcfsetup/install/files/lib/system/form/option/CurrencyFormOption.class.php b/wcfsetup/install/files/lib/system/form/option/CurrencyFormOption.class.php
@@ -9,6 +9,7 @@
 use wcf\system\form\builder\field\CurrencyFormField;
 use wcf\system\form\option\formatter\CurrencyFormatter;
 use wcf\system\form\option\formatter\IFormOptionFormatter;
+use wcf\util\StringUtil;
 
 /**
  * Implementation of a form field for currency values.
@@ -82,4 +83,14 @@ public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColum
     {
         return IntDatabaseTableColumn::create($name);
     }
+
+    #[\Override]
+    protected function getSuffix(array $configuration): string
+    {
+        if (!empty($configuration['currency'])) {
+            return StringUtil::encodeHTML($configuration['currency']);
+        }
+
+        return '';
+    }
 }
diff --git a/wcfsetup/install/files/lib/system/form/option/FloatFormOption.class.php b/wcfsetup/install/files/lib/system/form/option/FloatFormOption.class.php
@@ -8,6 +8,7 @@
 use wcf\system\form\builder\field\FloatFormField;
 use wcf\system\form\option\formatter\FloatFormatter;
 use wcf\system\form\option\formatter\IFormOptionFormatter;
+use wcf\util\StringUtil;
 
 /**
  * Implementation of a form field for float values.
@@ -42,7 +43,7 @@ public function getFormField(string $id, array $configuration = []): AbstractFor
     #[\Override]
     public function getConfigurationFormFields(): array
     {
-        return ['minFloatValue', 'maxFloatValue', 'required'];
+        return ['unit', 'minFloatValue', 'maxFloatValue', 'required'];
     }
 
     #[\Override]
@@ -62,4 +63,14 @@ public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColum
     {
         return FloatDatabaseTableColumn::create($name);
     }
+
+    #[\Override]
+    protected function getSuffix(array $configuration): string
+    {
+        if (!empty($configuration['unit'])) {
+            return StringUtil::encodeHTML($configuration['unit']);
+        }
+
+        return '';
+    }
 }
diff --git a/wcfsetup/install/files/lib/system/form/option/IntegerFormOption.class.php b/wcfsetup/install/files/lib/system/form/option/IntegerFormOption.class.php
@@ -9,6 +9,7 @@
 use wcf\system\form\builder\field\NumericRangeFormField;
 use wcf\system\form\option\formatter\IFormOptionFormatter;
 use wcf\system\form\option\formatter\IntegerFormatter;
+use wcf\util\StringUtil;
 
 /**
  * Implementation of a form field for integer values.
@@ -51,7 +52,7 @@ public function getFilterFormField(string $id, array $configuration = []): Abstr
     #[\Override]
     public function getConfigurationFormFields(): array
     {
-        return ['minIntegerValue', 'maxIntegerValue', 'required'];
+        return ['unit', 'minIntegerValue', 'maxIntegerValue', 'required'];
     }
 
     #[\Override]
@@ -71,4 +72,14 @@ public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColum
     {
         return IntDatabaseTableColumn::create($name);
     }
+
+    #[\Override]
+    protected function getSuffix(array $configuration): string
+    {
+        if (!empty($configuration['unit'])) {
+            return StringUtil::encodeHTML($configuration['unit']);
+        }
+
+        return '';
+    }
 }
diff --git a/wcfsetup/install/files/lib/system/form/option/SharedConfigurationFormFields.class.php b/wcfsetup/install/files/lib/system/form/option/SharedConfigurationFormFields.class.php
@@ -61,6 +61,9 @@ private function getDefaultFormFields(): array
             'required' => BooleanFormField::create('required')
                 ->label('wcf.form.option.shared.required')
                 ->value(false),
+            'unit' => TextFormField::create('unit')
+                ->label('wcf.form.option.shared.unit')
+                ->addFieldClass('short')
         ];
     }
 
diff --git a/wcfsetup/install/files/lib/system/form/option/formatter/FloatFormatter.class.php b/wcfsetup/install/files/lib/system/form/option/formatter/FloatFormatter.class.php
@@ -17,6 +17,11 @@ final class FloatFormatter implements IFormOptionFormatter
     #[\Override]
     public function format(string $value, int $languageID, array $configuration): string
     {
-        return StringUtil::formatNumeric(\floatval($value));
+        $suffix = '';
+        if (!empty($configuration['unit'])) {
+            $suffix = ' ' . StringUtil::encodeHTML($configuration['unit']);
+        }
+
+        return StringUtil::formatNumeric(\floatval($value)) . $suffix;
     }
 }
diff --git a/wcfsetup/install/files/lib/system/form/option/formatter/IntegerFormatter.class.php b/wcfsetup/install/files/lib/system/form/option/formatter/IntegerFormatter.class.php
@@ -17,6 +17,11 @@ final class IntegerFormatter implements IFormOptionFormatter
     #[\Override]
     public function format(string $value, int $languageID, array $configuration): string
     {
-        return StringUtil::formatNumeric(\intval($value));
+        $suffix = '';
+        if (!empty($configuration['unit'])) {
+            $suffix = ' ' . StringUtil::encodeHTML($configuration['unit']);
+        }
+
+        return StringUtil::formatNumeric(\intval($value)) . $suffix;
     }
 }
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
@@ -4176,6 +4176,7 @@ Dateianhänge:
 		<item name="wcf.form.option.shared.maxValue"><![CDATA[Maximum]]></item>
 		<item name="wcf.form.option.shared.selectOptions"><![CDATA[Auswahloptionen]]></item>
 		<item name="wcf.form.option.shared.required"><![CDATA[Das Feld muss zwingend ausgefüllt werden.]]></item>
+		<item name="wcf.form.option.shared.unit"><![CDATA[Einheit]]></item>
 		<item name="wcf.form.option.optionType"><![CDATA[Feldtyp]]></item>
 	</category>
 	<category name="wcf.image">
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
@@ -4122,6 +4122,7 @@ Attachments:
 		<item name="wcf.form.option.shared.maxValue"><![CDATA[Maximum]]></item>
 		<item name="wcf.form.option.shared.selectOptions"><![CDATA[Options]]></item>
 		<item name="wcf.form.option.shared.required"><![CDATA[This is a required field]]></item>
+		<item name="wcf.form.option.shared.unit"><![CDATA[Unit]]></item>
 		<item name="wcf.form.option.optionType"><![CDATA[Option Type]]></item>
 	</category>
 	<category name="wcf.image">

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`use wcf\system\form\builder\field\FloatFormField;`
`9`	`9`	`use wcf\system\form\option\formatter\FloatFormatter;`
`10`	`10`	`use wcf\system\form\option\formatter\IFormOptionFormatter;`
	`11`	`+use wcf\util\StringUtil;`
`11`	`12`
`12`	`13`	`/**`
`13`	`14`	`* Implementation of a form field for float values.`
`@@ -42,7 +43,7 @@ public function getFormField(string $id, array $configuration = []): AbstractFor`
`42`	`43`	`#[\Override]`
`43`	`44`	`public function getConfigurationFormFields(): array`
`44`	`45`	`{`
`45`		`- return ['minFloatValue', 'maxFloatValue', 'required'];`
	`46`	`+ return ['unit', 'minFloatValue', 'maxFloatValue', 'required'];`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`#[\Override]`
`@@ -62,4 +63,14 @@ public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColum`
`62`	`63`	`{`
`63`	`64`	`return FloatDatabaseTableColumn::create($name);`
`64`	`65`	`}`
	`66`	`+`
	`67`	`+ #[\Override]`
	`68`	`+ protected function getSuffix(array $configuration): string`
	`69`	`+ {`
	`70`	`+ if (!empty($configuration['unit'])) {`
	`71`	`+ return StringUtil::encodeHTML($configuration['unit']);`
	`72`	`+ }`
	`73`	`+`
	`74`	`+ return '';`
	`75`	`+ }`
`65`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`use wcf\system\form\builder\field\NumericRangeFormField;`
`10`	`10`	`use wcf\system\form\option\formatter\IFormOptionFormatter;`
`11`	`11`	`use wcf\system\form\option\formatter\IntegerFormatter;`
	`12`	`+use wcf\util\StringUtil;`
`12`	`13`
`13`	`14`	`/**`
`14`	`15`	`* Implementation of a form field for integer values.`
`@@ -51,7 +52,7 @@ public function getFilterFormField(string $id, array $configuration = []): Abstr`
`51`	`52`	`#[\Override]`
`52`	`53`	`public function getConfigurationFormFields(): array`
`53`	`54`	`{`
`54`		`- return ['minIntegerValue', 'maxIntegerValue', 'required'];`
	`55`	`+ return ['unit', 'minIntegerValue', 'maxIntegerValue', 'required'];`
`55`	`56`	`}`
`56`	`57`
`57`	`58`	`#[\Override]`
`@@ -71,4 +72,14 @@ public function getDatabaseTableColumn(string $name): AbstractDatabaseTableColum`
`71`	`72`	`{`
`72`	`73`	`return IntDatabaseTableColumn::create($name);`
`73`	`74`	`}`
	`75`	`+`
	`76`	`+ #[\Override]`
	`77`	`+ protected function getSuffix(array $configuration): string`
	`78`	`+ {`
	`79`	`+ if (!empty($configuration['unit'])) {`
	`80`	`+ return StringUtil::encodeHTML($configuration['unit']);`
	`81`	`+ }`
	`82`	`+`
	`83`	`+ return '';`
	`84`	`+ }`
`74`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ private function getDefaultFormFields(): array`
`61`	`61`	`'required' => BooleanFormField::create('required')`
`62`	`62`	`->label('wcf.form.option.shared.required')`
`63`	`63`	`->value(false),`
	`64`	`+ 'unit' => TextFormField::create('unit')`
	`65`	`+ ->label('wcf.form.option.shared.unit')`
	`66`	`+ ->addFieldClass('short')`
`64`	`67`	`];`
`65`	`68`	`}`
`66`	`69`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ final class FloatFormatter implements IFormOptionFormatter`
`17`	`17`	`#[\Override]`
`18`	`18`	`public function format(string $value, int $languageID, array $configuration): string`
`19`	`19`	`{`
`20`		`- return StringUtil::formatNumeric(\floatval($value));`
	`20`	`+ $suffix = '';`
	`21`	`+ if (!empty($configuration['unit'])) {`
	`22`	`+ $suffix = ' ' . StringUtil::encodeHTML($configuration['unit']);`
	`23`	`+ }`
	`24`	`+`
	`25`	`+ return StringUtil::formatNumeric(\floatval($value)) . $suffix;`
`21`	`26`	`}`
`22`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ final class IntegerFormatter implements IFormOptionFormatter`
`17`	`17`	`#[\Override]`
`18`	`18`	`public function format(string $value, int $languageID, array $configuration): string`
`19`	`19`	`{`
`20`		`- return StringUtil::formatNumeric(\intval($value));`
	`20`	`+ $suffix = '';`
	`21`	`+ if (!empty($configuration['unit'])) {`
	`22`	`+ $suffix = ' ' . StringUtil::encodeHTML($configuration['unit']);`
	`23`	`+ }`
	`24`	`+`
	`25`	`+ return StringUtil::formatNumeric(\intval($value)) . $suffix;`
`21`	`26`	`}`
`22`	`27`	`}`