RadioList, CheckboxList: getControlPart() and getLabelPart() throw exception for invalid key

- ChoiceControl, MultiChoiceControl: extracted getItem() method

Author: dg

src/Forms/Controls/CheckboxList.php

@@ -10,7 +10,7 @@
 use Nette;
 use Nette\Utils\Html;
 use Stringable;
-use function array_flip, array_key_first, array_keys, array_merge, explode, func_num_args, in_array, is_array, is_string, key, substr;
+use function array_flip, array_key_first, array_keys, array_merge, explode, func_num_args, in_array, is_array, is_string, substr;
 
 
 /**
@@ -86,7 +86,7 @@ public function getLabel($caption = null): Html
 	 */
 	public function getControlPart($key = null): Html
 	{
-		$key = key([(string) $key => null]);
+		$this->getItem($key);
 		return parent::getControl()->addAttributes([
 			'id' => $this->getHtmlId() . '-' . $key,
 			'checked' => in_array($key, (array) $this->value, strict: true),
@@ -104,7 +104,7 @@ public function getLabelPart($key = null): Html
 	{
 		$itemLabel = clone $this->itemLabel;
 		return func_num_args()
-			? $itemLabel->setText($this->translate($this->getItems()[$key]))->for($this->getHtmlId() . '-' . $key)
+			? $itemLabel->setText($this->translate($this->getItem($key)))->for($this->getHtmlId() . '-' . $key)
 			: $this->getLabel();
 	}
 

src/Forms/Controls/ChoiceControl.php

@@ -153,4 +153,16 @@ public function checkDefaultValue(bool $value = true): static
 		$this->checkDefaultValue = $value;
 		return $this;
 	}
+
+
+	/**
+	 * Returns the item label for the given key, or throws an exception if the key does not exist.
+	 */
+	protected function getItem(mixed &$key): mixed
+	{
+		$key = key([(string) $key => null]);
+		return array_key_exists($key, $this->items)
+			? $this->items[$key]
+			: throw new Nette\InvalidArgumentException("Item '$key' does not exist in field '{$this->getName()}'.");
+	}
 }

src/Forms/Controls/MultiChoiceControl.php

@@ -8,7 +8,7 @@
 namespace Nette\Forms\Controls;
 
 use Nette;
-use function array_combine, array_diff, array_fill_keys, array_flip, array_keys, array_map, count, get_debug_type, implode, is_array, is_scalar, sprintf, var_export;
+use function array_combine, array_diff, array_fill_keys, array_flip, array_key_exists, array_keys, array_map, count, get_debug_type, implode, is_array, is_scalar, key, sprintf, var_export;
 
 
 /**
@@ -168,4 +168,16 @@ public function checkDefaultValue(bool $value = true): static
 		$this->checkDefaultValue = $value;
 		return $this;
 	}
+
+
+	/**
+	 * Returns the item label for the given key, or throws an exception if the key does not exist.
+	 */
+	protected function getItem(mixed &$key): mixed
+	{
+		$key = key([(string) $key => null]);
+		return array_key_exists($key, $this->items)
+			? $this->items[$key]
+			: throw new Nette\InvalidArgumentException("Item '$key' does not exist in field '{$this->getName()}'.");
+	}
 }

src/Forms/Controls/RadioList.php

@@ -10,7 +10,7 @@
 use Nette;
 use Nette\Utils\Html;
 use Stringable;
-use function array_merge, func_num_args, in_array, is_array, key;
+use function array_key_first, array_merge, func_num_args, in_array, is_array;
 
 
 /**
@@ -81,7 +81,7 @@ public function getLabel($caption = null): Html
 	 */
 	public function getControlPart($key = null): Html
 	{
-		$key = key([(string) $key => null]);
+		$this->getItem($key);
 		return parent::getControl()->addAttributes([
 			'id' => $this->getHtmlId() . '-' . $key,
 			'checked' => in_array($key, (array) $this->value, strict: true),
@@ -98,7 +98,7 @@ public function getLabelPart($key = null): Html
 	{
 		$itemLabel = clone $this->itemLabel;
 		return func_num_args()
-			? $itemLabel->setText($this->translate($this->getItems()[$key]))->for($this->getHtmlId() . '-' . $key)
+			? $itemLabel->setText($this->translate($this->getItem($key)))->for($this->getHtmlId() . '-' . $key)
 			: $this->getLabel();
 	}
 

tests/Controls/CheckboxList.render.phpt

@@ -190,3 +190,17 @@ test('item label prototype styling', function () {
 	Assert::same('<label class="foo" for="frm-list-a">b</label>', (string) $input->getLabelPart('a'));
 	Assert::same('<label class="foo"><input type="checkbox" name="list[]" value="a">b</label>', (string) $input->getControl());
 });
+
+
+testException('invalid key in getControlPart', function () {
+	$form = new Form;
+	$input = $form->addCheckboxList('list', 'Label', ['a' => 'First']);
+	$input->getControlPart('unknown');
+}, Nette\InvalidArgumentException::class, "Item 'unknown' does not exist in field 'list'.");
+
+
+testException('invalid key in getLabelPart', function () {
+	$form = new Form;
+	$input = $form->addCheckboxList('list', 'Label', ['a' => 'First']);
+	$input->getLabelPart('unknown');
+}, Nette\InvalidArgumentException::class, "Item 'unknown' does not exist in field 'list'.");

tests/Controls/RadioList.render.phpt

@@ -191,3 +191,17 @@ test('radio list control options', function () {
 	$input->getControl();
 	Assert::true($input->getOption('rendered'));
 });
+
+
+testException('invalid key in getControlPart', function () {
+	$form = new Form;
+	$input = $form->addRadioList('list', 'Label', ['a' => 'First']);
+	$input->getControlPart('unknown');
+}, Nette\InvalidArgumentException::class, "Item 'unknown' does not exist in field 'list'.");
+
+
+testException('invalid key in getLabelPart', function () {
+	$form = new Form;
+	$input = $form->addRadioList('list', 'Label', ['a' => 'First']);
+	$input->getLabelPart('unknown');
+}, Nette\InvalidArgumentException::class, "Item 'unknown' does not exist in field 'list'.");