Implement CacheLifetimeBehaviourInterface in ArticleBridge (#621)

sulu · Sep 20, 2022 · 276abbc · 276abbc
1 parent 95911e5
commit 276abbc
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 6 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -31,6 +31,9 @@
         'phpdoc_types_order' => false,
         'single_line_throw' => false,
         'single_line_comment_spacing' => false,
+        'phpdoc_to_comment' => [
+            'ignored_tags' => ['todo', 'var', 'see', 'phpstan-ignore-next-line'],
+        ],
     ])
     ->setFinder($finder);
 

diff --git a/Document/Structure/ArticleBridge.php b/Document/Structure/ArticleBridge.php
@@ -16,7 +16,7 @@
 /**
  * Own structure bridge for articles.
  */
-class ArticleBridge extends StructureBridge
+class ArticleBridge extends StructureBridge implements RoutableStructureInterface
 {
     /**
      * @var string
@@ -30,9 +30,25 @@ class ArticleBridge extends StructureBridge
 
     public function getView(): string
     {
+        /** @var string */
         return $this->structure->getView();
     }
 
+    public function getController(): string
+    {
+        /** @var string */
+        return $this->structure->getController();
+    }
+
+    /**
+     * @return array{type: string, value: string}
+     */
+    public function getCacheLifeTime(): array
+    {
+        /** @var array{type: string, value: string} */
+        return $this->structure->getCacheLifetime();
+    }
+
     public function getUuid()
     {
         // is set for structure loaded with document from document-manager

diff --git a/Document/Structure/RoutableStructureInterface.php b/Document/Structure/RoutableStructureInterface.php
@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ArticleBundle\Document\Structure;
+
+use Sulu\Component\Content\Compat\RoutableStructureInterface as SuluRoutableStructureInterface;
+
+if (\interface_exists(SuluRoutableStructureInterface::class)) {
+    /**
+     * @deprecated will be removed, as soon as the ArticleBundle rises the minimum requirement of sulu to a version,
+     * where this interface exists
+     *
+     * @internal
+     */
+    interface RoutableStructureInterface extends SuluRoutableStructureInterface
+    {
+    }
+} else {
+    /**
+     * @deprecated will be removed, as soon as the ArticleBundle rises the minimum requirement of sulu to a version,
+     * where this interface exists
+     *
+     * @internal
+     */
+    interface RoutableStructureInterface
+    {
+        /**
+         * twig template of template definition.
+         *
+         * @return string
+         */
+        public function getView();
+
+        /**
+         * controller which renders the twig template.
+         *
+         * @return string
+         */
+        public function getController();
+
+        /**
+         * cacheLifeTime of template definition.
+         *
+         * @return array{
+         *     type: string,
+         *     value: string,
+         * }
+         */
+        public function getCacheLifeTime();
+    }
+}
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1525,11 +1525,6 @@ parameters:
 			count: 1
 			path: Document/Structure/ArticleBridge.php
 
-		-
-			message: "#^Method Sulu\\\\Bundle\\\\ArticleBundle\\\\Document\\\\Structure\\\\ArticleBridge\\:\\:getView\\(\\) should return string but returns string\\|null\\.$#"
-			count: 1
-			path: Document/Structure/ArticleBridge.php
-
 		-
 			message: "#^Method Sulu\\\\Bundle\\\\ArticleBundle\\\\Document\\\\Structure\\\\ArticleBridge\\:\\:setUuid\\(\\) has no return type specified\\.$#"
 			count: 1