Use friendly exception

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - New #380: Add `TagReference::id()` method (@vjik)
 - Enh #384: Make `$config` parameter in `Container` constructor optional (@np25071984)
+- Enh #324: Make `BuildingException` friendly (@np25071984)
 
 ## 1.3.0 October 14, 2024
 

composer.json

@@ -35,7 +35,8 @@
         "php": "^8.1",
         "ext-mbstring": "*",
         "psr/container": "^1.1|^2.0",
-        "yiisoft/definitions": "^3.0"
+        "yiisoft/definitions": "^3.0",
+        "yiisoft/friendly-exception": "^1.1.0"
     },
     "require-dev": {
         "league/container": "^4.2",

src/BuildingException.php

@@ -7,12 +7,13 @@
 use Exception;
 use Psr\Container\ContainerExceptionInterface;
 use Throwable;
+use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
 /**
  * It wraps all exceptions that don't implement `ContainerExceptionInterface` during the build process.
  * Also adds building context for more understanding.
  */
-final class BuildingException extends Exception implements ContainerExceptionInterface
+final class BuildingException extends Exception implements ContainerExceptionInterface, FriendlyExceptionInterface
 {
     /**
      * @param string $id ID of the definition or name of the class that wasn't found.
@@ -32,4 +33,16 @@ public function __construct(
 
         parent::__construct($message, 0, $previous);
     }
+
+    public function getName(): string
+    {
+        return 'Couldn\'t build requested object.';
+    }
+
+    public function getSolution(): ?string
+    {
+        return <<<SOLUTION
+            See (https://github.com/yiisoft/di)[https://github.com/yiisoft/di] for more documentation.
+            SOLUTION;
+    }
 }

tests/Unit/BuildingExceptionTest.php

@@ -15,6 +15,8 @@ public function testMessage(): void
         $exception = new BuildingException('test', new RuntimeException('i am angry'));
 
         $this->assertSame('Caught unhandled error "i am angry" while building "test".', $exception->getMessage());
+        $this->assertSame('Couldn\'t build requested object.', $exception->getName());
+        $this->assertSame('See (https://github.com/yiisoft/di)[https://github.com/yiisoft/di] for more documentation.', $exception->getSolution());
     }
 
     public function testEmptyMessage(): void