phpdoc generics for Control

Author: dg

src/Forms/Control.php

@@ -12,18 +12,19 @@
 
 /**
  * Defines method that must be implemented to allow a component to act like a form control.
+ * @template T
  */
 interface Control
 {
 	/**
 	 * Sets control's value.
-	 * @param  mixed  $value
+	 * @param  T|null  $value
 	 */
 	function setValue(mixed $value): static;
 
 	/**
 	 * Returns control's value.
-	 * @return mixed
+	 * @return  T|null
 	 */
 	function getValue(): mixed;
 

src/Forms/Controls/BaseControl.php

@@ -36,6 +36,9 @@
  * @property-read array $errors
  * @property-read array $options
  * @property-read string $error
+ *
+ * @template T
+ * @implements Control<T>
  */
 abstract class BaseControl extends Nette\ComponentModel\Component implements Control
 {
@@ -152,7 +155,6 @@ public function setValue($value): static
 
 	/**
 	 * Returns control's value.
-	 * @return mixed
 	 */
 	public function getValue(): mixed
 	{

src/Forms/Controls/Button.php

@@ -15,6 +15,7 @@
 
 /**
  * Push button control with no default behavior.
+ * @extends BaseControl<string>
  */
 class Button extends BaseControl
 {

src/Forms/Controls/Checkbox.php

@@ -16,6 +16,7 @@
 
 /**
  * Check box control. Allows the user to select a true or false condition.
+ * @extends BaseControl<bool>
  */
 class Checkbox extends BaseControl
 {

src/Forms/Controls/ChoiceControl.php

@@ -17,6 +17,8 @@
  *
  * @property   array $items
  * @property-read mixed $selectedItem
+ *
+ * @extends BaseControl<array-key>
  */
 abstract class ChoiceControl extends BaseControl
 {
@@ -68,7 +70,6 @@ public function setValue($value): static
 
 	/**
 	 * Returns selected key.
-	 * @return string|int|null
 	 */
 	public function getValue(): mixed
 	{

src/Forms/Controls/CsrfProtection.php

@@ -16,6 +16,7 @@
 
 /**
  * CSRF protection field.
+ * @extends BaseControl<null>
  */
 class CsrfProtection extends HiddenField
 {

src/Forms/Controls/HiddenField.php

@@ -16,6 +16,7 @@
 
 /**
  * Hidden form control used to store a non-displayed value.
+ * @extends BaseControl<string>
  */
 class HiddenField extends BaseControl
 {

src/Forms/Controls/ImageButton.php

@@ -12,6 +12,7 @@
 
 /**
  * Submittable image button form control.
+ * @method array|null getValue()
  */
 class ImageButton extends SubmitButton
 {

src/Forms/Controls/MultiChoiceControl.php

@@ -17,6 +17,8 @@
  *
  * @property   array $items
  * @property-read array $selectedItems
+ *
+ * @extends BaseControl<array-key[]>
  */
 abstract class MultiChoiceControl extends BaseControl
 {
@@ -82,6 +84,7 @@ public function setValue($values): static
 
 	/**
 	 * Returns selected keys.
+	 * @return array-key[]
 	 */
 	public function getValue(): array
 	{

src/Forms/Controls/TextBase.php

@@ -17,6 +17,7 @@
 
 /**
  * Implements the basic functionality common to text input controls.
+ * @extends BaseControl<string>
  */
 abstract class TextBase extends BaseControl
 {
@@ -48,7 +49,6 @@ public function setValue($value): static
 
 	/**
 	 * Returns control's value.
-	 * @return mixed
 	 */
 	public function getValue(): mixed
 	{

src/Forms/Controls/UploadControl.php

@@ -18,6 +18,7 @@
 
 /**
  * Text box and browse button that allow users to select a file to upload to the server.
+ * @extends BaseControl<FileUpload|FileUpload[]>
  */
 class UploadControl extends BaseControl
 {