feat: allow PostObject getIcon() to get icons from other blog if orig…

…in of post is other blog (#1243)
helsingborg-stad · Jan 14, 2025 · 235539e · 235539e
1 parent 1d77a13
commit 235539e
Show file tree

Hide file tree

Showing 14 changed files with 392 additions and 26 deletions.
diff --git a/library/Helper/Post.php b/library/Helper/Post.php
@@ -10,7 +10,10 @@
 use Municipio\Helper\Term\Term;
 use Municipio\PostObject\Decorators\BackwardsCompatiblePostObject;
 use Municipio\PostObject\Decorators\IconResolvingPostObject;
+use Municipio\PostObject\Decorators\PostObjectFromOtherBlog;
 use Municipio\PostObject\Decorators\PostObjectFromWpPost;
+use Municipio\PostObject\Decorators\PostObjectWithOtherBlogIdFromSwitchedState;
+use Municipio\PostObject\Decorators\PostObjectWithOtherBlogIdTest;
 use Municipio\PostObject\Icon\Resolvers\CachedIconResolver;
 use Municipio\PostObject\Icon\Resolvers\NullIconResolver;
 use Municipio\PostObject\Icon\Resolvers\PostIconResolver;
@@ -154,12 +157,15 @@ private static function convertWpPostToPostObject(WP_Post $post, string $cacheGr
         $wpService      = \Municipio\Helper\WpService::get();
         $acfService     = \Municipio\Helper\AcfService::get();
 
-        $postObject = new PostObjectFromWpPost(new PostObject(), $post, $wpService);
+        $postObject = new PostObjectFromWpPost(new PostObject($wpService), $post, $wpService);
+        $postObject = new PostObjectWithOtherBlogIdFromSwitchedState($postObject, $wpService);
 
         $iconResolver = new TermIconResolver($postObject, $wpService, new Term($wpService, AcfService::get()), new NullIconResolver());
         $iconResolver = new PostIconResolver($postObject, $acfService, $iconResolver);
         $iconResolver = new CachedIconResolver($postObject, $iconResolver);
-        $postObject   = new IconResolvingPostObject($postObject, $iconResolver);
+
+        $postObject = new IconResolvingPostObject($postObject, $iconResolver);
+        $postObject = new PostObjectFromOtherBlog($postObject, $wpService);
 
         $postObject = new BackwardsCompatiblePostObject($postObject, $camelCasedPost);
 

diff --git a/library/PostObject/Decorators/BackwardsCompatiblePostObject.php b/library/PostObject/Decorators/BackwardsCompatiblePostObject.php
@@ -3,6 +3,7 @@
 namespace Municipio\PostObject\Decorators;
 
 use AllowDynamicProperties;
+use Municipio\PostObject\Icon\IconInterface;
 use Municipio\PostObject\PostObjectInterface;
 
 /**
@@ -11,19 +12,73 @@
  * This class is used to make sure that the PostObjectInterface is backwards compatible with the old PostObject class.
  */
 #[AllowDynamicProperties]
-class BackwardsCompatiblePostObject extends AbstractPostObjectDecorator implements PostObjectInterface
+class BackwardsCompatiblePostObject implements PostObjectInterface
 {
     /**
      * Constructor.
      */
-    public function __construct(PostObjectInterface $postObject, object $legacyPost)
+    public function __construct(private PostObjectInterface $postObject, object $legacyPost)
     {
-        $this->postObject = $postObject;
-
         foreach ($legacyPost as $key => $value) {
             if (!isset($this->{$key})) {
                 $this->{$key} = $value;
             }
         }
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getId(): int
+    {
+        return $this->postObject->getId();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getTitle(): string
+    {
+        return $this->postObject->getTitle();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPermalink(): string
+    {
+        return $this->postObject->getPermalink();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getCommentCount(): int
+    {
+        return $this->postObject->getCommentCount();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPostType(): string
+    {
+        return $this->postObject->getPostType();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        return $this->postObject->getIcon();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBlogId(): int
+    {
+        return $this->postObject->getBlogId();
+    }
 }
diff --git a/library/PostObject/Decorators/IconResolvingPostObject.php b/library/PostObject/Decorators/IconResolvingPostObject.php
@@ -9,14 +9,61 @@
 /**
  * IconResolvingPostObject
  */
-class IconResolvingPostObject extends AbstractPostObjectDecorator implements PostObjectInterface
+class IconResolvingPostObject implements PostObjectInterface
 {
     /**
      * Constructor.
      */
-    public function __construct(PostObjectInterface $inner, private IconResolverInterface $iconResolver)
+    public function __construct(private PostObjectInterface $postObject, private IconResolverInterface $iconResolver)
     {
-        $this->postObject = $inner;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getId(): int
+    {
+        return $this->postObject->getId();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getTitle(): string
+    {
+        return $this->postObject->getTitle();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPermalink(): string
+    {
+        return $this->postObject->getPermalink();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getCommentCount(): int
+    {
+        return $this->postObject->getCommentCount();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPostType(): string
+    {
+        return $this->postObject->getPostType();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBlogId(): int
+    {
+        return $this->postObject->getBlogId();
     }
 
     /**

diff --git a/library/PostObject/Decorators/IconResolvingPostObject.test.php b/library/PostObject/Decorators/IconResolvingPostObject.test.php
@@ -6,8 +6,8 @@
 use Municipio\PostObject\Icon\Resolvers\IconResolverInterface;
 use Municipio\PostObject\Icon\Resolvers\NullIconResolver;
 use Municipio\PostObject\PostObject;
-use Municipio\PostObject\PostObjectInterface;
 use PHPUnit\Framework\TestCase;
+use WpService\Implementations\FakeWpService;
 
 class IconResolvingPostObjectTest extends TestCase
 {
@@ -16,7 +16,7 @@ class IconResolvingPostObjectTest extends TestCase
      */
     public function testClassCanBeInstantiated()
     {
-        $decorator = new IconResolvingPostObject(new PostObject(), new NullIconResolver());
+        $decorator = new IconResolvingPostObject(new PostObject(new FakeWpService()), new NullIconResolver());
         $this->assertInstanceOf(IconResolvingPostObject::class, $decorator);
     }
 
@@ -31,7 +31,7 @@ public function testGetIconCallsProvidedIconResolver()
         $icon->method('getIcon')->willReturn('test-icon');
         $iconResolver->method('resolve')->willReturn($icon);
 
-        $postObject = new IconResolvingPostObject(new PostObject(), $iconResolver);
+        $postObject = new IconResolvingPostObject(new PostObject(new FakeWpService()), $iconResolver);
 
         $this->assertEquals('test-icon', $postObject->getIcon()->getIcon());
     }

diff --git a/library/PostObject/Decorators/PostObjectFromOtherBlog.php b/library/PostObject/Decorators/PostObjectFromOtherBlog.php
@@ -0,0 +1,93 @@
+<?php
+
+namespace Municipio\PostObject\Decorators;
+
+use Municipio\PostObject\Icon\IconInterface;
+use Municipio\PostObject\PostObjectInterface;
+use WpService\Contracts\GetCurrentBlogId;
+use WpService\Contracts\IsMultisite;
+use WpService\Contracts\RestoreCurrentBlog;
+use WpService\Contracts\SwitchToBlog;
+
+/**
+ * Post object decorator that can fetch post data from another blog.
+ * If the post is from another blog, it will switch to that blog to fetch the data.
+ */
+class PostObjectFromOtherBlog implements PostObjectInterface
+{
+    /**
+     * Constructor.
+     */
+    public function __construct(
+        private PostObjectInterface $postObject,
+        private IsMultisite&GetCurrentBlogId&SwitchToBlog&RestoreCurrentBlog $wpService
+    ) {
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getId(): int
+    {
+        return $this->postObject->getId();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getTitle(): string
+    {
+        return $this->postObject->getTitle();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPermalink(): string
+    {
+        return $this->postObject->getPermalink();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getCommentCount(): int
+    {
+        return $this->postObject->getCommentCount();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPostType(): string
+    {
+        return $this->postObject->getPostType();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        if (!$this->wpService->isMultisite()) {
+            return $this->postObject->getIcon();
+        }
+
+        if ($this->getBlogId() === $this->wpService->getCurrentBlogId()) {
+            return $this->postObject->getIcon();
+        }
+
+        $this->wpService->switchToBlog($this->getBlogId());
+        $icon = $this->postObject->getIcon();
+        $this->wpService->restoreCurrentBlog();
+        return $icon;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBlogId(): int
+    {
+        return $this->blogId ?? $this->postObject->getBlogId();
+    }
+}
diff --git a/library/PostObject/Decorators/PostObjectFromOtherBlog.test.php b/library/PostObject/Decorators/PostObjectFromOtherBlog.test.php
@@ -0,0 +1,39 @@
+<?php
+
+namespace Municipio\PostObject\Decorators;
+
+use Municipio\PostObject\PostObjectInterface;
+use PHPUnit\Framework\TestCase;
+use WpService\Implementations\FakeWpService;
+
+class PostObjectFromOtherBlogTest extends TestCase
+{
+    /**
+     * @testdox class can be instantiated
+     */
+    public function testCanBeInstantiated()
+    {
+        $wpService  = new FakeWpService();
+        $postObject = $this->createStub(PostObjectInterface::class);
+
+        $this->assertInstanceOf(
+            PostObjectFromOtherBlog::class,
+            new PostObjectFromOtherBlog($postObject, $wpService)
+        );
+    }
+
+    /**
+     * @testdox getIcon() performs a switch to the correct blog if the post is from another blog
+     */
+    public function testGetIconSwitchesToCorrectBlog()
+    {
+        $wpService  = new FakeWpService(['isMultisite' => true, 'getCurrentBlogId' => 1, 'switchToBlog' => true, 'restoreCurrentBlog' => true]);
+        $postObject = $this->createStub(PostObjectInterface::class);
+        $postObject->method('getBlogId')->willReturn(2);
+        $decoratedPostObject = new PostObjectFromOtherBlog($postObject, $wpService);
+
+        $decoratedPostObject->getIcon();
+
+        $this->assertEquals(2, $wpService->methodCalls['switchToBlog'][0][0]);
+    }
+}
diff --git a/library/PostObject/Decorators/PostObjectFromWpPost.php b/library/PostObject/Decorators/PostObjectFromWpPost.php
@@ -2,6 +2,7 @@
 
 namespace Municipio\PostObject\Decorators;
 
+use Municipio\PostObject\Icon\IconInterface;
 use WP_Post;
 use Municipio\PostObject\PostObjectInterface;
 use WpService\Contracts\GetCommentCount;
@@ -10,17 +11,16 @@
 /**
  * PostObject from WP_Post.
  */
-class PostObjectFromWpPost extends AbstractPostObjectDecorator implements PostObjectInterface
+class PostObjectFromWpPost implements PostObjectInterface
 {
     /**
      * Constructor.
      */
     public function __construct(
-        PostObjectInterface $inner,
+        private PostObjectInterface $postObject,
         private WP_Post $wpPost,
         private GetPermalink&GetCommentCount $wpService
     ) {
-        $this->postObject = $inner;
     }
 
     /**
@@ -62,4 +62,20 @@ public function getPostType(): string
     {
         return $this->wpPost->post_type;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getIcon(): ?IconInterface
+    {
+        return $this->postObject->getIcon();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getBlogId(): int
+    {
+        return $this->postObject->getBlogId();
+    }
 }