IControl::setValue() ⇒ setCurrentValues()

examples/custom-control.php

@@ -34,7 +34,7 @@ public function __construct($label = null)
 	}
 
 
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		if ($value === null) {
 			$this->day = $this->month = $this->year = '';

src/Forms/Container.php

@@ -17,16 +17,16 @@
  *
  * @property   Nette\Utils\ArrayHash $values
  * @property-read \Iterator $controls
- * @property-read Form|null $form
+ * @property-read Form|NULL $form
  */
 class Container extends Nette\ComponentModel\Container implements \ArrayAccess
 {
+
 	/** @var callable[]  function (Container $sender); Occurs when the form is validated */
 	public $onValidate;
 
-	/** @var ControlGroup|null */
+	/** @var ControlGroup|NULL */
 	protected $currentGroup;
-
 	/** @var callable[]  extension methods */
 	private static $extMethods = [];
 
@@ -45,7 +45,7 @@ public function setDefaults(iterable $values, bool $erase = false)
 	{
 		$form = $this->getForm(false);
 		if (!$form || !$form->isAnchored() || !$form->isSubmitted()) {
-			$this->setValues($values, $erase);
+			$this->setCurrentValues($values, $erase);
 		}
 		return $this;
 	}
@@ -56,7 +56,7 @@ public function setDefaults(iterable $values, bool $erase = false)
 	 * @return static
 	 * @internal
 	 */
-	public function setValues(iterable $values, bool $erase = false)
+	public function setCurrentValues(iterable $values, bool $erase = false)
 	{
 		if ($values instanceof \Traversable) {
 			$values = iterator_to_array($values);
@@ -68,25 +68,35 @@ public function setValues(iterable $values, bool $erase = false)
 		foreach ($this->getComponents() as $name => $control) {
 			if ($control instanceof IControl) {
 				if (array_key_exists($name, $values)) {
-					$control->setValue($values[$name]);
+					$control->setCurrentValue($values[$name]);
 
 				} elseif ($erase) {
-					$control->setValue(null);
+					$control->setCurrentValue(null);
 				}
 
 			} elseif ($control instanceof self) {
 				if (array_key_exists($name, $values)) {
-					$control->setValues($values[$name], $erase);
+					$control->setCurrentValues($values[$name], $erase);
 
 				} elseif ($erase) {
-					$control->setValues([], $erase);
+					$control->setCurrentValues([], $erase);
 				}
 			}
 		}
 		return $this;
 	}
 
 
+	/**
+	 * @deprecated
+	 */
+	public function setValues($values, $erase = false)
+	{
+		trigger_error(__METHOD__ . '() is deprecated; use setCurrentValues() instead.', E_USER_DEPRECATED);
+		return $this->setCurrentValues($values, $erase);
+	}
+
+
 	/**
 	 * Returns the values submitted by the form.
 	 * @return Nette\Utils\ArrayHash|array

src/Forms/Controls/BaseControl.php

@@ -62,7 +62,7 @@ abstract class BaseControl extends Nette\ComponentModel\Component implements ICo
 	/** @var array */
 	private $errors = [];
 
-	/** @var bool|null */
+	/** @var bool|NULL */
 	private $omitted;
 
 	/** @var Rules */
@@ -92,7 +92,7 @@ public function __construct($caption = null)
 		if (self::$autoOptional) {
 			$this->setRequired(false);
 		}
-		$this->setValue(null);
+		$this->setCurrentValue(null);
 	}
 
 
@@ -142,7 +142,7 @@ public function getForm(bool $throw = true): ?Form
 	 */
 	public function loadHttpData(): void
 	{
-		$this->setValue($this->getHttpData(Form::DATA_TEXT));
+		$this->setCurrentValue($this->getHttpData(Form::DATA_TEXT));
 	}
 
 
@@ -173,10 +173,18 @@ public function getHtmlName(): string
 	 * @return static
 	 * @internal
 	 */
+	public function setCurrentValue($value)
+	{
+		return $this->setValue($value);
+	}
+
+
+	/**
+	 * @deprecated
+	 */
 	public function setValue($value)
 	{
 		$this->value = $value;
-		return $this;
 	}
 
 
@@ -208,7 +216,7 @@ public function setDefaultValue($value)
 	{
 		$form = $this->getForm(false);
 		if ($this->isDisabled() || !$form || !$form->isAnchored() || !$form->isSubmitted()) {
-			$this->setValue($value);
+			$this->setCurrentValue($value);
 		}
 		return $this;
 	}
@@ -221,7 +229,7 @@ public function setDefaultValue($value)
 	public function setDisabled($value = true)
 	{
 		if ($this->disabled = (bool) $value) {
-			$this->setValue(null);
+			$this->setCurrentValue(null);
 		} elseif (($form = $this->getForm(false)) && $form->isAnchored() && $form->isSubmitted()) {
 			$this->loadHttpData();
 		}
@@ -327,7 +335,7 @@ public function getLabelPrototype(): Html
 
 	/**
 	 * Changes control's HTML id.
-	 * @param  mixed  new ID, or false or null
+	 * @param  mixed  new ID, or FALSE or NULL
 	 * @return static
 	 */
 	public function setHtmlId($id)

src/Forms/Controls/Checkbox.php

@@ -39,7 +39,7 @@ public function __construct($label = null)
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		if (!is_scalar($value) && $value !== null) {
 			throw new Nette\InvalidArgumentException(sprintf("Value must be scalar or null, %s given in field '%s'.", gettype($value), $this->name));

src/Forms/Controls/ChoiceControl.php

@@ -61,7 +61,7 @@ public function loadHttpData(): void
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		if ($this->checkAllowedValues && $value !== null && !array_key_exists((string) $value, $this->items)) {
 			$set = Nette\Utils\Strings::truncate(implode(', ', array_map(function ($s) { return var_export($s, true); }, array_keys($this->items))), 70, '...');

src/Forms/Controls/CsrfProtection.php

@@ -49,7 +49,7 @@ protected function attached(Nette\ComponentModel\IComponent $parent): void
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		return $this;
 	}

src/Forms/Controls/HiddenField.php

@@ -39,7 +39,7 @@ public function __construct($persistentValue = null)
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		if (!is_scalar($value) && $value !== null && !method_exists($value, '__toString')) {
 			throw new Nette\InvalidArgumentException(sprintf("Value must be scalar or null, %s given in field '%s'.", gettype($value), $this->name));

src/Forms/Controls/MultiChoiceControl.php

@@ -56,7 +56,7 @@ public function loadHttpData(): void
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($values)
+	public function setCurrentValue($values)
 	{
 		if (is_scalar($values) || $values === null) {
 			$values = (array) $values;

src/Forms/Controls/TextBase.php

@@ -34,7 +34,7 @@ abstract class TextBase extends BaseControl
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		if ($value === null) {
 			$value = '';

src/Forms/Controls/TextInput.php

@@ -35,7 +35,7 @@ public function __construct($label = null, int $maxLength = null)
 	 */
 	public function loadHttpData(): void
 	{
-		$this->setValue($this->getHttpData(Form::DATA_LINE));
+		$this->setCurrentValue($this->getHttpData(Form::DATA_LINE));
 	}
 
 

src/Forms/Controls/UploadControl.php

@@ -78,7 +78,7 @@ public function getHtmlName(): string
 	 * @return static
 	 * @internal
 	 */
-	public function setValue($value)
+	public function setCurrentValue($value)
 	{
 		return $this;
 	}

src/Forms/IControl.php

@@ -21,7 +21,7 @@ interface IControl
 	 * @param  mixed
 	 * @return static
 	 */
-	function setValue($value);
+	//function setCurrentValue($value);
 
 	/**
 	 * Returns control's value.

src/Forms/Rules.php

@@ -170,7 +170,7 @@ public function addFilter(callable $filter)
 		$this->rules[] = $rule = new Rule;
 		$rule->control = $this->control;
 		$rule->validator = function (IControl $control) use ($filter) {
-			$control->setValue($filter($control->getValue()));
+			$control->setCurrentValue($filter($control->getValue()));
 			return true;
 		};
 		return $this;

src/Forms/Validator.php

@@ -236,7 +236,7 @@ public static function validateUrl(IControl $control): bool
 			return true;
 
 		} elseif (Validators::isUrl($value = "http://$value")) {
-			$control->setValue($value);
+			$control->setCurrentValue($value);
 			return true;
 		}
 		return false;
@@ -269,7 +269,7 @@ public static function validateInteger(IControl $control): bool
 	{
 		if (Validators::isNumericInt($value = $control->getValue())) {
 			if (!is_float($tmp = $value * 1)) { // bigint leave as string
-				$control->setValue($tmp);
+				$control->setCurrentValue($tmp);
 			}
 			return true;
 		}
@@ -284,7 +284,7 @@ public static function validateFloat(IControl $control): bool
 	{
 		$value = str_replace([' ', ','], ['', '.'], $control->getValue());
 		if (Validators::isNumeric($value)) {
-			$control->setValue((float) $value);
+			$control->setCurrentValue((float) $value);
 			return true;
 		}
 		return false;

tests/Forms.Latte/FormMacros.forms.phpt

@@ -36,7 +36,7 @@ $form->addText('username', 'Username:'); // must have just one textfield to gene
 $form['username']->getControlPrototype()->addClass('control-class');
 $form->addRadioList('sex', 'Sex:', ['m' => 'male', 'f' => 'female']);
 $form->addSelect('select', null, ['m' => 'male', 'f' => 'female']);
-$form->addTextArea('area', null)->setValue('one<two');
+$form->addTextArea('area', null)->setDefaultValue('one<two');
 $form->addCheckbox('checkbox', 'Checkbox');
 $form->addCheckboxList('checklist', 'CheckboxList:', ['m' => 'male', 'f' => 'female']);
 $form->addSubmit('send', 'Sign in');

tests/Forms/Container.validate().phpt

@@ -26,7 +26,7 @@ $container->onValidate[] = function (Container $container) {
 	$container['name']->addError('fail 2');
 };
 
-$form->setValues(['name' => 'invalid*input']);
+$form->setDefaults(['name' => 'invalid*input']);
 $form->validate();
 
 Assert::same([

tests/Forms/Controls.BaseControl.phpt

@@ -37,7 +37,7 @@ test(function () { // error handling
 test(function () { // validators
 	$form = new Form;
 	$input = $form->addText('text');
-	$input->setValue(123);
+	$input->setCurrentValue(123);
 
 	Assert::true(Validator::validateEqual($input, 123));
 	Assert::true(Validator::validateEqual($input, '123'));
@@ -74,7 +74,7 @@ test(function () { // validators
 test(function () { // validators for array
 	$form = new Form;
 	$input = $form->addMultiSelect('select', null, ['a', 'b', 'c', 'd']);
-	$input->setValue([1, 2, 3]);
+	$input->setCurrentValue([1, 2, 3]);
 
 	Assert::true(Validator::validateEqual($input, [1, 2, 3, 4]));
 	Assert::true(Validator::validateEqual($input, ['1', '2', '3']));

tests/Forms/Controls.Checkbox.loadData.phpt

@@ -49,12 +49,12 @@ test(function () { // malformed data
 });
 
 
-test(function () { // setValue() and invalid argument
+test(function () { // setCurrentValue() and invalid argument
 	$form = new Form;
 	$input = $form->addCheckbox('checkbox');
-	$input->setValue(null);
+	$input->setCurrentValue(null);
 
 	Assert::exception(function () use ($input) {
-		$input->setValue([]);
-	}, Nette\InvalidArgumentException::class, "Value must be scalar or null, array given in field 'checkbox'.");
+		$input->setCurrentValue([]);
+	}, Nette\InvalidArgumentException::class, "Value must be scalar or NULL, array given in field 'checkbox'.");
 });

tests/Forms/Controls.Checkbox.render.phpt

@@ -38,7 +38,7 @@ test(function () {
 	Assert::type(Html::class, $input->getControlPart());
 	Assert::same('<input type="checkbox" name="on" id="frm-on">', (string) $input->getControlPart());
 
-	$input->setValue(true);
+	$input->setCurrentValue(true);
 	Assert::same('<label for="frm-on"><input type="checkbox" name="on" id="frm-on" checked>Label</label>', (string) $input->getControl());
 	Assert::same('<input type="checkbox" name="on" id="frm-on" checked>', (string) $input->getControlPart());
 });

tests/Forms/Controls.CheckboxList.loadData.phpt

@@ -131,21 +131,21 @@ test(function () use ($series) { // validateEqual
 });
 
 
-test(function () use ($series) { // setValue() and invalid argument
+test(function () use ($series) { // setCurrentValue() and invalid argument
 	$form = new Form;
 	$input = $form->addCheckboxList('list', null, $series);
-	$input->setValue(null);
+	$input->setCurrentValue(null);
 
 	Assert::exception(function () use ($input) {
-		$input->setValue('unknown');
+		$input->setCurrentValue('unknown');
 	}, Nette\InvalidArgumentException::class, "Value 'unknown' are out of allowed set ['red-dwarf', 'the-simpsons', 0, ''] in field 'list'.");
 });
 
 
 test(function () { // object as value
 	$form = new Form;
 	$input = $form->addCheckboxList('list', null, ['2013-07-05 00:00:00' => 1])
-		->setValue([new DateTime('2013-07-05')]);
+		->setCurrentValue([new DateTime('2013-07-05')]);
 
 	Assert::same(['2013-07-05 00:00:00'], $input->getValue());
 });
@@ -155,7 +155,7 @@ test(function () { // object as item
 	$form = new Form;
 	$input = $form->addCheckboxList('list')
 		->setItems([new DateTime('2013-07-05')], false)
-		->setValue('2013-07-05 00:00:00');
+		->setCurrentValue('2013-07-05 00:00:00');
 
 	Assert::equal(['2013-07-05 00:00:00' => new DateTime('2013-07-05')], $input->getSelectedItems());
 });

tests/Forms/Controls.CheckboxList.render.phpt

@@ -50,7 +50,7 @@ test(function () { // checked
 	$input = $form->addCheckboxList('list', 'Label', [
 		'a' => 'First',
 		0 => 'Second',
-	])->setValue(0);
+	])->setCurrentValue(0);
 
 	Assert::same('<label><input type="checkbox" name="list[]" value="a">First</label><br><label><input type="checkbox" name="list[]" checked value="0">Second</label>', (string) $input->getControl());
 });