[Icons] Add ignore_not_found config option

Allow to silence error during rendering when an icon is not found

Author: smnandre

src/Icons/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## 2.19.0
+
+-   Add `ignore_not_found` option to silence error during rendering if the 
+    icon is not found.
+
+## 2.17.0
+
+-   Add component

src/Icons/config/services.php

@@ -19,6 +19,7 @@
 use Symfony\UX\Icons\Registry\LocalSvgIconRegistry;
 use Symfony\UX\Icons\Twig\IconFinder;
 use Symfony\UX\Icons\Twig\UXIconExtension;
+use Symfony\UX\Icons\Twig\UXIconRuntime;
 
 return static function (ContainerConfigurator $container): void {
     $container->services()
@@ -44,11 +45,17 @@
         ->set('.ux_icons.twig_icon_extension', UXIconExtension::class)
             ->tag('twig.extension')
 
+        ->set('.ux_icons.twig_icon_runtime', UXIconRuntime::class)
+            ->args([
+                service('.ux_icons.icon_renderer'),
+                abstract_arg('ignore_not_found'),
+            ])
+            ->tag('twig.runtime')
+
         ->set('.ux_icons.icon_renderer', IconRenderer::class)
             ->args([
                 service('.ux_icons.icon_registry'),
             ])
-            ->tag('twig.runtime')
 
         ->alias('Symfony\UX\Icons\IconRendererInterface', '.ux_icons.icon_renderer')
 

src/Icons/doc/index.rst

@@ -336,6 +336,19 @@ Now, all icons will have the ``fill`` attribute set to ``currentColor`` by defau
     # renders "user-profile.svg" with fill="red"
     {{ ux_icon('user-profile', {fill: 'red'}) }}
 
+Errors
+------
+
+If an icon is not found, an exception is thrown. This is useful during development,
+but in production, you may want to render an error message instead. You can do this
+by setting the ``ignore_not_found`` configuration option to ``true``:
+
+.. code-block:: yaml
+
+    # config/packages/ux_icons.yaml
+    ux_icons:
+        ignore_not_found: true
+
 Accessibility
 -------------
 
@@ -515,6 +528,9 @@ Full Configuration
 
            # The endpoint for the Iconify API.
            endpoint: 'https://api.iconify.design'
+           
+        # Whether to ignore errors when an icon is not found.
+        ignore_not_found: false
 
 Learn more
 ----------

src/Icons/src/DependencyInjection/UXIconsExtension.php

@@ -58,6 +58,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                         ->end()
                     ->end()
                 ->end()
+                ->booleanNode('ignore_not_found')
+                    ->info('Ignore error when an icon is not found.')
+                    ->defaultFalse()
+                ->end()
             ->end()
         ;
 
@@ -69,7 +73,7 @@ public function getConfiguration(array $config, ContainerBuilder $container): Co
         return $this;
     }
 
-    protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void // @phpstan-ignore-line
+    protected function loadInternal(array $mergedConfig, ContainerBuilder $container): void
     {
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));
         $loader->load('services.php');
@@ -96,6 +100,10 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
             ->setArgument(1, $mergedConfig['default_icon_attributes'])
         ;
 
+        $container->getDefinition('.ux_icons.twig_icon_runtime')
+            ->setArgument(1, $mergedConfig['ignore_not_found'])
+        ;
+
         if ($mergedConfig['iconify']['enabled']) {
             $loader->load('iconify.php');
 

src/Icons/src/Twig/UXIconExtension.php

@@ -11,7 +11,6 @@
 
 namespace Symfony\UX\Icons\Twig;
 
-use Symfony\UX\Icons\IconRenderer;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFunction;
 
@@ -25,7 +24,7 @@ final class UXIconExtension extends AbstractExtension
     public function getFunctions(): array
     {
         return [
-            new TwigFunction('ux_icon', [IconRenderer::class, 'renderIcon'], ['is_safe' => ['html']]),
+            new TwigFunction('ux_icon', [UXIconRuntime::class, 'renderIcon'], ['is_safe' => ['html']]),
         ];
     }
 }

src/Icons/src/Twig/UXIconRuntime.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Twig;
+
+use Symfony\UX\Icons\Exception\IconNotFoundException;
+use Symfony\UX\Icons\IconRendererInterface;
+use Twig\Extension\RuntimeExtensionInterface;
+
+/**
+ * @author Simon André <[email protected]>
+ *
+ * @internal
+ */
+final class UXIconRuntime implements RuntimeExtensionInterface
+{
+    public function __construct(
+        private readonly IconRendererInterface $iconRenderer,
+        private readonly bool $ignoreNotFound = false,
+    ) {
+    }
+
+    /**
+     * @param array<string, bool|string> $attributes
+     */
+    public function renderIcon(string $name, array $attributes = []): string
+    {
+        try {
+            return $this->iconRenderer->renderIcon($name, $attributes);
+        } catch (IconNotFoundException $e) {
+            if ($this->ignoreNotFound) {
+                return '';
+            }
+
+            throw $e;
+        }
+    }
+}

src/Icons/tests/Unit/Twig/UXIconRuntimeTest.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\UX\Icons\Tests\Unit\Twig;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\UX\Icons\Exception\IconNotFoundException;
+use Symfony\UX\Icons\IconRendererInterface;
+use Symfony\UX\Icons\Twig\UXIconRuntime;
+
+/**
+ * @author Simon André <[email protected]>
+ */
+class UXIconRuntimeTest extends TestCase
+{
+    public function testRenderIconIgnoreMissing(): void
+    {
+        $renderer = $this->createMock(IconRendererInterface::class);
+        $renderer->method('renderIcon')
+            ->willThrowException(new IconNotFoundException('not_found'));
+
+        $runtime = new UXIconRuntime($renderer, true);
+        $this->assertEquals('', $runtime->renderIcon('not_found'));
+
+        $runtime = new UXIconRuntime($renderer, false);
+        $this->expectException(IconNotFoundException::class);
+        $runtime->renderIcon('not_found');
+    }
+}