setMatchedElement() / reset matched element on preview requests

Fixes #4542
craftcms · Jul 15, 2019 · e2457ce · e2457ce
1 parent ca5594f
commit e2457ce
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 17 deletions.
diff --git a/CHANGELOG-v3.md b/CHANGELOG-v3.md
@@ -2,8 +2,12 @@
 
 ## Unreleased
 
+### Added
+- Added `craft\web\UrlManager::setMatchedElement()`.
+
 ### Fixed
 - Fixed a bug where it wasn’t possible to delete Matrix blocks if Min Blocks and Max Blocks were set to the same value, and an element already had more than that many blocks. ([#4562](https://github.com/craftcms/cms/issues/4562))
+- Fixed a bug where `craft\web\UrlManager::getMatchedElement()` could return the incorrect result on preview requests. ([#4542](https://github.com/craftcms/cms/issues/4542))
 
 ## 3.2.2 - 2019-07-14
 

diff --git a/src/controllers/PreviewController.php b/src/controllers/PreviewController.php
@@ -143,6 +143,7 @@ public function actionPreview(string $elementType, int $sourceId, int $siteId, i
         $urlManager = Craft::$app->getUrlManager();
         $urlManager->checkToken = false;
         $urlManager->setRouteParams([], false);
+        $urlManager->setMatchedElement(null);
         return Craft::$app->handleRequest(Craft::$app->getRequest(), true);
     }
 }
diff --git a/src/web/UrlManager.php b/src/web/UrlManager.php
@@ -245,6 +245,32 @@ public function getMatchedElement()
         return $this->_matchedElement;
     }
 
+    /**
+     * Sets the matched element for the request.
+     *
+     * @param ElementInterface|false|null $element
+     * @since 3.2.3
+     */
+    public function setMatchedElement($element)
+    {
+        if ($element instanceof ElementInterface) {
+            if ($route = $element->getRoute()) {
+                if (is_string($route)) {
+                    $route = [$route, []];
+                }
+                $this->_matchedElement = $element;
+                $this->_matchedElementRoute = $route;
+                return;
+            }
+
+            // Element doesn't have a route so ignore it
+            $element = false;
+        }
+
+        $this->_matchedElement = $element;
+        $this->_matchedElementRoute = $element;
+    }
+
     // Protected Methods
     // =========================================================================
 
@@ -370,32 +396,20 @@ private function _getMatchedElementRoute(string $path)
             return $this->_matchedElementRoute;
         }
 
-        $this->_matchedElement = false;
-        $this->_matchedElementRoute = false;
-
         if (Craft::$app->getIsInstalled() && Craft::$app->getRequest()->getIsSiteRequest()) {
             /** @var Element $element */
             /** @noinspection PhpUnhandledExceptionInspection */
             $element = Craft::$app->getElements()->getElementByUri($path, Craft::$app->getSites()->getCurrentSite()->id, true);
-
-            if ($element) {
-                $route = $element->getRoute();
-
-                if ($route) {
-                    if (is_string($route)) {
-                        $route = [$route, []];
-                    }
-
-                    $this->_matchedElement = $element;
-                    $this->_matchedElementRoute = $route;
-                }
-            }
+        } else {
+            $element = null;
         }
 
+        $this->setMatchedElement($element ?: false);
+
         if (YII_DEBUG) {
             Craft::debug([
                 'rule' => 'Element URI: ' . $path,
-                'match' => isset($element, $route),
+                'match' => $this->_matchedElement instanceof ElementInterface,
                 'parent' => null
             ], __METHOD__);
         }