Add missing parameter type declarations in form builder API
authorMatthias Schmidt <gravatronics@live.com>
Thu, 8 Feb 2018 18:18:00 +0000 (19:18 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Thu, 8 Feb 2018 18:18:00 +0000 (19:18 +0100)
See #2509

19 files changed:
wcfsetup/install/files/lib/system/form/builder/IFormElement.class.php
wcfsetup/install/files/lib/system/form/builder/IFormNode.class.php
wcfsetup/install/files/lib/system/form/builder/TFormElement.class.php
wcfsetup/install/files/lib/system/form/builder/TFormNode.class.php
wcfsetup/install/files/lib/system/form/builder/field/IMaximumFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IMaximumLengthFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IMinimumFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IMinimumLengthFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IPlaceholderFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/ISuffixedFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TMaximumFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TMaximumLengthFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TMinimumFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TMinimumLengthFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TPlaceholderFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TSuffixedFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TextFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/validation/FormFieldValidationError.class.php
wcfsetup/install/files/lib/system/form/builder/field/validation/IFormFieldValidationError.class.php

index 88004284bba2bf6bdbd3befab401c80386fc26f4..a490a02a9ca1696aa6da47839f17829d96f95db8 100644 (file)
@@ -22,7 +22,7 @@ interface IFormElement extends IFormNode {
         * 
         * @throws      \InvalidArgumentException       if the given description is invalid
         */
-       public function description($languageItem = null, array $variables = []): IFormElement;
+       public function description(string $languageItem = null, array $variables = []): IFormElement;
        
        /**
         * Returns the description of this element or `null` if no description has been set.
@@ -49,5 +49,5 @@ interface IFormElement extends IFormNode {
         * 
         * @throws      \InvalidArgumentException       if the given label is invalid
         */
-       public function label($languageItem = null, array $variables = []): IFormElement;
+       public function label(string $languageItem = null, array $variables = []): IFormElement;
 }
index 2eb9fac5ae9f5a49cd4a2d51f9a50c295007047b..ad13dd539d43dd49d67cfa896d0c5d3a6c2d3a4f 100644 (file)
@@ -46,7 +46,7 @@ interface IFormNode {
         * 
         * @throws      \InvalidArgumentException       if an invalid name or value is given (some attribute names are invalid as there are specific methods for setting that attribute)
         */
-       public function attribute(string $name, $value = null): IFormNode;
+       public function attribute(string $name, string $value = null): IFormNode;
        
        /**
         * Sets if this node is available and returns this node.
index 9fff72929b2707cf1ba6f3e2ef42ed6d5b06f94b..ec0995fc1740b85f8bb9175436148c66d6f705c6 100644 (file)
@@ -37,7 +37,7 @@ trait TFormElement {
         *
         * @throws      \InvalidArgumentException       if the given description is no string or otherwise is invalid
         */
-       public function description($languageItem = null, array $variables = []): IFormElement {
+       public function description(string $languageItem = null, array $variables = []): IFormElement {
                if ($languageItem === null) {
                        if (!empty($variables)) {
                                throw new \InvalidArgumentException("Cannot use variables when unsetting description of element '{$this->getId()}'");
@@ -85,7 +85,7 @@ trait TFormElement {
         * 
         * @throws      \InvalidArgumentException       if the given label is no string or otherwise is invalid
         */
-       public function label($languageItem = null, array $variables = []): IFormElement {
+       public function label(string $languageItem = null, array $variables = []): IFormElement {
                if ($languageItem === null) {
                        if (!empty($variables)) {
                                throw new \InvalidArgumentException("Cannot use variables when unsetting label of element '{$this->getId()}'");
index f742328dfc2cc3a55dc14c73e3802901f82ea604..3ed2b07c7b2d03e0fd256bb1ae98b9eb5b50646d 100644 (file)
@@ -102,7 +102,7 @@ trait TFormNode {
         * 
         * @throws      \InvalidArgumentException       if an invalid name or value is given (some attribute names are invalid as there are specific methods for setting that attribute)
         */
-       public function attribute(string $name, $value = null): IFormNode {
+       public function attribute(string $name, string $value = null): IFormNode {
                static::validateAttribute($name);
                
                if ($value !== null && !is_bool($value) && !is_numeric($value) && !is_string($value)) {
index d7fd61795b3fa7b48511443e258fd2edcc7fb601..1dfb9668a5efdc6e745d1ed95e2e9855dc30df9b 100644 (file)
@@ -28,5 +28,5 @@ interface IMaximumFormField {
         * 
         * @throws      \InvalidArgumentException       if the given maximum is no integer or otherwise invalid
         */
-       public function maximum($maximum = null): IMaximumFormField;
+       public function maximum(int $maximum = null): IMaximumFormField;
 }
index 808c637b07002a3008553c1311b46a708219038f..7d2d79759717f3d9bba31025d2ce0730f43900fd 100644 (file)
@@ -28,5 +28,5 @@ interface IMaximumLengthFormField {
         * 
         * @throws      \InvalidArgumentException       if the given maximum length is no integer or otherwise invalid
         */
-       public function maximumLength($maximumLength = null): IMaximumLengthFormField;
+       public function maximumLength(int $maximumLength = null): IMaximumLengthFormField;
 }
index a06f4995af764b7006acbb77d1daa1898abbba34..993d1593a73a11ba5e7b46566c6f1cc39da64dc4 100644 (file)
@@ -28,5 +28,5 @@ interface IMinimumFormField {
         * 
         * @throws      \InvalidArgumentException       if the given minimum is no integer or otherwise invalid
         */
-       public function minimum($minimum = null): IMinimumFormField;
+       public function minimum(int $minimum = null): IMinimumFormField;
 }
index 9caec1e543a813deb27fef90a1f09ecfa76c59b3..de0e25a06ceaa06beac7e5aae593e89ce174d508 100644 (file)
@@ -28,5 +28,5 @@ interface IMinimumLengthFormField {
         * 
         * @throws      \InvalidArgumentException       if the given minimum length is no integer or otherwise invalid
         */
-       public function minimumLength($minimumLength = null): IMinimumLengthFormField;
+       public function minimumLength(int $minimumLength = null): IMinimumLengthFormField;
 }
index efaa657eec1a924a4d599fe23b6e205731afe447..4d315fd3b1ae82b9ed6dec9e69721d90ea11cc30 100644 (file)
@@ -30,5 +30,5 @@ interface IPlaceholderFormField {
         * 
         * @throws      \InvalidArgumentException       if the given value is invalid
         */
-       public function placeholder($languageItem = null, array $variables = []): IPlaceholderFormField;
+       public function placeholder(string $languageItem = null, array $variables = []): IPlaceholderFormField;
 }
index 0fad21c142c002eac30196f7cdcd5fb70020c471..5d34e9798bbe3942dc7224238d2b140744b96a72 100644 (file)
@@ -28,5 +28,5 @@ interface ISuffixedFormField {
         * 
         * @throws      \InvalidArgumentException       if the given language item is invalid
         */
-       public function suffix($languageItem = null, array $variables = []): ISuffixedFormField;
+       public function suffix(string $languageItem = null, array $variables = []): ISuffixedFormField;
 }
index 3a800809211b4c0cae8cd9b4bd66019bbb5e2f0d..6ff2cb0e750aa591e8ae2fe453b5b4707749cfac 100644 (file)
@@ -36,7 +36,7 @@ trait TMaximumFormField {
         * 
         * @throws      \InvalidArgumentException       if the given maximum is no integer or otherwise invalid
         */
-       public function maximum($maximum = null): IMaximumFormField {
+       public function maximum(int $maximum = null): IMaximumFormField {
                if ($maximum !== null) {
                        if (!is_int($maximum)) {
                                throw new \InvalidArgumentException("Given maximum is no int, '" . gettype($maximum) . "' given.");
index 94b955701e49e8ce3cab35c4ccc22447bc80fd65..227f00adfb945765d7cdb0f7301aa616aa57ea7a 100644 (file)
@@ -36,7 +36,7 @@ trait TMaximumLengthFormField {
         * 
         * @throws      \InvalidArgumentException       if the given maximum length is no integer or otherwise invalid
         */
-       public function maximumLength($maximumLength = null): IMaximumLengthFormField {
+       public function maximumLength(int $maximumLength = null): IMaximumLengthFormField {
                if ($maximumLength !== null) {
                        if (!is_int($maximumLength)) {
                                throw new \InvalidArgumentException("Given maximum length is no int, '" . gettype($maximumLength) . "' given.");
index 244e03469006c2879c0a00b3db4a219febe8f05c..0fff47dbdb536d4d4501480b5275616bc0093536 100644 (file)
@@ -36,7 +36,7 @@ trait TMinimumFormField {
         * 
         * @throws      \InvalidArgumentException       if the given minimum is no integer or otherwise invalid
         */
-       public function minimum($minimum = null): IMinimumFormField {
+       public function minimum(int $minimum = null): IMinimumFormField {
                if ($minimum !== null) {
                        if (!is_int($minimum)) {
                                throw new \InvalidArgumentException("Given minimum is no int, '" . gettype($minimum) . "' given.");
index 84118a7984bd5c13819c9156eab9b534d1e653d6..48565c5890a0ff5608cb022951456489b56bd730 100644 (file)
@@ -36,7 +36,7 @@ trait TMinimumLengthFormField {
         * 
         * @throws      \InvalidArgumentException       if the given minimum length is no integer or otherwise invalid
         */
-       public function minimumLength($minimumLength = null): IMinimumLengthFormField {
+       public function minimumLength(int $minimumLength = null): IMinimumLengthFormField {
                if ($minimumLength !== null) {
                        if (!is_int($minimumLength)) {
                                throw new \InvalidArgumentException("Given minimum length is no int, '" . gettype($minimumLength) . "' given.");
index c42f626656844be8649da3009df7e3a7bce83a23..805e1b9a11d34528cfc06a159eda9c388c01b16a 100644 (file)
@@ -39,7 +39,7 @@ trait TPlaceholderFormField {
         * 
         * @throws      \InvalidArgumentException       if the given value is no string or otherwise invalid
         */
-       public function placeholder($languageItem = null, array $variables = []): IPlaceholderFormField {
+       public function placeholder(string $languageItem = null, array $variables = []): IPlaceholderFormField {
                if ($languageItem === null) {
                        if (!empty($variables)) {
                                throw new \InvalidArgumentException("Cannot use variables when unsetting placeholder of field '{$this->getId()}'");
index dfb6fb32aa423bdc72060c955290f2d7d213ab07..09b518a25afc93b707d22b357d362e270b39367e 100644 (file)
@@ -37,7 +37,7 @@ trait TSuffixedFormField {
         * 
         * @throws      \InvalidArgumentException       if the given language item is no string or otherwise invalid
         */
-       public function suffix($languageItem = null, array $variables = []): ISuffixedFormField {
+       public function suffix(string $languageItem = null, array $variables = []): ISuffixedFormField {
                if ($languageItem === null) {
                        if (!empty($variables)) {
                                throw new \InvalidArgumentException("Cannot use variables when unsetting suffix of field '{$this->getId()}'");
index 3f5821292561980d2bcd152e2ebae0834b25f715..0e0d2a339431850a1fa21e5778f7c22f3d7db053 100644 (file)
@@ -59,7 +59,7 @@ class TextFormField extends AbstractFormField implements II18nFormField, IMaximu
         * @param       string          $text           validated text
         * @param       null|int        $languageID     language id of validated text or `null` for monolingual text
         */
-       protected function validateText(string $text, $languageID = null) {
+       protected function validateText(string $text, int $languageID = null) {
                if ($this->getMinimumLength() !== null && mb_strlen($text) < $this->getMinimumLength()) {
                        $this->addValidationError(new FormFieldValidationError('minimumLength', 'wcf.global.form.text.error.minimumLength', [
                                'languageID' => $languageID,
index 91f5623619bf8f2e0e66749042010ec6aa6fea4f..0fbf96b7efd83124a23191a5d21631686ecf2ea1 100644 (file)
@@ -33,7 +33,7 @@ class FormFieldValidationError implements IFormFieldValidationError {
        /**
         * @inheritDoc
         */
-       public function __construct(string $type, $languageItem = null, array $information = []) {
+       public function __construct(string $type, string $languageItem = null, array $information = []) {
                if ($languageItem === null) {
                        $languageItem = 'wcf.global.form.error.' . $type;
                }
index bf055ca0caf20e924b1061a02ad7f8ec1595312f..43cdebc11d82bfa2309f50595f447e21c8e38a82 100644 (file)
@@ -22,7 +22,7 @@ interface IFormFieldValidationError {
         * 
         * @throws      \InvalidArgumentException       if the given error type is invalid
         */
-       public function __construct(string $type, $languageItem = null, array $information = []);
+       public function __construct(string $type, string $languageItem = null, array $information = []);
        
        /**
         * Returns the HTML element representing the error.