Feature: Widgets and Snippets

src/EventSubscriber/ProcessWidgetsQueueSubscriber.php

@@ -6,7 +6,6 @@
 
 use Bolt\Widgets;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 

src/Twig/WidgetExtension.php

@@ -38,12 +38,12 @@ public function getFunctions(): array
 
     public function renderWidgetByName(string $name): string
     {
-        return $this->widgetRenderer->renderWidgetByName($name);
+        return $this->widgetRenderer->renderWidgetByName($name, func_get_args());
     }
 
     public function renderWidgetsForTarget(string $target): string
     {
-        return $this->widgetRenderer->renderWidgetsForTarget($target);
+        return $this->widgetRenderer->renderWidgetsForTarget($target, func_get_args());
     }
 
     public function dummy($input = null): string

src/Widget/BaseWidget.php

@@ -18,7 +18,6 @@ class BaseWidget implements WidgetInterface
     protected $target = Target::NOWHERE;
     protected $zone = RequestZone::EVERYWHERE;
     protected $priority = 0;
-    protected $context = [];
 
     /** @var string */
     protected $template;
@@ -84,16 +83,16 @@ public function getPriority(): int
         return $this->priority;
     }
 
-    public function __invoke(?string $template = null): string
+    public function __invoke(array $params = []): string
     {
-        if ($template === null) {
-            $template = $this->template;
+        if (array_key_exists('template', $params)) {
+            $this->template = $params['template'];
         }
 
         if ($this instanceof TwigAware) {
-            $output = $this->twig->render($template, $this->context);
+            $output = $this->twig->render($this->template, $params);
         } else {
-            $output = $template;
+            $output = $this->template;
         }
 
         return sprintf(

src/Widget/BoltHeaderWidget.php

@@ -14,7 +14,7 @@ class BoltHeaderWidget extends BaseWidget implements ResponseAware
     protected $target = Target::NOWHERE;
     protected $zone = RequestZone::FRONTEND;
 
-    public function __invoke(?string $template = null): string
+    public function __invoke(array $params = []): string
     {
         $this->getResponse()->headers->set('X-Powered-By', 'Bolt', false);
 

src/Widget/NewsWidget.php

@@ -19,21 +19,21 @@ class NewsWidget extends BaseWidget implements TwigAware, RequestAware
     protected $priority = 150;
     protected $template = '@bolt/widgets/news.twig';
 
-    public function __invoke(?string $template = null): string
+    public function __invoke(array $params = []): string
     {
         $news = $this->getNews();
 
         $currentItem = $news['information'];
 
-        $this->context = [
+        $context = [
             'title' => $currentItem['title'],
             'news' => $currentItem['teaser'],
             'link' => $currentItem['link'],
             'datechanged' => $currentItem['datechanged'],
             'datefetched' => '2019-04-04 07:25:00',
         ];
 
-        return parent::__invoke($template);
+        return parent::__invoke($context);
     }
 
     /**

src/Widget/SnippetWidget.php

@@ -27,7 +27,7 @@ public function __construct(
         $this->zone = $zone;
     }
 
-    public function __invoke(?string $template = null): string
+    public function __invoke(array $params = []): string
     {
         return $this->getTemplate();
     }

src/Widget/WidgetInterface.php

@@ -26,5 +26,5 @@ public function getZone(): string;
 
     public function getSlug(): string;
 
-    public function __invoke(?string $template = null): string;
+    public function __invoke(array $params = []): string;
 }

src/Widgets.php

@@ -48,7 +48,7 @@ public function registerWidget(WidgetInterface $widget): void
         $this->queue->push($widget);
     }
 
-    public function renderWidgetByName(string $name): string
+    public function renderWidgetByName(string $name, array $params = []): string
     {
         $widget = $this->queue->filter(function (WidgetInterface $widget) use ($name) {
             return $widget->getName() === $name;
@@ -59,11 +59,11 @@ public function renderWidgetByName(string $name): string
                 $widget->setRequest($this->requestStack->getCurrentRequest());
             }
 
-            return $widget();
+            return $widget($params);
         }
     }
 
-    public function renderWidgetsForTarget(string $target): string
+    public function renderWidgetsForTarget(string $target, array $params = []): string
     {
         $widgets = $this->queue->filter(function (WidgetInterface $widget) use ($target) {
             return $widget->getTarget() === $target;
@@ -78,7 +78,7 @@ public function renderWidgetsForTarget(string $target): string
                 $widget->setRequest($this->requestStack->getCurrentRequest());
             }
 
-            $output .= $widget();
+            $output .= $widget($params);
         }
 
         return $output;

tests/php/WidgetsTest.php

@@ -65,6 +65,29 @@ public function testRenderWidget(): void
         );
     }
 
+
+    public function testRenderWidgetWithExtraParameters(): void
+    {
+        $queueprocessor = new QueueProcessor(new HtmlInjector());
+        $requestStack = new RequestStack();
+        $requestStack->push(Request::createFromGlobals());
+
+        $loader = new ArrayLoader(['weather.twig' => '[Hello, {{ foo }}!]']);
+        $twig = new Environment($loader);
+
+        $widgets = new Widgets($requestStack, $queueprocessor, $twig);
+
+        $weatherWidget = new WeatherWidget();
+        $weatherWidget->setTemplate('weather.twig');
+
+        $widgets->registerWidget($weatherWidget);
+
+        $this->assertSame(
+            '<div id="widget-weather-widget" name="Weather Widget">[Hello, Bar!]</div>',
+            $widgets->renderWidgetByName('Weather Widget', ['foo' => 'Bar'])
+        );
+    }
+
     public function testProcessHeaderWidget(): void
     {
         $queueprocessor = new QueueProcessor(new HtmlInjector());