addText/addPassword - wrong parameter name?

[Pavel Linhart]

Version: master

Bug Description

Both addText and addPassword methods have a third optional parameter named cols which is then passed to the TextInput control under the correct HTML attribute name size.

I think it should be renamed to be more intuitive in regards to PHP named arguments introduced in PHP 8.

Steps To Reproduce

Here's the code for both methods:

• forms/src/Forms/Container.php

  Lines 259 to 263 in b7fe4d1

   public function addText(string $name, $label = null, int $cols = null, int $maxLength = null): Controls\TextInput 
   { 
   	return $this[$name] = (new Controls\TextInput($label, $maxLength)) 
   		->setHtmlAttribute('size', $cols); 
   } 

• forms/src/Forms/Container.php

  Lines 270 to 279 in b7fe4d1

   public function addPassword( 
   	string $name, 
   	$label = null, 
   	int $cols = null, 
   	int $maxLength = null 
   ): Controls\TextInput { 
   	return $this[$name] = (new Controls\TextInput($label, $maxLength)) 
   		->setHtmlAttribute('size', $cols) 
   		->setHtmlType('password'); 
   } 

Expected Behavior

The parameter is named size instead of cols.

Possible Solution

Rename the parameter.

---

Should I prepare a PR? :)

[David Grudl]

It's intentional, I think cols is more concise than universal size and consistent with cols & rows in addTextArea.

Above all, I want to remove that parameter in the next version.

[Pavel Linhart]

Well, it depends whether you want to be consistent with the rest of the Forms API or with the legacy HTML attribute :)

Since it's intentional and in fact not a big deal (I've never used that parameter ever), I'm closing it.