Use NULL instead of ContentUrlResult::abstain()

contao · Jan 17, 2024 · 9b529db · 9b529db
1 parent ba24a4a
commit 9b529db
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 36 deletions.
diff --git a/core-bundle/src/Routing/Content/ArticleResolver.php b/core-bundle/src/Routing/Content/ArticleResolver.php
@@ -22,10 +22,10 @@ public function __construct(private readonly ContaoFramework $framework)
     {
     }
 
-    public function resolve(object $content): ContentUrlResult
+    public function resolve(object $content): ContentUrlResult|null
     {
         if (!$content instanceof ArticleModel) {
-            return ContentUrlResult::abstain();
+            return null;
         }
 
         $pageAdapter = $this->framework->getAdapter(PageModel::class);

diff --git a/core-bundle/src/Routing/Content/ContentUrlResolverInterface.php b/core-bundle/src/Routing/Content/ContentUrlResolverInterface.php
@@ -18,12 +18,12 @@ interface ContentUrlResolverInterface
 {
     /**
      * Returns a result for resolving the given content.
-     * - ContentUrlResult::abstain() if you cannot handle the content.
+     * - NULL if you cannot handle the content.
      * - ContentUrlResult::url() if the content has a URL string that could be relative or contain insert tags.
      * - ContentUrlResult::redirect() to generate the URL for a new content instead of the current one.
      * - ContentUrlResult::resolve() to generate the URL for the given PageModel with the current content.
      */
-    public function resolve(object $content): ContentUrlResult;
+    public function resolve(object $content): ContentUrlResult|null;
 
     /**
      * Returns an array of parameters for the given content that can be used

diff --git a/core-bundle/src/Routing/Content/ContentUrlResult.php b/core-bundle/src/Routing/Content/ContentUrlResult.php
@@ -27,11 +27,6 @@ public function __construct(public readonly object|string|null $content)
         }
     }
 
-    public function isAbstained(): bool
-    {
-        return null === $this->content;
-    }
-
     public function isRedirect(): bool
     {
         return $this->redirect;
@@ -54,14 +49,6 @@ public function getTargetUrl(): string
         return $this->content;
     }
 
-    /**
-     * Provides no result to continue the resolver loop.
-     */
-    public static function abstain(): self
-    {
-        return new self(null);
-    }
-
     /**
      * Result is a URL string which is possibly relative and could contain insert tags that should be resolved.
      */

diff --git a/core-bundle/src/Routing/Content/PageResolver.php b/core-bundle/src/Routing/Content/PageResolver.php
@@ -21,10 +21,10 @@ public function __construct(private readonly ContaoFramework $framework)
     {
     }
 
-    public function resolve(object $content): ContentUrlResult
+    public function resolve(object $content): ContentUrlResult|null
     {
         if (!$content instanceof PageModel) {
-            return ContentUrlResult::abstain();
+            return null;
         }
 
         switch ($content->type) {
@@ -43,7 +43,7 @@ public function resolve(object $content): ContentUrlResult
                 return ContentUrlResult::redirect($forwardPage);
         }
 
-        return ContentUrlResult::abstain();
+        return null;
     }
 
     public function getParametersForContent(object $content, PageModel $pageModel): array

diff --git a/core-bundle/src/Routing/Content/StringResolver.php b/core-bundle/src/Routing/Content/StringResolver.php
@@ -24,10 +24,10 @@ public function __construct(
     ) {
     }
 
-    public function resolve(object $content): ContentUrlResult
+    public function resolve(object $content): ContentUrlResult|null
     {
         if (!$content instanceof StringUrl) {
-            return ContentUrlResult::abstain();
+            return null;
         }
 
         $url = $this->insertTagParser->replaceInline($content->value);

diff --git a/core-bundle/src/Routing/ContentUrlGenerator.php b/core-bundle/src/Routing/ContentUrlGenerator.php
@@ -148,7 +148,7 @@ private function resolveContent(object ...$contents): array
         foreach ($this->urlResolvers as $resolver) {
             $result = $resolver->resolve($contents[0]);
 
-            if ($result->isAbstained()) {
+            if (!$result) {
                 continue;
             }
 

diff --git a/core-bundle/tests/Routing/Content/ArticleResolverTest.php b/core-bundle/tests/Routing/Content/ArticleResolverTest.php
@@ -27,7 +27,7 @@ public function testAbstainsIfContentIsNotAnArticleModel(): void
         $resolver = new ArticleResolver($this->mockContaoFramework());
         $result = $resolver->resolve($content);
 
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
     }
 
     public function testResolvesArticleModel(): void

diff --git a/core-bundle/tests/Routing/Content/PageResolverTest.php b/core-bundle/tests/Routing/Content/PageResolverTest.php
@@ -27,7 +27,7 @@ public function testAbstainsIfContentIsNotAPageModel(): void
         $resolver = new PageResolver($this->mockContaoFramework());
         $result = $resolver->resolve($content);
 
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
     }
 
     public function testAbstainsIfContentPageModelIsNotRedirectOrForward(): void
@@ -36,15 +36,15 @@ public function testAbstainsIfContentPageModelIsNotRedirectOrForward(): void
 
         $content = $this->mockClassWithProperties(PageModel::class, ['type' => 'regular']);
         $result = $resolver->resolve($content);
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
 
         $content = $this->mockClassWithProperties(PageModel::class, ['type' => 'root']);
         $result = $resolver->resolve($content);
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
 
         $content = $this->mockClassWithProperties(PageModel::class, ['type' => 'foobar']);
         $result = $resolver->resolve($content);
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
     }
 
     public function testReturnsRedirectUrl(): void

diff --git a/core-bundle/tests/Routing/Content/StringResolverTest.php b/core-bundle/tests/Routing/Content/StringResolverTest.php
@@ -37,7 +37,7 @@ public function testAbstainsIfContentIsNotAStringUrl(): void
         $resolver = new StringResolver($insertTagParser, $urlHelper);
         $result = $resolver->resolve($content);
 
-        $this->assertTrue($result->isAbstained());
+        $this->assertNull($result);
     }
 
     /**

diff --git a/core-bundle/tests/Routing/ContentUrlGeneratorTest.php b/core-bundle/tests/Routing/ContentUrlGeneratorTest.php
@@ -62,7 +62,7 @@ public function testRedirectsPageToAnotherPage(): void
 
         $resolver = $this->mockResolver(
             [$pageModel1, ContentUrlResult::redirect($pageModel2)],
-            [$pageModel2, ContentUrlResult::abstain()],
+            [$pageModel2, null],
         );
 
         $service = new ContentUrlGenerator($urlGenerator, $pageRegistry, $entityManager, [$resolver]);
@@ -81,7 +81,7 @@ public function testGeneratesParametersForPageModel(): void
         $entityManager = $this->createMock(EntityManagerInterface::class);
 
         $resolver = $this->mockResolver(
-            [$pageModel2, ContentUrlResult::abstain()],
+            [$pageModel2, null],
         );
 
         $service = new ContentUrlGenerator($urlGenerator, $pageRegistry, $entityManager, [$resolver]);
@@ -101,7 +101,7 @@ public function testIgnoresParametersOnRedirect(): void
 
         $resolver = $this->mockResolver(
             [$pageModel1, ContentUrlResult::redirect($pageModel2)],
-            [$pageModel2, ContentUrlResult::abstain()],
+            [$pageModel2, null],
         );
 
         $service = new ContentUrlGenerator($urlGenerator, $pageRegistry, $entityManager, [$resolver]);
@@ -175,7 +175,7 @@ public function testResolvesFromMultipleResolvers(): void
 
         $pageResolver = $this->mockResolver(
             [$content, ContentUrlResult::url('https://example.net')],
-            [$this->isInstanceOf(StringUrl::class), ContentUrlResult::abstain()],
+            [$this->isInstanceOf(StringUrl::class), null],
         );
 
         $stringResolver = $this->mockResolver(
@@ -200,7 +200,7 @@ public function testGeneratesContentUrl(): void
 
         $resolver = $this->mockResolver(
             [$content, ContentUrlResult::resolve($target)],
-            [$target, ContentUrlResult::abstain()],
+            [$target, null],
         );
 
         $service = new ContentUrlGenerator($urlGenerator, $pageRegistry, $entityManager, [$resolver]);
@@ -223,7 +223,7 @@ public function testFetchesContentParametersFromResolvers(): void
 
         $resolver = $this->mockResolver(
             [$content, ContentUrlResult::resolve($target)],
-            [$target, ContentUrlResult::abstain()],
+            [$target, null],
         );
 
         $resolver
@@ -252,7 +252,7 @@ public function testIgnoresUnknownContentParametersFromResolvers(): void
 
         $resolver = $this->mockResolver(
             [$content, ContentUrlResult::resolve($target)],
-            [$target, ContentUrlResult::abstain()],
+            [$target, null],
         );
 
         $resolver