Make event dispatcher in View and WebView optional (#250)

yiisoft · Mar 15, 2024 · 57372ba · 57372ba
1 parent 6ab2c25
commit 57372ba
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
   `withFallbackExtension()` and `getFallbackExtensions()` (@rustamwin)
 - Bug #232: Fix render templates that contain dots in their name (@rustamwin)
 - New #242: Add `View::getLocale()` and `WebView::getLocale()` methods (@Tigrov)
+- Enh #250: Make event dispatcher in `View` and `WebView` optional (@vjik)
 
 ## 8.0.0 February 16, 2023
 

diff --git a/src/View.php b/src/View.php
@@ -34,9 +34,9 @@ final class View implements ViewInterface
 
     /**
      * @param string $basePath The full path to the base directory of views.
-     * @param EventDispatcherInterface $eventDispatcher The event dispatcher instance.
+     * @param EventDispatcherInterface|null $eventDispatcher The event dispatcher instance.
      */
-    public function __construct(string $basePath, EventDispatcherInterface $eventDispatcher)
+    public function __construct(string $basePath, ?EventDispatcherInterface $eventDispatcher = null)
     {
         $this->basePath = $basePath;
         $this->state = new ViewState();
@@ -64,15 +64,15 @@ public function beginPage(): void
     {
         ob_start();
         ob_implicit_flush(false);
-        $this->eventDispatcher->dispatch(new PageBegin($this));
+        $this->eventDispatcher?->dispatch(new PageBegin($this));
     }
 
     /**
      * Marks the ending of a view.
      */
     public function endPage(): void
     {
-        $this->eventDispatcher->dispatch(new PageEnd($this));
+        $this->eventDispatcher?->dispatch(new PageEnd($this));
 
         ob_end_flush();
     }

diff --git a/src/ViewTrait.php b/src/ViewTrait.php
@@ -34,7 +34,7 @@
  */
 trait ViewTrait
 {
-    private EventDispatcherInterface $eventDispatcher;
+    private ?EventDispatcherInterface $eventDispatcher;
 
     private string $basePath;
     private ?ViewContextInterface $context = null;
@@ -586,6 +586,10 @@ abstract protected function createAfterRenderEvent(
      */
     private function beforeRender(string $viewFile, array $parameters): bool
     {
+        if ($this->eventDispatcher === null) {
+            return true;
+        }
+
         $event = $this->createBeforeRenderEvent($viewFile, $parameters);
         $event = $this->eventDispatcher->dispatch($event);
         /** @var StoppableEventInterface $event */
@@ -607,6 +611,10 @@ private function beforeRender(string $viewFile, array $parameters): bool
      */
     private function afterRender(string $viewFile, array $parameters, string $result): string
     {
+        if ($this->eventDispatcher === null) {
+            return $result;
+        }
+
         $event = $this->createAfterRenderEvent($viewFile, $parameters, $result);
 
         /** @var AfterRenderEventInterface $event */

diff --git a/src/WebView.php b/src/WebView.php
@@ -88,9 +88,9 @@ final class WebView implements ViewInterface
 
     /**
      * @param string $basePath The full path to the base directory of views.
-     * @param EventDispatcherInterface $eventDispatcher The event dispatcher instance.
+     * @param EventDispatcherInterface|null $eventDispatcher The event dispatcher instance.
      */
-    public function __construct(string $basePath, EventDispatcherInterface $eventDispatcher)
+    public function __construct(string $basePath, ?EventDispatcherInterface $eventDispatcher = null)
     {
         $this->basePath = $basePath;
         $this->state = new WebViewState();
@@ -117,7 +117,7 @@ public function withClearedState(): static
     public function head(): void
     {
         echo sprintf(self::PLACEHOLDER_HEAD, $this->getPlaceholderSignature());
-        $this->eventDispatcher->dispatch(new Head($this));
+        $this->eventDispatcher?->dispatch(new Head($this));
     }
 
     /**
@@ -126,15 +126,15 @@ public function head(): void
     public function beginBody(): void
     {
         echo sprintf(self::PLACEHOLDER_BODY_BEGIN, $this->getPlaceholderSignature());
-        $this->eventDispatcher->dispatch(new BodyBegin($this));
+        $this->eventDispatcher?->dispatch(new BodyBegin($this));
     }
 
     /**
      * Marks the ending of an HTML body section.
      */
     public function endBody(): void
     {
-        $this->eventDispatcher->dispatch(new BodyEnd($this));
+        $this->eventDispatcher?->dispatch(new BodyEnd($this));
         echo sprintf(self::PLACEHOLDER_BODY_END, $this->getPlaceholderSignature());
     }
 
@@ -145,7 +145,7 @@ public function beginPage(): void
     {
         ob_start();
         ob_implicit_flush(false);
-        $this->eventDispatcher->dispatch(new PageBegin($this));
+        $this->eventDispatcher?->dispatch(new PageBegin($this));
     }
 
     /**
@@ -157,7 +157,7 @@ public function beginPage(): void
      */
     public function endPage(bool $ajaxMode = false): void
     {
-        $this->eventDispatcher->dispatch(new PageEnd($this));
+        $this->eventDispatcher?->dispatch(new PageEnd($this));
 
         $content = ob_get_clean();
 

diff --git a/tests/TestSupport/TestHelper.php b/tests/TestSupport/TestHelper.php
@@ -6,7 +6,6 @@
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Yiisoft\Files\FileHelper;
-use Yiisoft\Test\Support\EventDispatcher\SimpleEventDispatcher;
 use Yiisoft\View\View;
 use Yiisoft\View\WebView;
 
@@ -24,15 +23,15 @@ public static function createView(?EventDispatcherInterface $eventDispatcher = n
     {
         return new View(
             dirname(__DIR__) . '/public/view',
-            $eventDispatcher ?? new SimpleEventDispatcher(),
+            $eventDispatcher,
         );
     }
 
     public static function createWebView(?EventDispatcherInterface $eventDispatcher = null): WebView
     {
         return new WebView(
             dirname(__DIR__) . '/public/view',
-            $eventDispatcher ?? new SimpleEventDispatcher(),
+            $eventDispatcher,
         );
     }
 }