Merge pull request #74 from maximehuran/feature/publish-date

src/Entity/Page.php

@@ -63,6 +63,10 @@ class Page implements PageInterface
      */
     protected $updatedAt;
 
+    protected ?DateTimeInterface $publishAt = null;
+
+    protected ?DateTimeInterface $unpublishAt = null;
+
     /**
      * Page constructor.
      */
@@ -115,6 +119,32 @@ public function hasChannel(ChannelInterface $channel): bool
         return $this->channels->contains($channel);
     }
 
+    public function getPublishAt(): ?DateTimeInterface
+    {
+        return $this->publishAt;
+    }
+
+    public function setPublishAt(?DateTimeInterface $publishAt): void
+    {
+        $this->publishAt = $publishAt;
+    }
+
+    public function getUnpublishAt(): ?DateTimeInterface
+    {
+        return $this->unpublishAt;
+    }
+
+    public function setUnpublishAt(?DateTimeInterface $unpublishAt): void
+    {
+        $this->unpublishAt = $unpublishAt;
+    }
+
+    public function isPublished(DateTimeInterface $dateTime): bool
+    {
+        return (null == $this->publishAt || $this->publishAt <= $dateTime)
+            && (null === $this->unpublishAt || $this->unpublishAt > $dateTime);
+    }
+
     public function getTitle(): ?string
     {
         return $this->getTranslation()->getTitle();

src/Entity/PageInterface.php

@@ -13,6 +13,7 @@
 
 namespace MonsieurBiz\SyliusCmsPagePlugin\Entity;
 
+use DateTimeInterface;
 use Gedmo\Timestampable\Timestampable;
 use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Resource\Model\CodeAwareInterface;
@@ -33,6 +34,16 @@ public function getCode(): ?string;
 
     public function setCode(?string $title): void;
 
+    public function getPublishAt(): ?DateTimeInterface;
+
+    public function setPublishAt(?DateTimeInterface $publishAt): void;
+
+    public function getUnpublishAt(): ?DateTimeInterface;
+
+    public function setUnpublishAt(?DateTimeInterface $unpublishAt): void;
+
+    public function isPublished(DateTimeInterface $dateTime): bool;
+
     public function getTitle(): ?string;
 
     public function setTitle(?string $title): void;

src/Fixture/Factory/PageFixtureFactory.php

@@ -13,6 +13,7 @@
 
 namespace MonsieurBiz\SyliusCmsPagePlugin\Fixture\Factory;
 
+use DateTime;
 use MonsieurBiz\SyliusCmsPagePlugin\Entity\PageInterface;
 use MonsieurBiz\SyliusCmsPagePlugin\Entity\PageTranslationInterface;
 use Sylius\Bundle\CoreBundle\Fixture\Factory\AbstractExampleFactory;
@@ -85,6 +86,9 @@ public function create(array $options = []): PageInterface
         $page->setEnabled($options['enabled']);
         $page->setCode($options['code']);
 
+        $page->setPublishAt($options['publish_at']);
+        $page->setUnpublishAt($options['unpublish_at']);
+
         foreach ($options['channels'] as $channel) {
             $page->addChannel($channel);
         }
@@ -113,9 +117,13 @@ private function createTranslations(PageInterface $page, array $options): void
 
     /**
      * @inheritdoc
+     *
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function configureOptions(OptionsResolver $resolver): void
     {
+        $publishAt = $this->faker->dateTimeBetween('-1 year', '+1 year');
+        $hasPublishAt = $this->faker->boolean(20);
         $resolver
             ->setDefault('enabled', function (Options $options): bool {
                 return $this->faker->boolean(80);
@@ -126,6 +134,18 @@ protected function configureOptions(OptionsResolver $resolver): void
             ->setDefault('translations', function (OptionsResolver $translationResolver): void {
                 $translationResolver->setDefaults($this->configureDefaultTranslations());
             })
+            ->setDefault('publish_at', function (Options $options) use ($publishAt, $hasPublishAt): ?string {
+                return $hasPublishAt ? $publishAt->format('Y-m-d H:i:s') : null;
+            })
+            ->setNormalizer('publish_at', function (Options $options, $value): ?DateTime {
+                return null === $value ? null : new DateTime($value);
+            })
+            ->setDefault('unpublish_at', function (Options $options) use ($publishAt): ?string {
+                return $this->faker->boolean(20) ? (clone $publishAt)->modify('+' . $this->faker->numberBetween(1, 20) . ' days')->format('Y-m-d H:i:s') : null;
+            })
+            ->setNormalizer('unpublish_at', function (Options $options, $value): ?DateTime {
+                return null === $value ? null : new DateTime($value);
+            })
             ->setDefault('channels', LazyOption::all($this->channelRepository))
             ->setAllowedTypes('channels', 'array')
             ->setNormalizer('channels', LazyOption::findBy($this->channelRepository, 'code'))

src/Fixture/PageFixture.php

@@ -43,6 +43,8 @@ protected function configureResourceNode(ArrayNodeDefinition $resourceNode): voi
             ->children()
                 ->booleanNode('enabled')->end()
                 ->scalarNode('code')->cannotBeEmpty()->end()
+                ->scalarNode('publish_at')->end()
+                ->scalarNode('unpublish_at')->end()
                 ->arrayNode('channels')
                     ->scalarPrototype()->end()
                 ->end()

src/Form/Type/PageType.php

@@ -18,6 +18,7 @@
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
+use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
 use Symfony\Component\Form\FormBuilderInterface;
 
 class PageType extends AbstractResourceType
@@ -33,6 +34,16 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'required' => false,
                 'label' => 'monsieurbiz_cms_page.ui.form.enabled',
             ])
+            ->add('publishAt', DateTimeType::class, [
+                'label' => 'monsieurbiz_cms_page.ui.form.publish_at',
+                'required' => false,
+                'widget' => 'single_text',
+            ])
+            ->add('unpublishAt', DateTimeType::class, [
+                'label' => 'monsieurbiz_cms_page.ui.form.unpublish_at',
+                'required' => false,
+                'widget' => 'single_text',
+            ])
             ->add('channels', ChannelChoiceType::class, [
                 'label' => 'monsieurbiz_cms_page.ui.form.channels',
                 'required' => false,

src/Migrations/Version20240924135829.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Cms Page plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusCmsPagePlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20240924135829 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE monsieurbiz_cms_page ADD publish_at DATETIME DEFAULT NULL, ADD unpublish_at DATETIME DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE monsieurbiz_cms_page DROP publish_at, DROP unpublish_at');
+    }
+}

src/Repository/PageRepository.php

@@ -13,6 +13,7 @@
 
 namespace MonsieurBiz\SyliusCmsPagePlugin\Repository;
 
+use DateTimeInterface;
 use Doctrine\ORM\NonUniqueResultException;
 use Doctrine\ORM\QueryBuilder;
 use MonsieurBiz\SyliusCmsPagePlugin\Entity\PageInterface;
@@ -83,6 +84,47 @@ public function findOneEnabledBySlugAndChannelCode(string $slug, string $localeC
         ;
     }
 
+    public function existsOneEnabledAndPublishedByChannelAndSlug(ChannelInterface $channel, ?string $locale, string $slug, DateTimeInterface $dateTime): bool
+    {
+        $queryBuilder = $this->createQueryBuilderExistOne($channel, $locale, $slug);
+        $queryBuilder
+            ->andWhere('p.enabled = true')
+            ->andWhere('p.publishAt IS NULL OR p.publishAt <= :now')
+            ->andWhere('p.unpublishAt IS NULL OR p.unpublishAt >= :now')
+            ->setParameter('now', $dateTime)
+        ;
+
+        $count = (int) $queryBuilder
+            ->getQuery()
+            ->getSingleScalarResult()
+        ;
+
+        return $count > 0;
+    }
+
+    /**
+     * @throws NonUniqueResultException
+     */
+    public function findOneEnabledAndPublishedBySlugAndChannelCode(string $slug, string $localeCode, string $channelCode, DateTimeInterface $dateTime): ?PageInterface
+    {
+        return $this->createQueryBuilder('p')
+            ->leftJoin('p.translations', 'translation')
+            ->innerJoin('p.channels', 'channels')
+            ->where('translation.locale = :localeCode')
+            ->andWhere('translation.slug = :slug')
+            ->andWhere('channels.code = :channelCode')
+            ->andWhere('p.enabled = true')
+            ->andWhere('p.publishAt IS NULL OR p.publishAt <= :now')
+            ->andWhere('p.unpublishAt IS NULL OR p.unpublishAt >= :now')
+            ->setParameter('now', $dateTime)
+            ->setParameter('localeCode', $localeCode)
+            ->setParameter('slug', $slug)
+            ->setParameter('channelCode', $channelCode)
+            ->getQuery()
+            ->getOneOrNullResult()
+        ;
+    }
+
     private function createQueryBuilderExistOne(ChannelInterface $channel, ?string $locale, string $slug): QueryBuilder
     {
         return $this

src/Repository/PageRepositoryInterface.php

@@ -13,6 +13,7 @@
 
 namespace MonsieurBiz\SyliusCmsPagePlugin\Repository;
 
+use DateTimeInterface;
 use Doctrine\ORM\QueryBuilder;
 use MonsieurBiz\SyliusCmsPagePlugin\Entity\PageInterface;
 use Sylius\Component\Channel\Model\ChannelInterface;
@@ -24,7 +25,13 @@ public function createListQueryBuilder(string $localeCode): QueryBuilder;
 
     public function existsOneByChannelAndSlug(ChannelInterface $channel, ?string $locale, string $slug, array $excludedPages = []): bool;
 
+    /** @deprecated Use existsOneEnabledAndPublishedByChannelAndSlug */
     public function existsOneEnabledByChannelAndSlug(ChannelInterface $channel, ?string $locale, string $slug): bool;
 
+    /** @deprecated Use findOneEnabledAndPublishedBySlugAndChannelCode */
     public function findOneEnabledBySlugAndChannelCode(string $slug, string $localeCode, string $channelCode): ?PageInterface;
+
+    public function existsOneEnabledAndPublishedByChannelAndSlug(ChannelInterface $channel, ?string $locale, string $slug, DateTimeInterface $dateTime): bool;
+
+    public function findOneEnabledAndPublishedBySlugAndChannelCode(string $slug, string $localeCode, string $channelCode, DateTimeInterface $dateTime): ?PageInterface;
 }

src/Resources/config/doctrine/Page.orm.xml

@@ -16,6 +16,8 @@
                 <option name="default">1</option>
             </options>
         </field>
+        <field name="publishAt" column="publish_at" type="datetime" nullable="true"/>
+        <field name="unpublishAt" column="unpublish_at" type="datetime" nullable="true"/>
         <field name="createdAt" column="created_at" type="datetime_immutable">
             <gedmo:timestampable on="create"/>
         </field>

src/Resources/config/routing/shop.yaml

@@ -7,11 +7,12 @@ monsieurbiz_cms_page_show:
         _sylius:
             template: "@MonsieurBizSyliusCmsPagePlugin/Shop/Page/show.html.twig"
             repository:
-                method: findOneEnabledBySlugAndChannelCode
+                method: findOneEnabledAndPublishedBySlugAndChannelCode
                 arguments:
                     - $slug
                     - "expr:service('sylius.context.locale').getLocaleCode()"
                     - "expr:service('sylius.context.channel').getChannel().getCode()"
+                    - "expr:service('monsieurbiz.cms_page.datetime_provider').now()"
     requirements:
         slug: .+
     condition: "not(context.getPathInfo() matches '`^%sylius.security.new_api_route%`') and context.checkPageSlug(request)"

src/Resources/config/services.yaml

@@ -35,3 +35,7 @@ services:
     MonsieurBiz\SyliusCmsPagePlugin\Routing\RequestContext:
         decorates: router.request_context
         arguments: ['@MonsieurBiz\SyliusCmsPagePlugin\Routing\RequestContext.inner']
+
+    monsieurbiz.cms_page.datetime_provider:
+        class: Sylius\Calendar\Provider\Calendar
+        public: true