Stop using `self` return type in form builder (#4115)
authorMatthias Schmidt <gravatronics@live.com>
Mon, 12 Apr 2021 12:23:12 +0000 (14:23 +0200)
committerGitHub <noreply@github.com>
Mon, 12 Apr 2021 12:23:12 +0000 (14:23 +0200)
… for compatibility with PHP versions < 7.4.

15 files changed:
wcfsetup/install/files/lib/system/form/builder/FormDocument.class.php
wcfsetup/install/files/lib/system/form/builder/IFormDocument.class.php
wcfsetup/install/files/lib/system/form/builder/LanguageItemFormNode.class.php
wcfsetup/install/files/lib/system/form/builder/field/ButtonFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IAttributeFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IAutoCompleteFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/ICssClassFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IInputModeFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/IPatternFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/RejectEverythingFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TAttributeFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TAutoCompleteFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TCssClassFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TInputModeFormField.class.php
wcfsetup/install/files/lib/system/form/builder/field/TPatternFormField.class.php

index 7f5b30a5cb741030a407fdf331664da880d6f0e5..55d4e34bea71afef4c5996e49dd2f56f6ac642fb 100644 (file)
@@ -574,7 +574,7 @@ class FormDocument implements IFormDocument
      * @inheritDoc
      * @since       5.4
      */
-    public function markRequiredFields(bool $markRequiredFields = true): self
+    public function markRequiredFields(bool $markRequiredFields = true)
     {
         $this->markRequiredFields = $markRequiredFields;
 
index 8d46b534afc6a4f78d024ebd73a5dac9eb3cf371..4d0e593124d5898bf3d12271d980742f7ddc2f54 100644 (file)
@@ -315,8 +315,9 @@ interface IFormDocument extends IFormParentNode
      * Sets whether required fields are marked in the output and returns this document.
      *
      * @since       5.4
+     * @return      static      this document
      */
-    public function markRequiredFields(bool $markRequiredFields = true): self;
+    public function markRequiredFields(bool $markRequiredFields = true);
 
     /**
      * Returns `true` if required fields are marked in the output and `false` otherwise.
index be1862d4f072fa280b14379891a9836513d1fa63..1487c40751ba2840e680410cf680c26d80f810da 100644 (file)
@@ -62,8 +62,10 @@ class LanguageItemFormNode implements IFormChildNode
 
     /**
      * Sets the language item shown in the form node and returns this form node.
+     *
+     * @return      static  this form field
      */
-    public function languageItem(string $languageItem): self
+    public function languageItem(string $languageItem)
     {
         $this->languageItem = $languageItem;
 
@@ -80,8 +82,10 @@ class LanguageItemFormNode implements IFormChildNode
 
     /**
      * Sets the template variables passed to the language item and returns this form node.
+     *
+     * @return      static      this form field
      */
-    public function variables(array $variables): self
+    public function variables(array $variables)
     {
         $this->variables = $variables;
 
index 0601a6e402cf717931d68a425bcdd1c9502c5606..5f90ef66804ea8c10a667f10ff680321df836dda 100644 (file)
@@ -38,8 +38,10 @@ class ButtonFormField extends AbstractFormField implements IAttributeFormField,
 
     /**
      * Sets the text shown on the button and returns this form field.
+     *
+     * @return  ButtonFormField     this form field
      */
-    public function buttonLabel(string $languageItem, array $variables = []): self
+    public function buttonLabel(string $languageItem, array $variables = [])
     {
         $this->buttonLabel = WCF::getLanguage()->getDynamicVariable($languageItem, $variables);
 
index 9b27ae522f7f53081fa12b02bdd6deff52a6f49c..e163790aa933a3a9b34729c3a43b434b367833ed 100644 (file)
@@ -23,8 +23,9 @@ interface IAttributeFormField extends IFormField
      * Returns the value of the additional attribute of the actual field element with the given name.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid or no such attribute exists
+     * @return      static                          this form field
      */
-    public function getFieldAttribute(string $name): self;
+    public function getFieldAttribute(string $name);
 
     /**
      * Returns all additional attributes of the actual field element.
@@ -35,8 +36,9 @@ interface IAttributeFormField extends IFormField
      * Adds the given additional attribute to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid
+     * @return      static                          this form field
      */
-    public function fieldAttribute(string $name, ?string $value = null): self;
+    public function fieldAttribute(string $name, ?string $value = null);
 
     /**
      * Returns `true` if an additional attribute of the actual field element with the given name exists and returns
@@ -52,8 +54,9 @@ interface IAttributeFormField extends IFormField
      * If the actual field element does not have the given attribute, this method silently ignores that fact.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid
+     * @return      static                          this form field
      */
-    public function removeFieldAttribute(string $name): self;
+    public function removeFieldAttribute(string $name);
 
     /**
      * Checks if the given name is a valid additional attribute name.
index 98ced7344040c26ce8e120f0ea3285e5edb8db47..d3d5b915d75fdf018dabd179186d34e3831f8bda 100644 (file)
@@ -20,8 +20,9 @@ interface IAutoCompleteFormField
      * Multiple tokens can be separated by spaces and if `null` is given, the attribute is unset.
      *
      * @throws      \InvalidArgumentException       if an invalid `autocomplete` token is included in the attribute value
+     * @return      static                          this form field
      */
-    public function autoComplete(?string $autoComplete): self;
+    public function autoComplete(?string $autoComplete);
 
     /**
      * Returns the `autocomplete` attribute of the form field.
index 1d35df8e3a53f42f568716fd547c875ae3110106..dffc7725344a61ed1dab37f2d6b153eda278d09d 100644 (file)
@@ -17,15 +17,17 @@ interface ICssClassFormField extends IFormField
      * Adds the given CSS class to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if the given class is invalid
+     * @return      static                          this form field
      */
-    public function addFieldClass(string $class): self;
+    public function addFieldClass(string $class);
 
     /**
      * Adds the given CSS classes to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if any of the given classes is invalid
+     * @return      static                          this form field
      */
-    public function addFieldClasses(array $classes): self;
+    public function addFieldClasses(array $classes);
 
     /**
      * Returns all CSS classes of the actual field element.
@@ -46,6 +48,7 @@ interface ICssClassFormField extends IFormField
      * If the actual field element does not have the given CSS class, this method silently ignores that fact.
      *
      * @throws      \InvalidArgumentException       if the given class is invalid
+     * @return      static                          this form field
      */
-    public function removeFieldClass(string $class): self;
+    public function removeFieldClass(string $class);
 }
index 65cae1c89adaf2c4bf0fc587d1e0150b31d9d94e..e9cde39408bf4100e5dee8a091aca78292d966a7 100644 (file)
@@ -27,6 +27,7 @@ interface IInputModeFormField
      * If `null` is given, the attribute is unset.
      *
      * @throws      \InvalidArgumentException       if an invalid `inputmode` token is included in the attribute value
+     * @return      static                          this form field
      */
-    public function inputMode(?string $inputMode): self;
+    public function inputMode(?string $inputMode);
 }
index 87a2113f7fa8ad358db5f52e1b5e40478146c583..e5dd5be41f8c12f5b518e9bb1340d0bf3ba45d0e 100644 (file)
@@ -25,6 +25,8 @@ interface IPatternFormField
      * Sets the `pattern` attribute of the form field.
      *
      * If `null` is given, the attribute is unset.
+     *
+     * @return      static  this form field
      */
-    public function pattern(?string $pattern): self;
+    public function pattern(?string $pattern);
 }
index 017755366bd7847c286c8085a3547143615b9c9d..12f1e1b803689f01b7fa6df63794cd75ee77c6c7 100644 (file)
@@ -36,7 +36,7 @@ final class RejectEverythingFormField extends AbstractFormField
     /**
      * @inheritDoc
      */
-    public function readValue(): self
+    public function readValue()
     {
         return $this;
     }
index 66198ca7c4daf7f89c33b456e6b5a74dafcaeb22..211774bd59dc3645824d17832c1378cc096b97e1 100644 (file)
@@ -40,8 +40,9 @@ trait TAttributeFormField
      * Returns the value of the additional attribute of the actual field element with the given name.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid or no such attribute exists
+     * @return      static                          this form field
      */
-    public function getFieldAttribute(string $name): self
+    public function getFieldAttribute(string $name)
     {
         if (!$this->hasFieldAttribute($name)) {
             throw new \InvalidArgumentException("Unknown attribute '{$name}' requested.");
@@ -62,8 +63,9 @@ trait TAttributeFormField
      * Adds the given additional attribute to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid
+     * @return      static                          this form field
      */
-    public function fieldAttribute(string $name, ?string $value = null): self
+    public function fieldAttribute(string $name, ?string $value = null)
     {
         static::validateFieldAttribute($name);
 
@@ -91,8 +93,9 @@ trait TAttributeFormField
      * If the actual field element does not have the given attribute, this method silently ignores that fact.
      *
      * @throws      \InvalidArgumentException       if the given attribute is invalid
+     * @return      static                          this form field
      */
-    public function removeFieldAttribute(string $name): self
+    public function removeFieldAttribute(string $name)
     {
         static::validateFieldAttribute($name);
 
index 3acc159efd71381f0df53dfc885474b174234bb9..624a2bc2cd985b0ac01d49b149d716512ea639cd 100644 (file)
@@ -22,8 +22,9 @@ trait TAutoCompleteFormField
      * Multiple tokens can be separated by spaces and if `null` is given, the attribute is unset.
      *
      * @throws      \InvalidArgumentException       if an invalid `autocomplete` token is included in the attribute value
+     * @return      static                          this form field
      */
-    public function autocomplete(?string $autoComplete): self
+    public function autocomplete(?string $autoComplete)
     {
         if ($autoComplete !== null && $autoComplete !== 'on' && $autoComplete !== 'off') {
             if (\preg_match('~^(?:section-\w+ )?(?:(shipping|billing) )?(?P<token>.+)$~', $autoComplete, $matches)) {
index d87f27dccd80817197197584ed0281f215d114a3..772db01742030216dae3b3bda15f18c0d33740df 100644 (file)
@@ -23,8 +23,9 @@ trait TCssClassFormField
      * Adds the given CSS class to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if the given class is invalid
+     * @return      static                          this form field
      */
-    public function addFieldClass(string $class): self
+    public function addFieldClass(string $class)
     {
         static::validateClass($class);
 
@@ -39,8 +40,9 @@ trait TCssClassFormField
      * Adds the given CSS classes to the actual field element and returns this field.
      *
      * @throws      \InvalidArgumentException       if any of the given classes is invalid
+     * @return      static                          this form field
      */
-    public function addFieldClasses(array $classes): self
+    public function addFieldClasses(array $classes)
     {
         foreach ($classes as $class) {
             $this->addFieldClass($class);
@@ -76,8 +78,9 @@ trait TCssClassFormField
      * If the actual field element does not have the given CSS class, this method silently ignores that fact.
      *
      * @throws      \InvalidArgumentException       if the given class is invalid
+     * @return      static                          this form field
      */
-    public function removeFieldClass(string $class): self
+    public function removeFieldClass(string $class)
     {
         static::validateClass($class);
 
index a6fcc5931d466027ed81a39de8221a3336edcd69..64496c9cc4b83e2c046fc1015ffc781da1d8ebca 100644 (file)
@@ -32,8 +32,9 @@ trait TInputModeFormField
      * If `null` is given, the attribute is unset.
      *
      * @throws      \InvalidArgumentException       if an invalid `inputmode` token is included in the attribute value
+     * @return      static                          this form field
      */
-    public function inputMode(?string $inputMode): self
+    public function inputMode(?string $inputMode)
     {
         if ($inputMode !== null && $inputMode !== 'none' && !\in_array($inputMode, $this->getValidInputModes())) {
             throw new \InvalidArgumentException("Invalid inputmode attribute '{$inputMode}'.");
index bc211ee262057192ce8fc9b016c35f31c3242c9c..239794c4cc22ccefab2dfb24de75fe714265ebc5 100644 (file)
@@ -30,8 +30,10 @@ trait TPatternFormField
      * Sets the `pattern` attribute of the form field.
      *
      * If `null` is given, the attribute is unset.
+     *
+     * @return      static      this form field
      */
-    public function pattern(?string $pattern): self
+    public function pattern(?string $pattern)
     {
         $this->pattern = $pattern;