Loosen caption typehints where possible (forward compatibility with N…

…ette Forms 3.2)
nepada · Jan 9, 2024 · cc9bc9f · cc9bc9f
1 parent 47256f3
commit cc9bc9f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -40,19 +40,19 @@ parameters:
             count: 1
             path: src/FileUploadControl/FileUploadControl.php
         -
-            message: "#^Parameter \\#1 \\$caption \\(Nette\\\\Utils\\\\Html\\|string\\|null\\) of method Nepada\\\\FileUploadControl\\\\FileUploadControl\\:\\:getLabel\\(\\) should be contravariant with parameter \\$caption \\(object\\|string(?:\\|null)?\\) of method Nextras\\\\FormComponents\\\\Fragments\\\\UIControl\\\\BaseControl\\:\\:getLabel\\(\\)$#"
+            message: "#^Parameter \\#1 \\$caption \\(string\\|Stringable\\|null\\) of method Nepada\\\\FileUploadControl\\\\FileUploadControl\\:\\:getLabel\\(\\) should be contravariant with parameter \\$caption \\(object\\|string(?:\\|null)?\\) of method Nextras\\\\FormComponents\\\\Fragments\\\\UIControl\\\\BaseControl\\:\\:getLabel\\(\\)$#"
             count: 1
             path: src/FileUploadControl/FileUploadControl.php
         -
-            message: "#^Parameter \\#2 \\$errorMessage \\(Nette\\\\Utils\\\\Html\\|string\\|null\\) of method Nepada\\\\FileUploadControl\\\\FileUploadControl\\:\\:addRule\\(\\) should be contravariant with parameter \\$errorMessage \\(object\\|string(?:\\|null)?\\) of method Nextras\\\\FormComponents\\\\Fragments\\\\UIControl\\\\BaseControl\\:\\:addRule\\(\\)$#"
+            message: "#^Parameter \\#2 \\$errorMessage \\(string\\|Stringable\\|null\\) of method Nepada\\\\FileUploadControl\\\\FileUploadControl\\:\\:addRule\\(\\) should be contravariant with parameter \\$errorMessage \\(object\\|string(?:\\|null)?\\) of method Nextras\\\\FormComponents\\\\Fragments\\\\UIControl\\\\BaseControl\\:\\:addRule\\(\\)$#"
             count: 1
             path: src/FileUploadControl/FileUploadControl.php
         -
             message: "#^Parameter \\#1 \\$value \\(bool\\|string\\|Stringable\\) of method Nepada\\\\FileUploadControl\\\\FileUploadControl\\:\\:setRequired\\(\\) should be contravariant with parameter \\$value \\(bool\\|object\\|string\\) of method Nextras\\\\FormComponents\\\\Fragments\\\\UIControl\\\\BaseControl\\:\\:setRequired\\(\\)$#"
             count: 1
             path: src/FileUploadControl/FileUploadControl.php
         -
-            message: "#^Method Nepada\\\\FileUploadControl\\\\Validation\\\\FakeUploadControl\\:\\:getCaption\\(\\) should return Nette\\\\Utils\\\\Html\\|string\\|null but returns object\\|string\\.$#"
+            message: "#^Method Nepada\\\\FileUploadControl\\\\Validation\\\\FakeUploadControl\\:\\:getCaption\\(\\) should return string\\|Stringable\\|null but returns object\\|string\\.$#"
             count: 1
             path: src/FileUploadControl/Validation/FakeUploadControl.php
         -

diff --git a/src/FileUploadControl/FileUploadControl.php b/src/FileUploadControl/FileUploadControl.php
@@ -46,7 +46,7 @@ class FileUploadControl extends BaseControl
 
     private bool $httpDataLoaded = false;
 
-    public function __construct(StorageManager $storageManager, string|Html|null $caption = null)
+    public function __construct(StorageManager $storageManager, string|\Stringable|null $caption = null)
     {
         parent::__construct($caption);
         $this->storageManager = $storageManager;
@@ -214,7 +214,7 @@ public function getLabelPrototype(): Html
 
     /**
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
-     * @param string|Html|null $caption
+     * @param string|\Stringable|null $caption
      */
     public function getLabel($caption = null): Html
     {
@@ -226,7 +226,7 @@ public function getLabel($caption = null): Html
     /**
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      * @param callable|string $validator
-     * @param string|Html|null $errorMessage
+     * @param string|\Stringable|null $errorMessage
      * @return $this
      */
     public function addRule($validator, $errorMessage = null, mixed $arg = null): static

diff --git a/src/FileUploadControl/Validation/FakeUploadControl.php b/src/FileUploadControl/Validation/FakeUploadControl.php
@@ -7,7 +7,6 @@
 use Nette\Forms\Controls\UploadControl;
 use Nette\Forms\Form;
 use Nette\Http\FileUpload;
-use Nette\Utils\Html;
 
 /**
  * @internal
@@ -38,7 +37,7 @@ public function getFileUploadControl(): FileUploadControl
         return $this->fileUploadControl;
     }
 
-    public function getCaption(): Html|string|null
+    public function getCaption(): \Stringable|string|null
     {
         return $this->fileUploadControl->getCaption();
     }

diff --git a/tests/PHPStan/conditional.config.php b/tests/PHPStan/conditional.config.php
@@ -33,7 +33,7 @@
         'count' => 1,
     ];
     $config['parameters']['ignoreErrors'][] = [
-        'message' => '#^Return type \\(Nette\\\\Utils\\\\Html\\|string\\|null\\) of method Nepada\\\\FileUploadControl\\\\Validation\\\\FakeUploadControl\\:\\:getCaption\\(\\) should be covariant with return type \\(object\\|string\\) of method Nette\\\\Forms\\\\Controls\\\\BaseControl\\:\\:getCaption\\(\\)$#',
+        'message' => '#^Return type \\(string\\|Stringable\\|null\\) of method Nepada\\\\FileUploadControl\\\\Validation\\\\FakeUploadControl\\:\\:getCaption\\(\\) should be covariant with return type \\(object\\|string\\) of method Nette\\\\Forms\\\\Controls\\\\BaseControl\\:\\:getCaption\\(\\)$#',
         'path' => '../../src/FileUploadControl/Validation/FakeUploadControl.php',
         'count' => 1,
     ];