Merge pull request #78 from kenjis/fix-phpdocs-setting

kenjis · web-flow · commit ef569ec40929 · 2023-05-17T08:08:02.000+09:00
docs: fix PHPDoc types in setting()
diff --git a/src/Helpers/setting_helper.php b/src/Helpers/setting_helper.php
@@ -6,9 +6,10 @@
     /**
      * Provides a convenience interface to the Settings service.
      *
-     * @param mixed|null $value
+     * @param mixed $value
      *
      * @return array|bool|float|int|object|Settings|string|void|null
+     * @phpstan-return ($key is null ? Settings : ($value is null ? array|bool|float|int|object|string|null : void))
      */
     function setting(?string $key = null, $value = null)
     {

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,10 @@`
`6`	`6`	`/**`
`7`	`7`	`* Provides a convenience interface to the Settings service.`
`8`	`8`	`*`
`9`		`- * @param mixed\|null $value`
	`9`	`+ * @param mixed $value`
`10`	`10`	`*`
`11`	`11`	`* @return array\|bool\|float\|int\|object\|Settings\|string\|void\|null`
	`12`	`+ * @phpstan-return ($key is null ? Settings : ($value is null ? array\|bool\|float\|int\|object\|string\|null : void))`
`12`	`13`	`*/`
`13`	`14`	`function setting(?string $key = null, $value = null)`
`14`	`15`	`{`