feat(MapperOptions): Add context object to provide mapping options.

Author: priyadi

CHANGELOG.md

@@ -5,6 +5,7 @@
 * refactor(`Context`): Returns null instead of throwing exception if the
   member is not found.
 * refactor(`Context`): Context is now `Traversable`.
+* feat(`MapperOptions`): Add context object to provide mapping options.
 
 ## 0.7.3
 

src/Context/MapperOptions.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of rekalogika/mapper package.
+ *
+ * (c) Priyadi Iman Nurcahyo <https://rekalogika.dev>
+ *
+ * For the full copyright and license information, please view the LICENSE file
+ * that was distributed with this source code.
+ */
+
+namespace Rekalogika\Mapper\Context;
+
+/**
+ * @immutable
+ */
+final readonly class MapperOptions
+{
+    public int $manualGcInterval;
+
+    /**
+     * @param boolean $enableLazyLoading Enable or disable lazy loading.
+     * @param boolean $enableTargetValueReading If disabled, values on the target side will not be read, and assumed to be null.
+     * @param integer|null $manualGcInterval Performs garbage collection manually every n `MainTransformer` invocation. If not provided, and lazy loading is active, it is automatically set to 1000 to fix memory leak.
+     */
+    public function __construct(
+        public bool $enableLazyLoading = true,
+        public bool $enableTargetValueReading = true,
+        ?int $manualGcInterval = null,
+    ) {
+        if ($manualGcInterval === null) {
+            if ($enableLazyLoading) {
+                $this->manualGcInterval = 1000;
+            } else {
+                $this->manualGcInterval = 0;
+            }
+        } else {
+            $this->manualGcInterval = $manualGcInterval;
+        }
+    }
+}

src/MainTransformer/MainTransformer.php

@@ -14,6 +14,7 @@
 namespace Rekalogika\Mapper\MainTransformer;
 
 use Rekalogika\Mapper\Context\Context;
+use Rekalogika\Mapper\Context\MapperOptions;
 use Rekalogika\Mapper\MainTransformer\Exception\CannotFindTransformerException;
 use Rekalogika\Mapper\MainTransformer\Exception\CircularReferenceException;
 use Rekalogika\Mapper\MainTransformer\Exception\TransformerReturnsUnexpectedValueException;
@@ -79,6 +80,13 @@ public function transform(
         Context $context,
         string $path = null,
     ): mixed {
+        // if MapperOptions is not provided, use the default options
+
+        if (!($mapperOptions = $context(MapperOptions::class))) {
+            $mapperOptions = new MapperOptions();
+            $context = $context->with($mapperOptions);
+        }
+
         // if target is provided, guess the type from it.
         // if target is not provided, use the provided target type. if it is
         // also not provided, then the target type is mixed.