Merge pull request #24 from petrknap/soft-warnings

`Logger` replaced by suppressible notices
petrknap · May 29, 2024 · 55222f4 · 55222f4
2 parents a69125c + 3e0f4df
commit 55222f4
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 46 deletions.
diff --git a/composer.json b/composer.json
@@ -28,8 +28,7 @@
   "license": "LGPL-3.0-or-later",
   "name": "petrknap/optional",
   "require": {
-    "php": ">=8.1",
-    "psr/log": "^3.0|^2.0|^1.0"
+    "php": ">=8.1"
   },
   "require-dev": {
     "nunomaduro/phpinsights": "^2.11",

diff --git a/src/Logger.php b/src/Logger.php
diff --git a/src/Optional.php b/src/Optional.php
@@ -14,8 +14,6 @@
  */
 abstract class Optional implements JavaSe8\Optional
 {
-    use Logger;
-
     private bool|null $wasPresent = null;
 
     /**
@@ -24,7 +22,7 @@ abstract class Optional implements JavaSe8\Optional
     final protected function __construct(
         protected readonly mixed $value,
     ) {
-        if ($this->value !== null && !static::isSupported($this->value)) {
+        if ($this->value !== null && !@static::isSupported($this->value)) {
             throw new InvalidArgumentException('Value is not supported.');
         }
     }
@@ -68,7 +66,7 @@ public static function ofNullable(mixed $value): static
             return new class ($value) extends Optional {  # @phpstan-ignore-line
                 protected static function isSupported(mixed $value): bool
                 {
-                    self::logNotice(Optional::class . ' does not check the type of value.');
+                    TypedOptional::triggerNotice(Optional::class . ' does not check the type of value.');
                     return true;
                 }
             };
@@ -113,7 +111,7 @@ public function flatMap(callable $mapper): self  # @phpstan-ignore-line
     public function get(): mixed
     {
         if ($this->wasPresent === null) {
-            self::logNotice('Call `isPresent()` before accessing the value.');
+            self::triggerNotice('Call `isPresent()` before accessing the value.');
         }
         return $this->orElseThrow();
     }
@@ -171,4 +169,15 @@ public function orElseThrow(?callable $exceptionSupplier = null): mixed
      * @param mixed $value not null
      */
     abstract protected static function isSupported(mixed $value): bool;
+
+    /**
+     * @internal you should use {@see TypedOptional::triggerNotice()}
+     */
+    private static function triggerNotice(string $message): void
+    {
+        trigger_error(
+            $message,
+            error_level: E_USER_NOTICE,
+        );
+    }
 }
diff --git a/src/OptionalObject.php b/src/OptionalObject.php
@@ -27,6 +27,7 @@ public static function ofNullable(mixed $value): static
             return new class ($value) extends OptionalObject {  # @phpstan-ignore-line
                 protected static function getInstanceOf(): string
                 {
+                    TypedOptional::triggerNotice(OptionalObject::class . ' does not check the instance of object.');
                     /** @var class-string */
                     return self::ANY_INSTANCE_OF;
                 }

diff --git a/src/OptionalResource.php b/src/OptionalResource.php
@@ -25,6 +25,7 @@ public static function ofNullable(mixed $value): static
             return new class ($value) extends OptionalResource {  # @phpstan-ignore-line
                 protected static function getResourceType(): string
                 {
+                    TypedOptional::triggerNotice(OptionalResource::class . ' does not check the type of resource.');
                     /** @var non-empty-string */
                     return self::ANY_RESOURCE_TYPE;
                 }

diff --git a/src/TypedOptional.php b/src/TypedOptional.php
@@ -8,6 +8,8 @@
 
 final class TypedOptional
 {
+    private static bool|null $enabledErrorTriggering = null;
+
     /** @var array<class-string> must be iterated in reverse order */
     private static array $typedOptionals = [
         OptionalArray::class,
@@ -58,6 +60,29 @@ public static function register(string $typedOptionalClassName): void
         if (!is_a($typedOptionalClassName, Optional::class, allow_string: true)) {
             throw new Exception\CouldNotRegisterNonOptional($typedOptionalClassName);
         }
+        if (self::$enabledErrorTriggering === null) {
+            self::enableErrorTriggering();
+        }
         self::$typedOptionals[] = $typedOptionalClassName;
     }
+
+    public static function enableErrorTriggering(): void
+    {
+        self::$enabledErrorTriggering = true;
+    }
+
+    public static function disableErrorTriggering(): void
+    {
+        self::$enabledErrorTriggering = false;
+    }
+
+    public static function triggerNotice(string $message): void
+    {
+        if (self::$enabledErrorTriggering === true) {
+            trigger_error(
+                $message,
+                error_level: E_USER_NOTICE,
+            );
+        }
+    }
 }