Add getKey() return type as string

simPod · simPod · commit 86949d6e7c3f · 2020-08-19T08:59:17.000+02:00
diff --git a/src/Enum.php b/src/Enum.php
@@ -76,9 +76,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);
     }
@@ -193,11 +192,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
`@@ -76,9 +76,8 @@ public function getValue()`
`76`	`76`	`* Returns the enum key (i.e. the constant name).`
`77`	`77`	`*`
`78`	`78`	`* @psalm-pure`
`79`		`- * @return mixed`
`80`	`79`	`*/`
`81`		`- public function getKey()`
	`80`	`+ public function getKey(): string`
`82`	`81`	`{`
`83`	`82`	`return static::search($this->value);`
`84`	`83`	`}`
`@@ -193,11 +192,11 @@ public static function isValidKey($key)`
`193`	`192`	`/**`
`194`	`193`	`* Return key for value`
`195`	`194`	`*`
`196`		`- * @param $value`
	`195`	`+ * @param mixed $value`
`197`	`196`	`*`
`198`	`197`	`* @psalm-param mixed $value`
`199`	`198`	`* @psalm-pure`
`200`		`- * @return mixed`
	`199`	`+ * @return string\|false`
`201`	`200`	`*/`
`202`	`201`	`public static function search($value)`
`203`	`202`	`{`