Add solution providers

Author: xepozz

src/Renderer/HtmlRenderer.php

@@ -12,6 +12,8 @@
 use Yiisoft\ErrorHandler\CompositeException;
 use Yiisoft\ErrorHandler\ErrorData;
 use Yiisoft\ErrorHandler\Exception\ErrorException;
+use Yiisoft\ErrorHandler\Solution\SolutionGenerator;
+use Yiisoft\ErrorHandler\Solution\FriendlyExceptionSolution;
 use Yiisoft\ErrorHandler\ThrowableRendererInterface;
 use Yiisoft\FriendlyException\FriendlyExceptionInterface;
 
@@ -104,6 +106,8 @@ final class HtmlRenderer implements ThrowableRendererInterface
      */
     private ?array $vendorPaths = null;
 
+    private SolutionGenerator $solutionGenerator;
+
     /**
      * @param array $settings Settings can have the following keys:
      * - template: string, full path of the template file for rendering exceptions without call stack information.
@@ -131,6 +135,7 @@ public function __construct(array $settings = [])
         $this->maxSourceLines = $settings['maxSourceLines'] ?? 19;
         $this->maxTraceLines = $settings['maxTraceLines'] ?? 13;
         $this->traceHeaderLine = $settings['traceHeaderLine'] ?? null;
+        $this->solutionGenerator = new SolutionGenerator([new FriendlyExceptionSolution()]);
     }
 
     public function render(Throwable $t, ServerRequestInterface $request = null): ErrorData
@@ -143,9 +148,12 @@ public function render(Throwable $t, ServerRequestInterface $request = null): Er
 
     public function renderVerbose(Throwable $t, ServerRequestInterface $request = null): ErrorData
     {
+        $solutions = $this->solutionGenerator->generate($t);
+
         return new ErrorData($this->renderTemplate($this->verboseTemplate, [
             'request' => $request,
             'throwable' => $t,
+            'solutions' => $solutions,
         ]));
     }
 

src/Solution/FriendlyExceptionSolution.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Solution;
+
+use Yiisoft\FriendlyException\FriendlyExceptionInterface;
+
+final class FriendlyExceptionSolution implements SolutionProviderInterface
+{
+    public function supports(\Throwable $e): bool
+    {
+        return $e instanceof FriendlyExceptionInterface && $e->getSolution() !== null;
+    }
+
+    public function generate(\Throwable $e): string
+    {
+        return $e->getSolution();
+    }
+}

src/Solution/SolutionGenerator.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Solution;
+
+final class SolutionGenerator
+{
+    public function __construct(
+        /**
+         * @var SolutionGeneratorInterface[]
+         */
+        private array $generators,
+    ) {
+    }
+
+    /**
+     * @return string[]
+     */
+    public function generate(\Throwable $e): array
+    {
+        $result = [];
+
+        foreach ($this->generators as $generator) {
+            if ($generator->supports($e)) {
+                $result[] = $generator->generate($e);
+            }
+        }
+        return $result;
+    }
+}

src/Solution/SolutionProviderInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\ErrorHandler\Solution;
+
+interface SolutionProviderInterface
+{
+    public function supports(\Throwable $e): bool;
+
+    public function generate(\Throwable $e): string;
+}

templates/development.php

@@ -8,6 +8,7 @@
  * @var $this \Yiisoft\ErrorHandler\Renderer\HtmlRenderer
  * @var $request \Psr\Http\Message\ServerRequestInterface|null
  * @var $throwable \Throwable
+ * @var $solutions string[]
  */
 
 $theme = $_COOKIE['yii-exception-theme'] ?? '';
@@ -17,7 +18,6 @@
     $throwable = $throwable->getFirstException();
 }
 $isFriendlyException = $throwable instanceof FriendlyExceptionInterface;
-$solution = $isFriendlyException ? $throwable->getSolution() : null;
 $exceptionClass = get_class($throwable);
 $exceptionMessage = $throwable->getMessage();
 
@@ -79,9 +79,16 @@
             <?= nl2br($this->htmlEncode($exceptionMessage)) ?>
         </div>
 
-        <?php if ($solution !== null): ?>
-            <div class="solution"><?= $this->parseMarkdown($solution) ?></div>
-        <?php endif ?>
+        <?php
+        if (!empty($solutions)) {
+            echo '<div class="solutions">';
+            foreach ($solutions as $i => $solution) {
+                echo '<div class="solution solution-' . $i . '">';
+                echo $this->parseMarkdown($solution);
+                echo '</div>';
+            }
+        }
+        ?>
 
         <?= $this->renderPreviousExceptions($originalException) ?>