Skip to content

Add option to define an unit for numeric form options #6430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BurntimeX merged 1 commit into from
Aug 21, 2025
Merged

Add option to define an unit for numeric form options #6430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions wcfsetup/install/files/lib/system/form/option/AbstractNumericFormOption.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 '';
Expand All @@ -74,4 +78,12 @@ protected function parseFilterValue(string $value): array
'to' => $to,
];
}

/**
* @param array<string, mixed> $configuration
*/
protected function getSuffix(array $configuration): string
{
return '';
}
}
11 changes: 11 additions & 0 deletions wcfsetup/install/files/lib/system/form/option/CurrencyFormOption.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 '';
}
}
13 changes: 12 additions & 1 deletion wcfsetup/install/files/lib/system/form/option/FloatFormOption.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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]
Expand All @@ -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 '';
}
}
13 changes: 12 additions & 1 deletion wcfsetup/install/files/lib/system/form/option/IntegerFormOption.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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]
Expand All @@ -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 '';
}
}
3 changes: 3 additions & 0 deletions wcfsetup/install/files/lib/system/form/option/SharedConfigurationFormFields.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
];
}

Expand Down
7 changes: 6 additions & 1 deletion wcfsetup/install/files/lib/system/form/option/formatter/FloatFormatter.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
7 changes: 6 additions & 1 deletion wcfsetup/install/files/lib/system/form/option/formatter/IntegerFormatter.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
1 change: 1 addition & 0 deletions wcfsetup/install/lang/de.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
1 change: 1 addition & 0 deletions wcfsetup/install/lang/en.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down