Skip to content
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

Improve invalid Dropdown value behavior #13540

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Improve invalid Dropdown value behavior #13540

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
15 changes: 14 additions & 1 deletion src/fields/BaseOptionsField.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,12 +337,25 @@ public function normalizeValue(mixed $value, ?ElementInterface $element = null):
$selectedValues[] = $val;
}

$selectedBlankOption = false;
$options = [];
$optionValues = [];
$optionLabels = [];
foreach ($this->options() as $option) {
if (!isset($option['optgroup'])) {
$selected = in_array($option['value'], $selectedValues, true);
// special case for blank options, when $value is null
if ($value === null && $option['value'] === '') {
if (!$selectedBlankOption) {
$selectedValues[] = '';
$selectedBlankOption = true;
$selected = true;
} else {
$selected = false;
}
} else {
$selected = in_array($option['value'], $selectedValues, true);
}

$options[] = new OptionData($option['label'], $option['value'], $selected, true);
$optionValues[] = (string)$option['value'];
$optionLabels[] = (string)$option['label'];
Expand Down
32 changes: 28 additions & 4 deletions src/fields/Dropdown.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
namespace craft\fields;

use Craft;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\base\SortableFieldInterface;
use craft\fields\data\SingleOptionFieldData;
Expand Down Expand Up @@ -43,6 +44,23 @@ public static function valueType(): string
*/
protected bool $optgroups = true;

public function getStatus(ElementInterface $element): ?array
{
// If the value is invalid and has a default value (which is going to be pulled in via inputHtml()),
// preemptively mark the field as modified
/** @var SingleOptionFieldData $value */
$value = $element->getFieldValue($this->handle);

if (!$value->valid && $this->defaultValue() !== null) {
return [
Element::ATTR_STATUS_MODIFIED,
Craft::t('app', 'This field has been modified.'),
];
}

return parent::getStatus($element);
}

/**
* @inheritdoc
*/
Expand All @@ -57,11 +75,17 @@ protected function inputHtml(mixed $value, ?ElementInterface $element = null): s

if (!$value->valid) {
Craft::$app->getView()->setInitialDeltaValue($this->handle, $this->encodeValue($value->value));
$value = null;
$default = $this->defaultValue();

if ($default !== null) {
$value = $this->normalizeValue($this->defaultValue());
} else {
$value = null;

// Add a blank option to the beginning if one doesn't already exist
if (!$hasBlankOption) {
array_unshift($options, ['label' => '', 'value' => '']);
// Add a blank option to the beginning if one doesn't already exist
if (!$hasBlankOption) {
array_unshift($options, ['label' => '', 'value' => '']);
}
}
}

Expand Down