phpdoc generics for Control

nette · Nov 9, 2021 · cc84040 · cc84040
1 parent 4ed5243
commit cc84040
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 0 deletions.
diff --git a/src/Forms/Control.php b/src/Forms/Control.php
@@ -12,18 +12,21 @@
 
 /**
  * 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  T|null  $value
 	 * @param  mixed  $value
 	 * @return static
 	 */
 	function setValue($value);
 
 	/**
 	 * Returns control's value.
+	 * @return  T|null
 	 * @return mixed
 	 */
 	function getValue();

diff --git a/src/Forms/Controls/BaseControl.php b/src/Forms/Controls/BaseControl.php
@@ -35,6 +35,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
 {

diff --git a/src/Forms/Controls/Button.php b/src/Forms/Controls/Button.php
@@ -14,6 +14,7 @@
 
 /**
  * Push button control with no default behavior.
+ * @extends BaseControl<string>
  */
 class Button extends BaseControl
 {

diff --git a/src/Forms/Controls/Checkbox.php b/src/Forms/Controls/Checkbox.php
@@ -15,6 +15,7 @@
 
 /**
  * Check box control. Allows the user to select a true or false condition.
+ * @extends BaseControl<bool>
  */
 class Checkbox extends BaseControl
 {

diff --git a/src/Forms/Controls/ChoiceControl.php b/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
 {

diff --git a/src/Forms/Controls/CsrfProtection.php b/src/Forms/Controls/CsrfProtection.php
@@ -15,6 +15,7 @@
 
 /**
  * CSRF protection field.
+ * @extends BaseControl<null>
  */
 class CsrfProtection extends HiddenField
 {

diff --git a/src/Forms/Controls/HiddenField.php b/src/Forms/Controls/HiddenField.php
@@ -14,6 +14,7 @@
 
 /**
  * Hidden form control used to store a non-displayed value.
+ * @extends BaseControl<string>
  */
 class HiddenField extends BaseControl
 {

diff --git a/src/Forms/Controls/MultiChoiceControl.php b/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
 {

diff --git a/src/Forms/Controls/TextBase.php b/src/Forms/Controls/TextBase.php
@@ -16,6 +16,7 @@
 
 /**
  * Implements the basic functionality common to text input controls.
+ * @extends BaseControl<string>
  */
 abstract class TextBase extends BaseControl
 {

diff --git a/src/Forms/Controls/UploadControl.php b/src/Forms/Controls/UploadControl.php
@@ -17,6 +17,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
 {