Aliases

.junie/guidelines.md

@@ -20,10 +20,9 @@
 
 ## Folder structure
 
-- `src/Code` folder contains the framework internal code
+- `src/Abstract` folder contains the framework internal code
 - other folders like `src/"type"` contains specific types
 - `src/psalmTest.php` contains types usage to avoid Psalm issues like `unused method`
-- `src/Code/Assert/Assert.php` contains `assert` methods, add new methods instead of checking conditions directly in classes. Prefer to use Assert::"methos()".
 
 ## Tests
 

docs/USAGE.md

@@ -129,9 +129,9 @@ declare(strict_types=1);
 
 namespace App\Domain;
 
-use PhpTypedValues\Code\Assert\Assert;
-use PhpTypedValues\Code\Exception\FloatTypeException;
-use PhpTypedValues\Code\Integer\IntType;
+use PhpTypedValues\Abstract\Assert\Assert;
+use PhpTypedValues\Exception\FloatTypeException;
+use PhpTypedValues\Abstract\Integer\IntType;
 
 final class EvenPositiveInt extends IntType
 {

src/Code/DateTime/DateTimeType.php → src/Abstract/DateTime/DateTimeType.php

@@ -2,14 +2,14 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\DateTime;
+namespace PhpTypedValues\Abstract\DateTime;
 
 use const PHP_EOL;
 
 use DateTimeImmutable;
 use DateTimeZone;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
-use PhpTypedValues\Code\Exception\ReasonableRangeDateTimeTypeException;
+use PhpTypedValues\Exception\DateTimeTypeException;
+use PhpTypedValues\Exception\ReasonableRangeDateTimeTypeException;
 
 use function count;
 use function sprintf;

src/Code/DateTime/DateTimeTypeInterface.php → src/Abstract/DateTime/DateTimeTypeInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\DateTime;
+namespace PhpTypedValues\Abstract\DateTime;
 
 use DateTimeImmutable;
 

src/Code/Float/FloatType.php → src/Abstract/Float/FloatType.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Float;
+namespace PhpTypedValues\Abstract\Float;
 
-use PhpTypedValues\Code\Exception\FloatTypeException;
+use PhpTypedValues\Exception\FloatTypeException;
 
 use function sprintf;
 

src/Code/Float/FloatTypeInterface.php → src/Abstract/Float/FloatTypeInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Float;
+namespace PhpTypedValues\Abstract\Float;
 
 /**
  * @psalm-immutable

src/Code/Integer/IntType.php → src/Abstract/Integer/IntType.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Integer;
+namespace PhpTypedValues\Abstract\Integer;
 
-use PhpTypedValues\Code\Exception\IntegerTypeException;
+use PhpTypedValues\Exception\IntegerTypeException;
 
 use function sprintf;
 

src/Code/Integer/IntTypeInterface.php → src/Abstract/Integer/IntTypeInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Integer;
+namespace PhpTypedValues\Abstract\Integer;
 
 /**
  * @psalm-immutable

src/Code/String/StrType.php → src/Abstract/String/StrType.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\String;
+namespace PhpTypedValues\Abstract\String;
 
 /**
  * @psalm-immutable

src/Code/String/StrTypeInterface.php → src/Abstract/String/StrTypeInterface.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\String;
+namespace PhpTypedValues\Abstract\String;
 
 /**
  * @psalm-immutable

src/DateTime/DateTimeAtom.php

@@ -8,12 +8,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 /**
  * ATOM RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeAtom extends DateTimeType

src/DateTime/DateTimeRFC3339.php

@@ -8,12 +8,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 /**
  * RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeRFC3339 extends DateTimeType

src/DateTime/DateTimeRFC3339Extended.php

@@ -8,11 +8,13 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 /**
- * RFC 3339 EXTENDED format based on ISO 8601.
+ * RFC 3339 EXTENDED format based on ISO 8601 (with microseconds).
+ *
+ * Example "2025-01-02T03:04:05.123456+00:00"
  *
  * @psalm-immutable
  */

src/DateTime/DateTimeW3C.php

@@ -8,12 +8,14 @@
 
 use DateTimeImmutable;
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 /**
  * W3C RFC 3339 format based on ISO 8601.
  *
+ * Example "2025-01-02T03:04:05+00:00"
+ *
  * @psalm-immutable
  */
 readonly class DateTimeW3C extends DateTimeType

src/DateTime/Timestamp/TimestampMilliseconds.php

@@ -5,14 +5,16 @@
 namespace PhpTypedValues\DateTime\Timestamp;
 
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 use function intdiv;
 use function sprintf;
 
 /**
- * Unix timestamp in milliseconds since Unix epoch (UTC), e.g. "1732445696123".
+ * Unix timestamp in milliseconds since Unix epoch (UTC).
+ *
+ * Example "1732445696123"
  *
  * @psalm-immutable
  */

src/DateTime/Timestamp/TimestampSeconds.php

@@ -5,11 +5,13 @@
 namespace PhpTypedValues\DateTime\Timestamp;
 
 use DateTimeZone;
-use PhpTypedValues\Code\DateTime\DateTimeType;
-use PhpTypedValues\Code\Exception\DateTimeTypeException;
+use PhpTypedValues\Abstract\DateTime\DateTimeType;
+use PhpTypedValues\Exception\DateTimeTypeException;
 
 /**
- * Unix timestamp (seconds since Unix epoch, UTC), e.g. "1732445696".
+ * Unix timestamp (seconds since Unix epoch, UTC).
+ *
+ * Example "1732445696"
  *
  * @psalm-immutable
  */

src/Code/Exception/DateTimeTypeException.php → src/Exception/DateTimeTypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 class DateTimeTypeException extends TypeException
 {

src/Code/Exception/FloatTypeException.php → src/Exception/FloatTypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 class FloatTypeException extends TypeException
 {

src/Code/Exception/IntegerTypeException.php → src/Exception/IntegerTypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 class IntegerTypeException extends TypeException
 {

src/Code/Exception/ReasonableRangeDateTimeTypeException.php → src/Exception/ReasonableRangeDateTimeTypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 class ReasonableRangeDateTimeTypeException extends DateTimeTypeException
 {

src/Code/Exception/StringTypeException.php → src/Exception/StringTypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 class StringTypeException extends TypeException
 {

src/Code/Exception/TypeException.php → src/Exception/TypeException.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace PhpTypedValues\Code\Exception;
+namespace PhpTypedValues\Exception;
 
 use Exception;
 

src/Float/Alias/FloatType.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Float\Alias;
+
+use PhpTypedValues\Float\FloatStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class FloatType extends FloatStandard
+{
+}

src/Float/Alias/NonNegativeFloat.php

@@ -7,6 +7,10 @@
 use PhpTypedValues\Float\FloatNonNegative;
 
 /**
+ * Alias of Non-negative float (>= 0.0).
+ *
+ * Example "0.0"
+ *
  * @psalm-immutable
  */
 readonly class NonNegativeFloat extends FloatNonNegative

src/Float/FloatNonNegative.php

@@ -4,12 +4,16 @@
 
 namespace PhpTypedValues\Float;
 
-use PhpTypedValues\Code\Exception\FloatTypeException;
-use PhpTypedValues\Code\Float\FloatType;
+use PhpTypedValues\Abstract\Float\FloatType;
+use PhpTypedValues\Exception\FloatTypeException;
 
 use function sprintf;
 
 /**
+ * Non-negative float (>= 0.0).
+ *
+ * Example "0.0"
+ *
  * @psalm-immutable
  */
 readonly class FloatNonNegative extends FloatType

src/Float/FloatStandard.php

@@ -4,12 +4,14 @@
 
 namespace PhpTypedValues\Float;
 
-use PhpTypedValues\Code\Exception\FloatTypeException;
-use PhpTypedValues\Code\Float\FloatType;
+use PhpTypedValues\Abstract\Float\FloatType;
+use PhpTypedValues\Exception\FloatTypeException;
 
 /**
  * Represents any PHP float (double).
  *
+ * Example "3.14"
+ *
  * @psalm-immutable
  */
 readonly class FloatStandard extends FloatType

src/Integer/Alias/Id.php

@@ -7,6 +7,10 @@
 use PhpTypedValues\Integer\IntegerPositive;
 
 /**
+ * Alias of Positive integer used as identifier.
+ *
+ * Example "42"
+ *
  * @psalm-immutable
  */
 readonly class Id extends IntegerPositive

src/Integer/Alias/IntType.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpTypedValues\Integer\Alias;
+
+use PhpTypedValues\Integer\IntegerStandard;
+
+/**
+ * @psalm-immutable
+ */
+readonly class IntType extends IntegerStandard
+{
+}

src/Integer/Alias/NonNegativeInt.php

@@ -7,6 +7,10 @@
 use PhpTypedValues\Integer\IntegerNonNegative;
 
 /**
+ * Alias of Non-negative integer (>= 0).
+ *
+ * Example "0"
+ *
  * @psalm-immutable
  */
 readonly class NonNegativeInt extends IntegerNonNegative

src/Integer/Alias/PositiveInt.php

@@ -7,6 +7,10 @@
 use PhpTypedValues\Integer\IntegerPositive;
 
 /**
+ * Alias of Positive integer (> 0).
+ *
+ * Example "1"
+ *
  * @psalm-immutable
  */
 readonly class PositiveInt extends IntegerPositive

src/Integer/IntegerNonNegative.php

@@ -4,12 +4,16 @@
 
 namespace PhpTypedValues\Integer;
 
-use PhpTypedValues\Code\Exception\IntegerTypeException;
-use PhpTypedValues\Code\Integer\IntType;
+use PhpTypedValues\Abstract\Integer\IntType;
+use PhpTypedValues\Exception\IntegerTypeException;
 
 use function sprintf;
 
 /**
+ * Non-negative integer (>= 0).
+ *
+ * Example "0"
+ *
  * @psalm-immutable
  */
 readonly class IntegerNonNegative extends IntType