Merge pull request #6 from michael-rubel/patch/method-comments

Allow passing `null` to `makeOrNull` method

Author: michael-rubel

src/Collection/Complex/ClassString.php

@@ -25,7 +25,7 @@
  *
  * @method static static make(string $string)
  * @method static static from(string $string)
- * @method static static makeOrNull(string $string)
+ * @method static static makeOrNull(string|null $string)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Complex/FullName.php

@@ -28,7 +28,7 @@
  *
  * @method static static make(string|Stringable $value)
  * @method static static from(string|Stringable $value)
- * @method static static makeOrNull(string|Stringable $value)
+ * @method static static makeOrNull(string|Stringable|null $value)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Complex/Name.php

@@ -25,7 +25,7 @@
  *
  * @method static static make(string|Stringable $value)
  * @method static static from(string|Stringable $value)
- * @method static static makeOrNull(string|Stringable $value)
+ * @method static static makeOrNull(string|Stringable|null $value)
  *
  * @extends Text<TKey, TValue>
  */

src/Collection/Complex/TaxNumber.php

@@ -26,7 +26,7 @@
  *
  * @method static static make(string $number, string|null $prefix = null)
  * @method static static from(string $number, string|null $prefix = null)
- * @method static static makeOrNull(string $number, string|null $prefix = null)
+ * @method static static makeOrNull(string|null $number, string|null $prefix = null)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Complex/Uuid.php

@@ -25,7 +25,7 @@
  *
  * @method static static make(string $value, string|null $name = null)
  * @method static static from(string $value, string|null $name = null)
- * @method static static makeOrNull(string $value, string|null $name = null)
+ * @method static static makeOrNull(string|null $value, string|null $name = null)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Primitive/Boolean.php

@@ -25,7 +25,7 @@
  *
  * @method static static make(bool|int|string $value)
  * @method static static from(bool|int|string $value)
- * @method static static makeOrNull(bool|int|string $value)
+ * @method static static makeOrNull(bool|int|string|null $value)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Primitive/Decimal.php

@@ -26,7 +26,7 @@
  *
  * @method static static make(int|string $number, int $scale = 2)
  * @method static static from(int|string $number, int $scale = 2)
- * @method static static makeOrNull(int|string $number, int $scale = 2)
+ * @method static static makeOrNull(int|string|null $number, int $scale = 2)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Primitive/Integer.php

@@ -26,7 +26,7 @@
  *
  * @method static static make(int|string $number)
  * @method static static from(int|string $number)
- * @method static static makeOrNull(int|string $number)
+ * @method static static makeOrNull(int|string|null $number)
  *
  * @extends ValueObject<TKey, TValue>
  */

src/Collection/Primitive/Text.php

@@ -26,7 +26,7 @@
  *
  * @method static static make(string|Stringable $value)
  * @method static static from(string|Stringable $value)
- * @method static static makeOrNull(string|Stringable $value)
+ * @method static static makeOrNull(string|Stringable|null $value)
  *
  * @extends ValueObject<TKey, TValue>
  */

tests/Unit/ValueObjectTest.php

@@ -14,6 +14,7 @@
 });
 
 test('can use makeOrNull', function () {
+    $this->assertNull(Text::makeOrNull(null));
     $this->assertNull(Text::makeOrNull(''));
     $this->assertNull(Text::makeOrNull('')?->value());