Merge pull request #1 from FmiKL/release/symfony6-compatibility

Release Symfony 6 compatibility

Author: FmiKL

Entity/Newsletter.php

@@ -7,38 +7,26 @@
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Validator\Constraints as Assert;
 
-/**
- * @ORM\Entity(repositoryClass=NewsletterRepository::class)
- * @UniqueEntity(fields={"token", "email"})
- */
+#[ORM\Entity(repositoryClass: NewsletterRepository::class)]
+#[UniqueEntity(fields: ['token', 'email'])]
 class Newsletter
 {
-    /**
-     * @ORM\Id
-     * @ORM\GeneratedValue
-     * @ORM\Column(type="integer")
-     */
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
     private ?int $id = null;
 
-    /**
-     * @ORM\Column(type="datetime_immutable", options={"default"="CURRENT_TIMESTAMP"})
-     */
+    #[ORM\Column(type: 'datetime_immutable', options: ['default' => 'CURRENT_TIMESTAMP'])]
     private $created_at;
 
-    /**
-     * @ORM\Column(type="string", length=255, unique=true)
-     * @Assert\Email
-     */
+    #[ORM\Column(length: 255, unique: true)]
+    #[Assert\Email]
     private ?string $email = null;
 
-    /**
-     * @ORM\Column(type="string", length=255, nullable=true, unique=true)
-     */
+    #[ORM\Column(length: 255, nullable: true, unique: true)]
     private ?string $token = null;
 
-    /**
-     * @ORM\Column(type="boolean")
-     */
+    #[ORM\Column]
     private ?bool $is_confirmed = null;
 
     public function __construct()
@@ -69,7 +57,7 @@ public function getEmail(): ?string
         return $this->email;
     }
 
-    public function setEmail(string $email): self
+    public function setEmail(string $email): static
     {
         $this->email = $email;
 
@@ -81,7 +69,7 @@ public function getToken(): ?string
         return $this->token;
     }
 
-    public function setToken(?string $token): self
+    public function setToken(?string $token): static
     {
         $this->token = $token;
 
@@ -93,7 +81,7 @@ public function getIsConfirmed(): ?bool
         return $this->is_confirmed;
     }
 
-    public function setIsConfirmed(bool $is_confirmed): self
+    public function setIsConfirmed(bool $is_confirmed): static
     {
         $this->is_confirmed = $is_confirmed;
 

LICENSE

@@ -0,0 +1,9 @@
+Copyright 2022 Mikael Fourré
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Join Us

README.md

@@ -0,0 +1,100 @@
+# NewsletterBundle
+
+## About
+
+This project is an **application bundle** for Symfony, designed to be intrinsically integrated into an existing application. It revolves around a newsletter management system, enabling the efficient dispatch of information and announcements to subscribed users.
+
+## Configuration
+
+### Installation
+
+Clone the repository into your Symfony project:
+
+```shell
+git clone https://github.com/mikael-fourre/NewsletterBundle
+```
+
+Ensure the bundle is registered in your `config/bundles.php` file:
+
+```php
+return [
+    // ...
+    App\Bundle\NewsletterBundle\NewsletterBundle::class => ['all' => true],
+];
+```
+
+### Routing Configuration
+
+Add the bundle's routes to your routing configuration.
+
+```yaml
+# config/routes.yaml
+
+newsletter_bundle:
+    resource: '@NewsletterBundle/config/routes.yaml'
+```
+
+The routes provided by the bundle are:
+
+- `newsletter_subscribe`: Handles newsletter subscriptions
+- `newsletter_confirm`: Manages subscription confirmations
+- `newsletter_unsubscribe`: Manages unsubscriptions
+- `newsletter_send`: Sends newsletters to all subscribed users (admin access only)
+
+### Template Configuration
+
+Configure the template paths by adjusting your `twig.yaml` file to recognize the NewsletterBundle's templates.
+
+```yaml
+# config/packages/twig.yaml
+
+twig:
+    paths:
+        '%kernel.project_dir%/src/Bundle/NewsletterBundle/templates': NewsletterBundle
+```
+
+### Parameters Configuration
+
+Define custom parameters in your services.yaml file to configure the contact email address.
+
+```yaml
+# config/services.yaml
+
+parameters:
+    contact_email: contact@domain.fr
+```
+
+### Security Configuration
+
+Secure the administration route by adjusting your `security.yaml` file.
+
+```yaml
+# config/packages/security.yaml
+
+security:
+    access_control:
+        - { path: ^/admin, roles: ROLE_ADMIN }
+```
+
+## Usage
+
+- **Subscription**: Send a POST request to `/newsletter/subscribe`
+- **Confirmation**: Redirect users to `/newsletter/confirm`
+- **Unsubscription**: Use `/newsletter/unsubscribe` for unsubscriptions
+- **Newsletter Sending** (admin only): A POST request to `/admin/newsletter/send` sends newsletters
+
+## Contributing
+
+Contributions are always welcome! To contribute:
+
+- Fork the project
+- Create a branch for your modifications
+- Submit a Pull Request
+
+## Support
+
+Should you encounter issues or have questions, feel free to open an issue on GitHub.
+
+## License
+
+This project is licensed under the terms of the [MIT License](LICENSE). For more information, please refer to the file.

Service/ConfirmationService.php

@@ -11,27 +11,14 @@
  */
 class ConfirmationService
 {
-    /**
-     * @var NewsletterRepository
-     */
-    private $newsletterRepository;
-
-    /**
-     * @var EntityManagerInterface
-     */
-    private $entityManager;
-
     /**
      * @param NewsletterRepository $newsletterRepository
      * @param EntityManagerInterface $entityManager
      */
     public function __construct(
-        NewsletterRepository $newsletterRepository,
-        EntityManagerInterface $entityManager
-    ) {
-        $this->newsletterRepository = $newsletterRepository;
-        $this->entityManager = $entityManager;
-    }
+        private NewsletterRepository $newsletterRepository,
+        private EntityManagerInterface $entityManager
+    ){}
 
     /**
      * Confirm a newsletter subscription using a token.

Service/MailerService.php

@@ -24,18 +24,12 @@ class MailerService
      */
     private const NEWS_TEMPLATE_PATH = '@NewsletterBundle/emails/news.html.twig';
 
-    /**
-     * @var MailerInterface
-     */
-    private $mailer;
-
     /**
      * @param MailerInterface $mailer
      */
-    public function __construct(MailerInterface $mailer)
-    {
-        $this->mailer = $mailer;
-    }
+    public function __construct(
+        private MailerInterface $mailer
+    ){}
 
     /**
      * Send a newsletter email.

Service/NewsletterService.php

@@ -9,27 +9,14 @@
  */
 class NewsletterService
 {
-    /**
-     * @var MailerService
-     */
-    private $mailerService;
-
-    /**
-     * @var NewsletterRepository
-     */
-    private $newsletterRepository;
-
     /**
      * @param MailerService $mailerService
      * @param NewsletterRepository $newsletterRepository
      */
     public function __construct(
-        MailerService $mailerService,
-        NewsletterRepository $newsletterRepository
-    ) {
-        $this->mailerService = $mailerService;
-        $this->newsletterRepository = $newsletterRepository;
-    }
+        private MailerService $mailerService,
+        private NewsletterRepository $newsletterRepository
+    ){}
 
     /**
      * Send a newsletter to all confirmed subscribers.

Service/SubscriptionService.php

@@ -13,35 +13,16 @@
  */
 class SubscriptionService
 {
-    /**
-     * @var EntityManagerInterface
-     */
-    private $entityManager;
-
-    /**
-     * @var NewsletterRepository
-     */
-    private $newsletterRepository;
-
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
-
     /**
      * @param EntityManagerInterface $entityManager
      * @param NewsletterRepository $newsletterRepository
      * @param LoggerInterface $logger
      */
     public function __construct(
-        EntityManagerInterface $entityManager,
-        NewsletterRepository $newsletterRepository,
-        LoggerInterface $logger
-    ) {
-        $this->entityManager = $entityManager;
-        $this->newsletterRepository = $newsletterRepository;
-        $this->logger = $logger;
-    }
+        private EntityManagerInterface $entityManager,
+        private NewsletterRepository $newsletterRepository,
+        private LoggerInterface $logger
+    ){}
 
     /**
      * Find and return a newsletter subscription by email address.

Service/UnsubscribeService.php

@@ -10,27 +10,14 @@
  */
 class UnsubscribeService
 {
-    /**
-     * @var NewsletterRepository
-     */
-    private $newsletterRepository;
-
-    /**
-     * @var EntityManagerInterface
-     */
-    private $entityManager;
-
     /**
      * @param NewsletterRepository $newsletterRepository
      * @param EntityManagerInterface $entityManager
      */
     public function __construct(
-        NewsletterRepository $newsletterRepository,
-        EntityManagerInterface $entityManager
-    ) {
-        $this->newsletterRepository = $newsletterRepository;
-        $this->entityManager = $entityManager;
-    }
+        private NewsletterRepository $newsletterRepository,
+        private EntityManagerInterface $entityManager
+    ){}
 
     /**
      * Remove a newsletter subscription by a given token.