Add type specifiers

Author: SerafimArts

example/01.normalization/08.object-output-normalization.php

@@ -23,7 +23,7 @@ public function __construct(
 
 $mapper = new Mapper(
     config: new Configuration(
-        isObjectsAsArrays: true,
+        objectAsArray: true,
     ),
 );
 

example/03.types/02.custom-type.php

@@ -5,7 +5,6 @@
 use TypeLang\Mapper\Context\Context;
 use TypeLang\Mapper\Exception\Runtime\InvalidValueException;
 use TypeLang\Mapper\Mapper;
-use TypeLang\Mapper\Platform\DelegatePlatform;
 use TypeLang\Mapper\Platform\StandardPlatform;
 use TypeLang\Mapper\Type\Builder\SimpleTypeBuilder;
 use TypeLang\Mapper\Type\TypeInterface;
@@ -34,12 +33,10 @@ public function cast(mixed $value, Context $context): string
     }
 }
 
-$mapper = new Mapper(new DelegatePlatform(
-    // Extend existing platform (StandardPlatform)
-    delegate: new StandardPlatform(),
+$mapper = new Mapper(new StandardPlatform(
     types: [
         // Additional type
-        new SimpleTypeBuilder('custom-string', MyNonEmptyStringType::class)
+        new SimpleTypeBuilder('custom-string', MyNonEmptyStringType::class),
     ],
 ));
 

example/04.mapping-readers/02.attribute-mapping.php

@@ -22,7 +22,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

example/04.mapping-readers/03.phpdoc-mapping.php

@@ -33,7 +33,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

example/04.mapping-readers/04.array-mapping.php

@@ -26,7 +26,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

example/04.mapping-readers/05.php-config-mapping.php

@@ -22,7 +22,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

example/04.mapping-readers/06.yaml-config-mapping.php

@@ -22,7 +22,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

example/04.mapping-readers/07.neon-config-mapping.php

@@ -22,7 +22,7 @@ public function __construct(
 );
 
 $mapper = new Mapper($platform, new Configuration(
-    isStrictTypes: false,
+    strictTypes: false,
 ));
 
 var_dump($mapper->denormalize([

src/Configuration.php

@@ -10,27 +10,37 @@
 final class Configuration
 {
     /**
-     * Default value for {@see $isObjectsAsArrays} option.
+     * Default value for {@see $objectAsArray} option.
      */
-    public const OBJECTS_AS_ARRAYS_DEFAULT_VALUE = true;
+    public const DEFAULT_OBJECT_AS_ARRAY_OPTION = true;
 
     /**
-     * Default value for {@see $isStrictTypes} option.
+     * Default value for {@see $strictTypes} option.
      */
-    public const STRICT_TYPES_DEFAULT_VALUE = true;
+    public const DEFAULT_STRICT_TYPES_OPTION = true;
+
+    /**
+     * Default value for {@see $typeSpecifiers} option.
+     */
+    public const DEFAULT_TYPE_SPECIFIERS_OPTION = true;
 
     public function __construct(
         /**
          * If this option contains {@see true}, then objects are converted to
          * associative arrays, otherwise anonymous {@see object} will be
          * returned.
          */
-        private readonly ?bool $isObjectsAsArrays = null,
+        private readonly ?bool $objectAsArray = null,
         /**
          * If this option contains {@see true}, then strict types will
          * be enabled.
          */
-        private readonly ?bool $isStrictTypes = null,
+        private readonly ?bool $strictTypes = null,
+        /**
+         * If this option contains {@see true}, then type specifiers will
+         * be applied.
+         */
+        private readonly ?bool $typeSpecifiers = null,
         /**
          * If this option contains {@see LoggerInterface}, then logger
          * will be enabled.
@@ -55,11 +65,12 @@ public function __construct(
      *
      * @api
      */
-    public function withObjectsAsArrays(?bool $enabled = null): self
+    public function withObjectAsArray(?bool $enabled = null): self
     {
         return new self(
-            isObjectsAsArrays: $enabled,
-            isStrictTypes: $this->isStrictTypes,
+            objectAsArray: $enabled,
+            strictTypes: $this->strictTypes,
+            typeSpecifiers: $this->typeSpecifiers,
             logger: $this->logger,
             tracer: $this->tracer,
         );
@@ -73,18 +84,18 @@ public function withObjectsAsArrays(?bool $enabled = null): self
      */
     public function isObjectAsArray(): bool
     {
-        return $this->isObjectsAsArrays
-            ?? self::OBJECTS_AS_ARRAYS_DEFAULT_VALUE;
+        return $this->objectAsArray
+            ?? self::DEFAULT_OBJECT_AS_ARRAY_OPTION;
     }
 
     /**
      * Returns {@see true} in case option is user-defined.
      *
      * @api
      */
-    public function isObjectsAsArraysOptionDefined(): bool
+    public function isObjectAsArrayOptionDefined(): bool
     {
-        return $this->isObjectsAsArrays !== null;
+        return $this->objectAsArray !== null;
     }
 
     /**
@@ -97,8 +108,9 @@ public function isObjectsAsArraysOptionDefined(): bool
     public function withStrictTypes(?bool $enabled = null): self
     {
         return new self(
-            isObjectsAsArrays: $this->isObjectsAsArrays,
-            isStrictTypes: $enabled,
+            objectAsArray: $this->objectAsArray,
+            strictTypes: $enabled,
+            typeSpecifiers: $this->typeSpecifiers,
             logger: $this->logger,
             tracer: $this->tracer,
         );
@@ -113,8 +125,8 @@ public function withStrictTypes(?bool $enabled = null): self
      */
     public function isStrictTypesEnabled(): bool
     {
-        return $this->isStrictTypes
-            ?? self::STRICT_TYPES_DEFAULT_VALUE;
+        return $this->strictTypes
+            ?? self::DEFAULT_STRICT_TYPES_OPTION;
     }
 
     /**
@@ -124,7 +136,45 @@ public function isStrictTypesEnabled(): bool
      */
     public function isStrictTypesOptionDefined(): bool
     {
-        return $this->isStrictTypes !== null;
+        return $this->strictTypes !== null;
+    }
+
+    /**
+     * Enables or disables type specifiers while casting.
+     *
+     * In case of $enabled is {@see null} a default value will be defined.
+     *
+     * @api
+     */
+    public function withTypeSpecifiers(?bool $enabled = null): self
+    {
+        return new self(
+            objectAsArray: $this->objectAsArray,
+            strictTypes: $this->strictTypes,
+            typeSpecifiers: $enabled,
+            logger: $this->logger,
+            tracer: $this->tracer,
+        );
+    }
+
+    /**
+     * In case of method returns {@see true}, all types will be checked
+     * for additional assertions.
+     */
+    public function isTypeSpecifiersEnabled(): bool
+    {
+        return $this->typeSpecifiers
+            ?? self::DEFAULT_TYPE_SPECIFIERS_OPTION;
+    }
+
+    /**
+     * Returns {@see true} in case option is user-defined.
+     *
+     * @api
+     */
+    public function isTypeSpecifierOptionDefined(): bool
+    {
+        return $this->typeSpecifiers !== null;
     }
 
     /**
@@ -136,8 +186,9 @@ public function isStrictTypesOptionDefined(): bool
     public function withLogger(?LoggerInterface $logger = null): self
     {
         return new self(
-            isObjectsAsArrays: $this->isObjectsAsArrays,
-            isStrictTypes: $this->isStrictTypes,
+            objectAsArray: $this->objectAsArray,
+            strictTypes: $this->strictTypes,
+            typeSpecifiers: $this->typeSpecifiers,
             logger: $logger,
             tracer: $this->tracer,
         );
@@ -162,8 +213,9 @@ public function findLogger(): ?LoggerInterface
     public function withTracer(?TracerInterface $tracer = null): self
     {
         return new self(
-            isObjectsAsArrays: $this->isObjectsAsArrays,
-            isStrictTypes: $this->isStrictTypes,
+            objectAsArray: $this->objectAsArray,
+            strictTypes: $this->strictTypes,
+            typeSpecifiers: $this->typeSpecifiers,
             logger: $this->logger,
             tracer: $tracer,
         );

src/Context/ChildContext.php

@@ -49,6 +49,13 @@ public function isObjectAsArray(): bool
             ?? parent::isObjectAsArray();
     }
 
+    #[\Override]
+    public function isTypeSpecifiersEnabled(): bool
+    {
+        return $this->override?->isTypeSpecifiersEnabled()
+            ?? parent::isTypeSpecifiersEnabled();
+    }
+
     public function getIterator(): \Traversable
     {
         yield $current = $this;