Add immutable withTheme method (#243)

Gerych1984 · vjik · web-flow · commit fc4e93101087 · 2024-01-20T13:25:48.000+03:00
Co-authored-by: Sergei Predvoditelev &lt;sergei@predvoditelev.ru&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## 8.0.1 under development
 
+- New #243: Add immutable method `ViewInterface::withTheme()` (@Gerych1984)
 - Bug #224: Fix signature of `CachedContent::cache()` (@vjik)
 - Bug #226: Fix `reset` config for referenced definitions (@rustamwin)
 - Enh #226: Adjust config to make `View` and `WebView` more configurable (@rustamwin)
diff --git a/src/State/StateTrait.php b/src/State/StateTrait.php
@@ -5,7 +5,6 @@
 namespace Yiisoft\View\State;
 
 use InvalidArgumentException;
-use Yiisoft\View\Theme;
 
 use function array_key_exists;
 use function func_get_args;
@@ -16,8 +15,6 @@
  */
 trait StateTrait
 {
-    private ?Theme $theme = null;
-
     /**
      * @var array Parameters that are common for all view templates.
      * @psalm-var array<string, mixed>
@@ -30,27 +27,6 @@ trait StateTrait
      */
     private array $blocks = [];
 
-    /**
-     * Set the specified theme instance.
-     *
-     * @param Theme|null $theme The theme instance or `null` for reset theme.
-     */
-    public function setTheme(?Theme $theme): static
-    {
-        $this->theme = $theme;
-        return $this;
-    }
-
-    /**
-     * Gets the theme instance, or `null` if no theme has been set.
-     *
-     * @return Theme|null The theme instance, or `null` if no theme has been set.
-     */
-    public function getTheme(): ?Theme
-    {
-        return $this->theme;
-    }
-
     /**
      * Sets a common parameters that is accessible in all view templates.
      *
diff --git a/src/State/ThemeState.php b/src/State/ThemeState.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\View\State;
+
+use Yiisoft\View\Theme;
+
+/**
+ * @internal
+ */
+final class ThemeState
+{
+    public function __construct(
+        private ?Theme $theme = null
+    ) {
+    }
+
+    /**
+     * Set the specified view theme.
+     *
+     * @param Theme|null $theme $theme The theme instance or `null` for reset theme.
+     */
+    public function setTheme(?Theme $theme): self
+    {
+        $this->theme = $theme;
+
+        return $this;
+    }
+
+    /**
+     * Gets the theme instance, or `null` if no theme has been set.
+     *
+     * @return Theme|null The theme instance, or `null` if no theme has been set.
+     */
+    public function getTheme(): ?Theme
+    {
+        return $this->theme;
+    }
+}
diff --git a/src/View.php b/src/View.php
@@ -12,6 +12,7 @@
 use Yiisoft\View\Event\View\PageBegin;
 use Yiisoft\View\Event\View\PageEnd;
 use Yiisoft\View\State\LocaleState;
+use Yiisoft\View\State\ThemeState;
 use Yiisoft\View\State\ViewState;
 
 use function ob_end_flush;
@@ -29,6 +30,7 @@ final class View implements ViewInterface
 
     private ViewState $state;
     private LocaleState $localeState;
+    private ThemeState $themeState;
 
     /**
      * @param string $basePath The full path to the base directory of views.
@@ -39,6 +41,7 @@ public function __construct(string $basePath, EventDispatcherInterface $eventDis
         $this->basePath = $basePath;
         $this->state = new ViewState();
         $this->localeState = new LocaleState();
+        $this->themeState = new ThemeState();
         $this->eventDispatcher = $eventDispatcher;
         $this->setPlaceholderSalt(__DIR__);
     }
diff --git a/src/ViewInterface.php b/src/ViewInterface.php
@@ -132,6 +132,13 @@ public function getTheme(): ?Theme;
      */
     public function setTheme(?Theme $theme): static;
 
+    /**
+     * Set the specified theme instance immutable.
+     *
+     * @param Theme|null $theme The theme instance or `null` for reset theme.
+     */
+    public function withTheme(?Theme $theme): static;
+
     /**
      * Sets a common parameters that is accessible in all view templates.
      *
diff --git a/src/ViewTrait.php b/src/ViewTrait.php
@@ -12,6 +12,7 @@
 use Yiisoft\View\Event\AfterRenderEventInterface;
 use Yiisoft\View\Exception\ViewNotFoundException;
 use Yiisoft\View\State\LocaleState;
+use Yiisoft\View\State\ThemeState;
 
 use function array_merge;
 use function array_pop;
@@ -237,7 +238,7 @@ public function getFallbackExtensions(): array
      */
     public function getTheme(): ?Theme
     {
-        return $this->state->getTheme();
+        return $this->themeState->getTheme();
     }
 
     /**
@@ -247,10 +248,18 @@ public function getTheme(): ?Theme
      */
     public function setTheme(?Theme $theme): static
     {
-        $this->state->setTheme($theme);
+        $this->themeState->setTheme($theme);
         return $this;
     }
 
+    public function withTheme(?Theme $theme): static
+    {
+        $new = clone $this;
+        $new->themeState = new ThemeState($theme);
+
+        return $new;
+    }
+
     /**
      * Sets a common parameters that is accessible in all view templates.
      *
@@ -535,6 +544,7 @@ public function clear(): void
         $this->viewFiles = [];
         $this->state->clear();
         $this->localeState = new LocaleState();
+        $this->themeState = new ThemeState();
     }
 
     /**
diff --git a/src/WebView.php b/src/WebView.php
@@ -21,6 +21,7 @@
 use Yiisoft\View\Event\WebView\PageBegin;
 use Yiisoft\View\Event\WebView\PageEnd;
 use Yiisoft\View\State\LocaleState;
+use Yiisoft\View\State\ThemeState;
 use Yiisoft\View\State\WebViewState;
 
 use function array_merge;
@@ -42,6 +43,7 @@ final class WebView implements ViewInterface
 
     private WebViewState $state;
     private LocaleState $localeState;
+    private ThemeState $themeState;
 
     /**
      * This means the location is in the head section.
@@ -93,6 +95,7 @@ public function __construct(string $basePath, EventDispatcherInterface $eventDis
         $this->basePath = $basePath;
         $this->state = new WebViewState();
         $this->localeState = new LocaleState();
+        $this->themeState = new ThemeState();
         $this->eventDispatcher = $eventDispatcher;
         $this->setPlaceholderSalt(__DIR__);
     }
diff --git a/tests/ViewTest.php b/tests/ViewTest.php
@@ -584,6 +584,18 @@ public function testImmutability(): void
         $this->assertNotSame($view, $view->withClearedState());
         $this->assertNotSame($view, $view->withLocale('es'));
         $this->assertNotSame($view, $view->withFallbackExtension('tpl'));
+        $this->assertNotSame($view, $view->withTheme(null));
+    }
+
+    public function testImmutableTheme(): void
+    {
+        $view = TestHelper::createView();
+        $theme = new Theme([]);
+        $viewWithTheme = $view->withTheme($theme);
+
+        $this->assertNull($view->getTheme());
+        $this->assertNotNull($viewWithTheme->getTheme());
+        $this->assertSame($theme, $viewWithTheme->getTheme());
     }
 
     public function testGetLocale()
@@ -604,7 +616,7 @@ private function createViewWithBasePath(string $basePath): View
 
     private function createContext(string $viewPath): ViewContextInterface
     {
-        return new class ($viewPath) implements ViewContextInterface {
+        return new class($viewPath) implements ViewContextInterface {
             public function __construct(private string $viewPath)
             {
             }
