Improve type hints in UniqueGenerator (#345)

spawnia · web-flow · commit 8f2dcaff348b · 2021-07-14T12:46:49.000+02:00
* Improve type hints in UniqueGenerator

This accomplishes:
- Clarifies the intent of the code
- Aids autocompletion
- Aids static analysis tools

* Revert addition of strong type hint

* Explain uniques
diff --git a/src/Faker/UniqueGenerator.php b/src/Faker/UniqueGenerator.php
@@ -3,15 +3,34 @@
 namespace Faker;
 
 /**
- * Proxy for other generators, to return only unique values. Works with
- * Faker\Generator\Base->unique()
+ * Proxy for other generators that returns only unique values.
+ *
+ * Instantiated through @see Generator::unique().
  *
  * @mixin Generator
  */
 class UniqueGenerator
 {
+    /**
+     * @var Generator
+     */
     protected $generator;
+
+    /**
+     * @var int
+     */
     protected $maxRetries;
+
+    /**
+     * Maps from method names to a map with serialized result keys.
+     *
+     * @example [
+     *   'phone' => ['0123' => null],
+     *   'city' => ['London' => null, 'Tokyo' => null],
+     * ]
+     *
+     * @var array<string, array<string, null>>
+     */
     protected $uniques = [];
 
     /**
