[WIP] Add channel awareness

spec/Resolver/BlockResourceResolverSpec.php

@@ -18,12 +18,14 @@
 use BitBag\SyliusCmsPlugin\Resolver\BlockResourceResolverInterface;
 use PhpSpec\ObjectBehavior;
 use Psr\Log\LoggerInterface;
+use Sylius\Component\Channel\Context\ChannelContextInterface;
+use Sylius\Component\Core\Model\ChannelInterface;
 
 final class BlockResourceResolverSpec extends ObjectBehavior
 {
-    function let(BlockRepositoryInterface $blockRepository, LoggerInterface $logger)
+    function let(BlockRepositoryInterface $blockRepository, LoggerInterface $logger, ChannelContextInterface $channelContext)
     {
-        $this->beConstructedWith($blockRepository, $logger);
+        $this->beConstructedWith($blockRepository, $logger, $channelContext);
     }
 
     function it_is_initializable(): void
@@ -36,9 +38,15 @@ function it_implements_block_resource_resolver_interface(): void
         $this->shouldHaveType(BlockResourceResolverInterface::class);
     }
 
-    function it_logs_warning_if_block_was_not_found(BlockRepositoryInterface $blockRepository, LoggerInterface $logger)
-    {
-        $blockRepository->findOneEnabledByCode('homepage_banner')->willReturn(null);
+    function it_logs_warning_if_block_was_not_found(
+        BlockRepositoryInterface $blockRepository,
+        LoggerInterface $logger,
+        ChannelContextInterface $channelContext,
+        ChannelInterface $channel
+    ) {
+        $channel->getCode()->willReturn('WEB');
+        $channelContext->getChannel()->willReturn($channel);
+        $blockRepository->findOneEnabledByCodeAndChannelCode('homepage_banner', 'WEB')->willReturn(null);
 
         $logger
             ->warning(sprintf(
@@ -51,9 +59,15 @@ function it_logs_warning_if_block_was_not_found(BlockRepositoryInterface $blockR
         $this->findOrLog('homepage_banner');
     }
 
-    function it_returns_block_if_found_in_database(BlockRepositoryInterface $blockRepository, BlockInterface $block)
-    {
-        $blockRepository->findOneEnabledByCode('homepage_banner')->willReturn($block);
+    function it_returns_block_if_found_in_database(
+        BlockRepositoryInterface $blockRepository,
+        BlockInterface $block,
+        ChannelContextInterface $channelContext,
+        ChannelInterface $channel
+    ) {
+        $channel->getCode()->willReturn('WEB');
+        $channelContext->getChannel()->willReturn($channel);
+        $blockRepository->findOneEnabledByCodeAndChannelCode('homepage_banner', 'WEB')->willReturn($block);
 
         $this->findOrLog('homepage_banner')->shouldReturn($block);
     }

src/Entity/Block.php

@@ -22,6 +22,7 @@ class Block implements BlockInterface
     use ToggleableTrait;
     use SectionableTrait;
     use ProductsAwareTrait;
+    use ChannelsAwareTrait;
     use TranslatableTrait {
         __construct as protected initializeTranslationsCollection;
     }
@@ -31,6 +32,7 @@ public function __construct()
         $this->initializeTranslationsCollection();
         $this->initializeSectionsCollection();
         $this->initializeProductsCollection();
+        $this->initializeChannelsCollection();
     }
 
     /** @var int */

src/Entity/BlockInterface.php

@@ -12,6 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Entity;
 
+use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Core\Model\ImageInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\ToggleableInterface;
@@ -22,7 +23,8 @@ interface BlockInterface extends
     TranslatableInterface,
     ToggleableInterface,
     ProductsAwareInterface,
-    SectionableInterface
+    SectionableInterface,
+    ChannelsAwareInterface
 {
     const TEXT_BLOCK_TYPE = 'text';
     const IMAGE_BLOCK_TYPE = 'image';

src/Entity/ChannelsAwareTrait.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * another great project.
+ * You can find more information about us on https://bitbag.shop and write us
+ * an email on [email protected].
+ */
+
+namespace BitBag\SyliusCmsPlugin\Entity;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Sylius\Component\Channel\Model\ChannelInterface;
+
+trait ChannelsAwareTrait
+{
+    /** @var Collection|ChannelInterface[] */
+    protected $channels;
+
+    public function initializeChannelsCollection(): void
+    {
+        $this->channels = new ArrayCollection();
+    }
+
+    public function getChannels(): Collection
+    {
+        return $this->channels;
+    }
+
+    public function addChannel(ChannelInterface $channel): void
+    {
+        if (!$this->hasChannel($channel)) {
+            $this->channels->add($channel);
+        }
+    }
+
+    public function removeChannel(ChannelInterface $channel): void
+    {
+        if ($this->hasChannel($channel)) {
+            $this->channels->removeElement($channel);
+        }
+    }
+
+    public function hasChannel(ChannelInterface $channel): bool
+    {
+        return $this->channels->contains($channel);
+    }
+}

src/Entity/FrequentlyAskedQuestion.php

@@ -18,6 +18,7 @@
 
 class FrequentlyAskedQuestion implements FrequentlyAskedQuestionInterface
 {
+    use ChannelsAwareTrait;
     use ToggleableTrait,
         TranslatableTrait {
         __construct as private initializeTranslationsCollection;
@@ -35,6 +36,7 @@ class FrequentlyAskedQuestion implements FrequentlyAskedQuestionInterface
     public function __construct()
     {
         $this->initializeTranslationsCollection();
+        $this->initializeChannelsCollection();
     }
 
     public function getId(): ?int

src/Entity/FrequentlyAskedQuestionInterface.php

@@ -12,11 +12,16 @@
 
 namespace BitBag\SyliusCmsPlugin\Entity;
 
+use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\ToggleableInterface;
 use Sylius\Component\Resource\Model\TranslatableInterface;
 
-interface FrequentlyAskedQuestionInterface extends ResourceInterface, TranslatableInterface, ToggleableInterface
+interface FrequentlyAskedQuestionInterface extends
+    ResourceInterface,
+    TranslatableInterface,
+    ToggleableInterface,
+    ChannelsAwareInterface
 {
     public function getCode(): ?string;
 

src/Entity/Page.php

@@ -24,6 +24,7 @@ class Page implements PageInterface
     use ProductsAwareTrait;
     use SectionableTrait;
     use TimestampableTrait;
+    use ChannelsAwareTrait;
     use TranslatableTrait {
         __construct as protected initializeTranslationsCollection;
     }
@@ -39,6 +40,8 @@ public function __construct()
         $this->initializeProductsCollection();
         $this->initializeSectionsCollection();
         $this->initializeTranslationsCollection();
+        $this->initializeChannelsCollection();
+        $this->initializeChannelsCollection();
 
         $this->createdAt = new \DateTime();
     }

src/Entity/PageInterface.php

@@ -12,6 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Entity;
 
+use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\TimestampableInterface;
 use Sylius\Component\Resource\Model\ToggleableInterface;
@@ -23,7 +24,8 @@ interface PageInterface extends
     ToggleableInterface,
     ProductsAwareInterface,
     SectionableInterface,
-    TimestampableInterface
+    TimestampableInterface,
+    ChannelsAwareInterface
 {
     public function getSlug(): ?string;
 

src/Entity/Section.php

@@ -17,6 +17,7 @@
 
 class Section implements SectionInterface
 {
+    use ChannelsAwareTrait;
     use TranslatableTrait {
         __construct as private initializeTranslationsCollection;
     }
@@ -30,6 +31,7 @@ class Section implements SectionInterface
     public function __construct()
     {
         $this->initializeTranslationsCollection();
+        $this->initializeChannelsCollection();
     }
 
     public function getId(): ?int

src/Entity/SectionInterface.php

@@ -12,10 +12,11 @@
 
 namespace BitBag\SyliusCmsPlugin\Entity;
 
+use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
 use Sylius\Component\Resource\Model\TranslatableInterface;
 
-interface SectionInterface extends ResourceInterface, TranslatableInterface
+interface SectionInterface extends ResourceInterface, TranslatableInterface, ChannelsAwareInterface
 {
     public function getCode(): ?string;
 

src/Form/Type/BlockType.php

@@ -16,6 +16,7 @@
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\HtmlBlockTranslationType;
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\ImageBlockTranslationType;
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\TextBlockTranslationType;
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
 use Sylius\Bundle\ProductBundle\Form\Type\ProductAutocompleteChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
@@ -47,6 +48,11 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'bitbag_sylius_cms_plugin.ui.products',
                 'multiple' => true,
             ])
+            ->add('channels', ChannelChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'bitbag_sylius_cms_plugin.ui.channels',
+            ])
         ;
 
         $this->resolveBlockType($block, $builder);

src/Form/Type/FrequentlyAskedQuestionType.php

@@ -13,6 +13,7 @@
 namespace BitBag\SyliusCmsPlugin\Form\Type;
 
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\FrequentlyAskedQuestionTranslationType;
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
@@ -39,6 +40,11 @@ public function buildForm(FormBuilderInterface $builder, array $options)
                 'label' => false,
                 'entry_type' => FrequentlyAskedQuestionTranslationType::class,
             ])
+            ->add('channels', ChannelChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'bitbag_sylius_cms_plugin.ui.channels',
+            ])
         ;
     }
 }

src/Form/Type/PageType.php

@@ -13,6 +13,7 @@
 namespace BitBag\SyliusCmsPlugin\Form\Type;
 
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\PageTranslationType;
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
 use Sylius\Bundle\ProductBundle\Form\Type\ProductAutocompleteChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
@@ -44,6 +45,11 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'bitbag_sylius_cms_plugin.ui.sections',
                 'multiple' => true,
             ])
+            ->add('channels', ChannelChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'bitbag_sylius_cms_plugin.ui.channels',
+            ])
         ;
     }
 

src/Form/Type/SectionType.php

@@ -13,6 +13,7 @@
 namespace BitBag\SyliusCmsPlugin\Form\Type;
 
 use BitBag\SyliusCmsPlugin\Form\Type\Translation\SectionTranslationType;
+use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
@@ -30,6 +31,11 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ->add('translations', ResourceTranslationsType::class, [
                 'entry_type' => SectionTranslationType::class,
             ])
+            ->add('channels', ChannelChoiceType::class, [
+                'multiple' => true,
+                'expanded' => true,
+                'label' => 'bitbag_sylius_cms_plugin.ui.channels',
+            ])
         ;
     }
 

src/Repository/BlockRepository.php

@@ -27,42 +27,57 @@ public function createListQueryBuilder(string $localeCode): QueryBuilder
         ;
     }
 
-    public function findOneEnabledByCode(string $code): ?BlockInterface
+    public function findOneEnabledByCodeAndChannelCode(string $code, string $channelCode): ?BlockInterface
     {
         return $this->createQueryBuilder('o')
+            ->innerJoin('o.channels', 'channels')
             ->where('o.code = :code')
             ->andWhere('o.enabled = true')
+            ->andWhere('channels.code = :channelCode')
             ->setParameter('code', $code)
+            ->setParameter('channelCode', $channelCode)
             ->getQuery()
             ->getOneOrNullResult()
         ;
     }
 
-    public function findBySectionCode(string $sectionCode, string $localeCode): array
-    {
+    public function findBySectionCodeAndChannelCode(
+        string $sectionCode,
+        string $localeCode,
+        string $channelCode
+    ): array {
         return $this->createQueryBuilder('o')
             ->leftJoin('o.translations', 'translation')
             ->innerJoin('o.sections', 'section')
+            ->innerJoin('o.channels', 'channels')
             ->andWhere('translation.locale = :localeCode')
             ->andWhere('section.code = :sectionCode')
             ->andWhere('o.enabled = true')
+            ->andWhere('channels.code = :channelCode')
             ->setParameter('localeCode', $localeCode)
             ->setParameter('sectionCode', $sectionCode)
+            ->setParameter('channelCode', $channelCode)
             ->getQuery()
             ->getResult()
         ;
     }
 
-    public function findByProductCode(string $productCode, string $localeCode): array
-    {
+    public function findByProductCodeAndChannelCode(
+        string $productCode,
+        string $localeCode,
+        string $channelCode
+    ): array {
         return $this->createQueryBuilder('o')
             ->leftJoin('o.translations', 'translation')
             ->innerJoin('o.products', 'product')
+            ->innerJoin('o.channels', 'channels')
             ->andWhere('translation.locale = :localeCode')
             ->andWhere('product.code = :productCode')
             ->andWhere('o.enabled = true')
+            ->andWhere('channels.code = :channelCode')
             ->setParameter('localeCode', $localeCode)
             ->setParameter('productCode', $productCode)
+            ->setParameter('channelCode', $channelCode)
             ->getQuery()
             ->getResult()
         ;