Form::getHttpData: Clarify return type

jtojnar · jtojnar · commit ba0b59b15da0 · 2024-05-14T02:05:01.000+02:00
The method will always return an array when `htmlName` is not specified.
This will allow us to remove some PHPStan casts/checks in consuming projects.
diff --git a/src/Forms/Form.php b/src/Forms/Form.php
@@ -457,6 +457,7 @@ public function setSubmittedBy(?SubmitterControl $by): static
 
 	/**
 	 * Returns submitted HTTP data.
+	 * @return ($htmlName is null ? array<mixed> : string|array<mixed>|Nette\Http\FileUpload|null)
 	 */
 	public function getHttpData(?int $type = null, ?string $htmlName = null): string|array|Nette\Http\FileUpload|null
 	{

Original file line number	Diff line number	Diff line change
`@@ -457,6 +457,7 @@ public function setSubmittedBy(?SubmitterControl $by): static`
`457`	`457`
`458`	`458`	`/**`
`459`	`459`	`* Returns submitted HTTP data.`
	`460`	`+ * @return ($htmlName is null ? array<mixed> : string\|array<mixed>\|Nette\Http\FileUpload\|null)`
`460`	`461`	`*/`
`461`	`462`	`public function getHttpData(?int $type = null, ?string $htmlName = null): string\|array\|Nette\Http\FileUpload\|null`
`462`	`463`	`{`