feat: Better overridability for WebResponses

Author: roadiz-ci

src/Api/DataTransformer/WebResponseOutputDataTransformer.php

@@ -25,30 +25,15 @@ class WebResponseOutputDataTransformer implements WebResponseDataTransformerInte
     use BlocksAwareWebResponseOutputDataTransformerTrait;
     use RealmsAwareWebResponseOutputDataTransformerTrait;
 
-    private NodesSourcesHeadFactoryInterface $nodesSourcesHeadFactory;
-    private BreadcrumbsFactoryInterface $breadcrumbsFactory;
-    private WalkerContextInterface $walkerContext;
-    private CacheItemPoolInterface $cacheItemPool;
-    private UrlGeneratorInterface $urlGenerator;
-    private RealmResolverInterface $realmResolver;
-    private TreeWalkerGenerator $treeWalkerGenerator;
-
     public function __construct(
-        NodesSourcesHeadFactoryInterface $nodesSourcesHeadFactory,
-        BreadcrumbsFactoryInterface $breadcrumbsFactory,
-        WalkerContextInterface $walkerContext,
-        CacheItemPoolInterface $cacheItemPool,
-        UrlGeneratorInterface $urlGenerator,
-        RealmResolverInterface $realmResolver,
-        TreeWalkerGenerator $treeWalkerGenerator
+        protected readonly NodesSourcesHeadFactoryInterface $nodesSourcesHeadFactory,
+        protected readonly BreadcrumbsFactoryInterface $breadcrumbsFactory,
+        protected readonly WalkerContextInterface $walkerContext,
+        protected readonly CacheItemPoolInterface $cacheItemPool,
+        protected readonly UrlGeneratorInterface $urlGenerator,
+        protected readonly RealmResolverInterface $realmResolver,
+        protected readonly TreeWalkerGenerator $treeWalkerGenerator
     ) {
-        $this->nodesSourcesHeadFactory = $nodesSourcesHeadFactory;
-        $this->breadcrumbsFactory = $breadcrumbsFactory;
-        $this->walkerContext = $walkerContext;
-        $this->cacheItemPool = $cacheItemPool;
-        $this->urlGenerator = $urlGenerator;
-        $this->realmResolver = $realmResolver;
-        $this->treeWalkerGenerator = $treeWalkerGenerator;
     }
 
     protected function getWalkerContext(): WalkerContextInterface

src/Api/Model/NodesSourcesHead.php

@@ -113,7 +113,6 @@ public function getMatomoSiteId(): ?string
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getSiteName(): ?string
     {
-        // site_name
         return $this->settingsBag->get('site_name', null) ?? null;
     }
 
@@ -173,9 +172,6 @@ public function isNoIndex(): bool
         return false;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getPolicyUrl(): ?string
     {
@@ -199,63 +195,60 @@ public function getPolicyUrl(): ?string
         return null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getMainColor(): ?string
     {
         return $this->settingsBag->get('main_color', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getFacebookUrl(): ?string
     {
         return $this->settingsBag->get('facebook_url', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getInstagramUrl(): ?string
     {
         return $this->settingsBag->get('instagram_url', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getTwitterUrl(): ?string
     {
         return $this->settingsBag->get('twitter_url', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getYoutubeUrl(): ?string
     {
         return $this->settingsBag->get('youtube_url', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
     #[Serializer\Groups(["nodes_sources_single", "walker"])]
     public function getLinkedinUrl(): ?string
     {
         return $this->settingsBag->get('linkedin_url', null) ?? null;
     }
 
-    /**
-     * @return string|null
-     */
+    #[Serializer\Groups(["nodes_sources_single", "walker"])]
+    public function getSpotifyUrl(): ?string
+    {
+        return $this->settingsBag->get('spotify_url', null) ?? null;
+    }
+
+    #[Serializer\Groups(["nodes_sources_single", "walker"])]
+    public function getSoundcloudUrl(): ?string
+    {
+        return $this->settingsBag->get('soundcloud_url', null) ?? null;
+    }
+
+    #[Serializer\Groups(["nodes_sources_single", "walker"])]
+    public function getTikTokUrl(): ?string
+    {
+        return $this->settingsBag->get('tiktok_url', null) ?? null;
+    }
+
     #[Serializer\Groups(["web_response", "nodes_sources_single", "walker"])]
     public function getHomePageUrl(): ?string
     {
@@ -268,9 +261,6 @@ public function getHomePageUrl(): ?string
         return null;
     }
 
-    /**
-     * @return DocumentInterface|null
-     */
     #[Serializer\Groups(["web_response", "nodes_sources_single"])]
     public function getShareImage(): ?DocumentInterface
     {
@@ -291,9 +281,6 @@ public function getShareImage(): ?DocumentInterface
         return $this->settingsBag->getDocument('share_image') ?? null;
     }
 
-    /**
-     * @return TranslationInterface
-     */
     #[Serializer\Ignore()]
     public function getTranslation(): TranslationInterface
     {
@@ -303,9 +290,6 @@ public function getTranslation(): TranslationInterface
         return $this->defaultTranslation;
     }
 
-    /**
-     * @return NodesSources|null
-     */
     #[Serializer\Ignore()]
     public function getHomePage(): ?NodesSources
     {

src/Api/Model/NodesSourcesHeadFactory.php

@@ -13,27 +13,12 @@
 
 final class NodesSourcesHeadFactory implements NodesSourcesHeadFactoryInterface
 {
-    private Settings $settingsBag;
-    private UrlGeneratorInterface $urlGenerator;
-    private NodeSourceApi $nodeSourceApi;
-    private HandlerFactoryInterface $handlerFactory;
-
-    /**
-     * @param Settings $settingsBag
-     * @param UrlGeneratorInterface $urlGenerator
-     * @param NodeSourceApi $nodeSourceApi
-     * @param HandlerFactoryInterface $handlerFactory
-     */
     public function __construct(
-        Settings $settingsBag,
-        UrlGeneratorInterface $urlGenerator,
-        NodeSourceApi $nodeSourceApi,
-        HandlerFactoryInterface $handlerFactory
+        private readonly Settings $settingsBag,
+        private readonly UrlGeneratorInterface $urlGenerator,
+        private readonly NodeSourceApi $nodeSourceApi,
+        private readonly HandlerFactoryInterface $handlerFactory
     ) {
-        $this->settingsBag = $settingsBag;
-        $this->urlGenerator = $urlGenerator;
-        $this->nodeSourceApi = $nodeSourceApi;
-        $this->handlerFactory = $handlerFactory;
     }
 
     public function createForNodeSource(NodesSources $nodesSources): NodesSourcesHeadInterface

src/Api/Model/WebResponse.php

@@ -4,100 +4,7 @@
 
 namespace RZ\Roadiz\CoreBundle\Api\Model;
 
-use ApiPlatform\Metadata\ApiProperty;
-use Doctrine\Common\Collections\Collection;
-use RZ\Roadiz\Core\AbstractEntities\PersistableInterface;
-use RZ\Roadiz\CoreBundle\Api\Breadcrumbs\BreadcrumbsInterface;
-use RZ\Roadiz\CoreBundle\Model\RealmInterface;
-use RZ\TreeWalker\WalkerInterface;
-use Symfony\Component\Serializer\Annotation as Serializer;
-
 final class WebResponse implements WebResponseInterface, BlocksAwareWebResponseInterface, RealmsAwareWebResponseInterface
 {
-    #[ApiProperty(identifier: true)]
-    public ?string $path = null;
-
-    #[Serializer\Groups(["web_response"])]
-    public ?PersistableInterface $item = null;
-
-    #[Serializer\Groups(["web_response"])]
-    public ?BreadcrumbsInterface $breadcrumbs = null;
-
-    #[Serializer\Groups(["web_response"])]
-    public ?NodesSourcesHeadInterface $head = null;
-    /**
-     * @var Collection<int, WalkerInterface>|null
-     */
-    #[Serializer\Groups(["web_response"])]
-    private ?Collection $blocks = null;
-    /**
-     * @var array<RealmInterface>|null
-     */
-    #[Serializer\Groups(["web_response"])]
-    private ?array $realms = null;
-
-    #[Serializer\Groups(["web_response"])]
-    private bool $hidingBlocks = false;
-
-    /**
-     * @return PersistableInterface|null
-     */
-    public function getItem(): ?PersistableInterface
-    {
-        return $this->item;
-    }
-
-    /**
-     * @return Collection<int, WalkerInterface>|null
-     */
-    public function getBlocks(): ?Collection
-    {
-        return $this->blocks;
-    }
-
-    /**
-     * @param Collection<int, WalkerInterface>|null $blocks
-     * @return WebResponse
-     */
-    public function setBlocks(?Collection $blocks): WebResponse
-    {
-        $this->blocks = $blocks;
-        return $this;
-    }
-
-    /**
-     * @return RealmInterface[]|null
-     */
-    public function getRealms(): ?array
-    {
-        return $this->realms;
-    }
-
-    /**
-     * @param RealmInterface[]|null $realms
-     * @return WebResponse
-     */
-    public function setRealms(?array $realms): WebResponse
-    {
-        $this->realms = $realms;
-        return $this;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isHidingBlocks(): bool
-    {
-        return $this->hidingBlocks;
-    }
-
-    /**
-     * @param bool $hidingBlocks
-     * @return WebResponse
-     */
-    public function setHidingBlocks(bool $hidingBlocks): WebResponse
-    {
-        $this->hidingBlocks = $hidingBlocks;
-        return $this;
-    }
+    use WebResponseTrait;
 }