Psalm seemed to thing of "set" as a type (#1722)

pradtke · web-flow · commit 6d8486e75d88 · 2022-12-05T23:56:26.000+01:00
diff --git a/src/SimpleSAML/Configuration.php b/src/SimpleSAML/Configuration.php
@@ -613,7 +613,7 @@ public function getBoolean(string $name): bool
      *                            The default value can be null or a boolean.
      *
      * @return bool|null          The option with the given name, or $default.
-     * @psalm-return              ($default is set ? bool|null : bool)
+     * @psalm-return              ($default is bool ? bool : bool|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not boolean.
      */
@@ -667,7 +667,7 @@ public function getString(string $name): string
      *                               The default value can be null or a string.
      *
      * @return string|null The option with the given name, or $default if the option isn't found.
-     * @psalm-return       ($default is set ? string|null : string)
+     * @psalm-return       ($default is string ? string : string|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not a string.
      */
@@ -717,11 +717,11 @@ public function getInteger(string $name): int
      * An exception will be thrown if this option isn't an integer.
      *
      * @param string $name     The name of the option.
-     * @param mixed  $default  A default value which will be returned if the option isn't found.
+     * @param int|null  $default  A default value which will be returned if the option isn't found.
      *                         The default value can be null or an integer.
      *
      * @return int|null The option with the given name, or $default if the option isn't found.
-     * @psalm-return           ($default is set ? int|null : int)
+     * @psalm-return           ($default is int ? int : int|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an integer.
      */
@@ -792,7 +792,7 @@ public function getIntegerRange(string $name, int $minimum, int $maximum): int
      *
      * @return int|null The option with the given name, or $default if the option isn't found and $default is
      *     specified.
-     * @psalm-return    ($default is set ? int|null : int)
+     * @psalm-return    ($default is int ? int : int|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not in the range specified.
      */
@@ -917,7 +917,7 @@ public function getArray(string $name): array
      *
      * @return array|null The option with the given name, or $default if the option isn't found and $default is
      * specified.
-     * @psalm-return      ($default is set ? array|null : array)
+     * @psalm-return      ($default is array ? array : array|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an array.
      */
@@ -965,7 +965,7 @@ public function getArrayize(string $name): array
      *                       The default value can be null or an array.
      *
      * @return array|null The option with the given name.
-     * @psalm-return      ($default is set ? array|null : array)
+     * @psalm-return      ($default is null ? array|null : array)
      */
     public function getOptionalArrayize(string $name, $default): ?array
     {
@@ -1017,7 +1017,7 @@ public function getArrayizeString(string $name): array
      *
      * @return string[]|null The option with the given name, or $default if the option isn't found
      *                         and $default is specified.
-     * @psalm-return         ($default is set ? array|null : array)
+     * @psalm-return         ($default is null ? array|null : array)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not a string or an array of strings.
      */
@@ -1075,7 +1075,7 @@ public function getConfigItem(string $name): Configuration
      *
      * @return \SimpleSAML\Configuration|null The option with the given name,
      *   or $default, converted into a Configuration object.
-     * @psalm-return     ($default is set ? \SimpleSAML\Configuration|null : \SimpleSAML\Configuration)
+     * @psalm-return     ($default is array ? \SimpleSAML\Configuration : \SimpleSAML\Configuration|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an array.
      */
@@ -1325,10 +1325,10 @@ public function getLocalizedString(string $name): array
      * The default language returned is always 'en'.
      *
      * @param string $name The name of the option.
-     * @param mixed  $default The default value.
+     * @param array|null  $default The default value.
      *
      * @return array|null Associative array with language => string pairs, or the provided default value.
-     * @psalm-return ($default is set ? array|null : array)
+     * @psalm-return ($default is array ? array : array|null)
      *
      * @throws \SimpleSAML\Assert\AssertionFailedException
      *   If the translation is not an array or a string, or its index or value are not strings.

Original file line number	Diff line number	Diff line change
`@@ -613,7 +613,7 @@ public function getBoolean(string $name): bool`
`613`	`613`	`* The default value can be null or a boolean.`
`614`	`614`	`*`
`615`	`615`	`* @return bool\|null The option with the given name, or $default.`
`616`		`- * @psalm-return ($default is set ? bool\|null : bool)`
	`616`	`+ * @psalm-return ($default is bool ? bool : bool\|null)`
`617`	`617`	`*`
`618`	`618`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not boolean.`
`619`	`619`	`*/`
`@@ -667,7 +667,7 @@ public function getString(string $name): string`
`667`	`667`	`* The default value can be null or a string.`
`668`	`668`	`*`
`669`	`669`	`* @return string\|null The option with the given name, or $default if the option isn't found.`
`670`		`- * @psalm-return ($default is set ? string\|null : string)`
	`670`	`+ * @psalm-return ($default is string ? string : string\|null)`
`671`	`671`	`*`
`672`	`672`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not a string.`
`673`	`673`	`*/`
`@@ -717,11 +717,11 @@ public function getInteger(string $name): int`
`717`	`717`	`* An exception will be thrown if this option isn't an integer.`
`718`	`718`	`*`
`719`	`719`	`* @param string $name The name of the option.`
`720`		`- * @param mixed $default A default value which will be returned if the option isn't found.`
	`720`	`+ * @param int\|null $default A default value which will be returned if the option isn't found.`
`721`	`721`	`* The default value can be null or an integer.`
`722`	`722`	`*`
`723`	`723`	`* @return int\|null The option with the given name, or $default if the option isn't found.`
`724`		`- * @psalm-return ($default is set ? int\|null : int)`
	`724`	`+ * @psalm-return ($default is int ? int : int\|null)`
`725`	`725`	`*`
`726`	`726`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an integer.`
`727`	`727`	`*/`
`@@ -792,7 +792,7 @@ public function getIntegerRange(string $name, int $minimum, int $maximum): int`
`792`	`792`	`*`
`793`	`793`	`* @return int\|null The option with the given name, or $default if the option isn't found and $default is`
`794`	`794`	`* specified.`
`795`		`- * @psalm-return ($default is set ? int\|null : int)`
	`795`	`+ * @psalm-return ($default is int ? int : int\|null)`
`796`	`796`	`*`
`797`	`797`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not in the range specified.`
`798`	`798`	`*/`
`@@ -917,7 +917,7 @@ public function getArray(string $name): array`
`917`	`917`	`*`
`918`	`918`	`* @return array\|null The option with the given name, or $default if the option isn't found and $default is`
`919`	`919`	`* specified.`
`920`		`- * @psalm-return ($default is set ? array\|null : array)`
	`920`	`+ * @psalm-return ($default is array ? array : array\|null)`
`921`	`921`	`*`
`922`	`922`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an array.`
`923`	`923`	`*/`
`@@ -965,7 +965,7 @@ public function getArrayize(string $name): array`
`965`	`965`	`* The default value can be null or an array.`
`966`	`966`	`*`
`967`	`967`	`* @return array\|null The option with the given name.`
`968`		`- * @psalm-return ($default is set ? array\|null : array)`
	`968`	`+ * @psalm-return ($default is null ? array\|null : array)`
`969`	`969`	`*/`
`970`	`970`	`public function getOptionalArrayize(string $name, $default): ?array`
`971`	`971`	`{`
`@@ -1017,7 +1017,7 @@ public function getArrayizeString(string $name): array`
`1017`	`1017`	`*`
`1018`	`1018`	`* @return string[]\|null The option with the given name, or $default if the option isn't found`
`1019`	`1019`	`* and $default is specified.`
`1020`		`- * @psalm-return ($default is set ? array\|null : array)`
	`1020`	`+ * @psalm-return ($default is null ? array\|null : array)`
`1021`	`1021`	`*`
`1022`	`1022`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not a string or an array of strings.`
`1023`	`1023`	`*/`
`@@ -1075,7 +1075,7 @@ public function getConfigItem(string $name): Configuration`
`1075`	`1075`	`*`
`1076`	`1076`	`* @return \SimpleSAML\Configuration\|null The option with the given name,`
`1077`	`1077`	`* or $default, converted into a Configuration object.`
`1078`		`- * @psalm-return ($default is set ? \SimpleSAML\Configuration\|null : \SimpleSAML\Configuration)`
	`1078`	`+ * @psalm-return ($default is array ? \SimpleSAML\Configuration : \SimpleSAML\Configuration\|null)`
`1079`	`1079`	`*`
`1080`	`1080`	`* @throws \SimpleSAML\Assert\AssertionFailedException If the option is not an array.`
`1081`	`1081`	`*/`
`@@ -1325,10 +1325,10 @@ public function getLocalizedString(string $name): array`
`1325`	`1325`	`* The default language returned is always 'en'.`
`1326`	`1326`	`*`
`1327`	`1327`	`* @param string $name The name of the option.`
`1328`		`- * @param mixed $default The default value.`
	`1328`	`+ * @param array\|null $default The default value.`
`1329`	`1329`	`*`
`1330`	`1330`	`* @return array\|null Associative array with language => string pairs, or the provided default value.`
`1331`		`- * @psalm-return ($default is set ? array\|null : array)`
	`1331`	`+ * @psalm-return ($default is array ? array : array\|null)`
`1332`	`1332`	`*`
`1333`	`1333`	`* @throws \SimpleSAML\Assert\AssertionFailedException`
`1334`	`1334`	`* If the translation is not an array or a string, or its index or value are not strings.`