Add getKey() return type as string

simPod · simPod · commit a681789b9b7c · 2021-02-10T20:05:49.000+01:00
diff --git a/src/Enum.php b/src/Enum.php
@@ -83,9 +83,8 @@ public function getValue()
      * Returns the enum key (i.e. the constant name).
      *
      * @psalm-pure
-     * @return mixed
      */
-    public function getKey()
+    public function getKey(): string
     {
         return static::search($this->value);
     }
@@ -200,11 +199,11 @@ public static function isValidKey($key)
     /**
      * Return key for value
      *
-     * @param $value
+     * @param mixed $value
      *
      * @psalm-param mixed $value
      * @psalm-pure
-     * @return mixed
+     * @return string|false
      */
     public static function search($value)
     {

Original file line number	Diff line number	Diff line change
`@@ -83,9 +83,8 @@ public function getValue()`
`83`	`83`	`* Returns the enum key (i.e. the constant name).`
`84`	`84`	`*`
`85`	`85`	`* @psalm-pure`
`86`		`- * @return mixed`
`87`	`86`	`*/`
`88`		`- public function getKey()`
	`87`	`+ public function getKey(): string`
`89`	`88`	`{`
`90`	`89`	`return static::search($this->value);`
`91`	`90`	`}`
`@@ -200,11 +199,11 @@ public static function isValidKey($key)`
`200`	`199`	`/**`
`201`	`200`	`* Return key for value`
`202`	`201`	`*`
`203`		`- * @param $value`
	`202`	`+ * @param mixed $value`
`204`	`203`	`*`
`205`	`204`	`* @psalm-param mixed $value`
`206`	`205`	`* @psalm-pure`
`207`		`- * @return mixed`
	`206`	`+ * @return string\|false`
`208`	`207`	`*/`
`209`	`208`	`public static function search($value)`
`210`	`209`	`{`