fix code style and review

DependencyInjection/Configuration.php

@@ -14,7 +14,6 @@
 use Sulu\Bundle\FormBundle\Form\HandlerInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
-use Symfony\Component\Mailer\Mailer;
 
 /**
  * This is the class that validates and merges configuration from your app/config files.
@@ -23,9 +22,8 @@
  */
 class Configuration implements ConfigurationInterface
 {
-    const NULL_HELPER = 'NullHelper';
-    const SWIFT_MAILER_HELPER = 'SwiftMailer';
-    const MAILER_HELPER = 'Mailer';
+    const SWIFT_MAILER_HELPER = 'swift_mailer';
+    const MAILER_HELPER = 'mailer';
 
     /**
      * {@inheritdoc}
@@ -58,7 +56,7 @@ public function getConfigTreeBuilder()
                 ->children()
                     ->scalarNode('helper')
                         ->defaultValue(self::SWIFT_MAILER_HELPER)
-                        ->end()
+                    ->end()
                     ->scalarNode('from')->defaultValue(null)->end()
                     ->scalarNode('to')->defaultValue(null)->end()
                     ->scalarNode('sender')->defaultValue(null)->end()

DependencyInjection/SuluFormExtension.php

@@ -13,15 +13,11 @@
 
 use Sulu\Bundle\FormBundle\Controller\FormTokenController;
 use Sulu\Bundle\FormBundle\Controller\FormWebsiteController;
-use Sulu\Bundle\MediaBundle\Media\Storage\StorageInterface;
 use Sulu\Component\HttpKernel\SuluKernel;
 use Symfony\Component\Config\FileLocator;
-use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 use Symfony\Component\DependencyInjection\Loader;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
 /**
@@ -215,21 +211,13 @@ public function load(array $configs, ContainerBuilder $container)
         $this->configureHelper($config, $container);
     }
 
-
     private function configureHelper(array $config, ContainerBuilder $container)
     {
         $helper = $config['mail']['helper'];
         if (\method_exists($container, 'resolveEnvPlaceholders')) {
             $helper = $container->resolveEnvPlaceholders($helper, true);
         }
-        $container->setParameter('sulu.mail.helper', $helper);
-
-        if ($helper == Configuration::MAILER_HELPER) {
-            $container->setAlias('sulu.mail.helper', 'sulu.mail.mailer');
-        } elseif ($helper == Configuration::NULL_HELPER) {
-            $container->setAlias('sulu.mail.helper', 'sulu_mail.null_helper');
-        } elseif ($helper == Configuration::SWIFT_MAILER_HELPER) {
-            $container->setAlias('sulu.mail.helper', 'sulu.mail.swift_mailer');
-        }
+
+        $container->setAlias('sulu.mail.helper', 'sulu.mail.' . $helper);
     }
 }

Event/RequestListener.php

@@ -17,7 +17,6 @@
 use Sulu\Bundle\FormBundle\Form\HandlerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\RequestEvent;
 
 class RequestListener

Form/Builder.php

@@ -16,8 +16,6 @@
 use Sulu\Bundle\FormBundle\Entity\Dynamic;
 use Sulu\Bundle\FormBundle\Entity\Form;
 use Sulu\Bundle\FormBundle\Form\Type\DynamicFormType;
-use Sulu\Bundle\FormBundle\Mail\HelperAwareInterface;
-use Sulu\Bundle\FormBundle\Mail\HelperInterface;
 use Sulu\Bundle\FormBundle\Repository\FormRepository;
 use Sulu\Bundle\FormBundle\TitleProvider\TitleProviderPoolInterface;
 use Symfony\Component\Form\FormFactory;
@@ -274,5 +272,4 @@ private function getWebspaceKey(): ?string
 
         return $webspaceKey;
     }
-
 }

Form/Handler.php

@@ -74,7 +74,6 @@ public function __construct(
         string $honeyPotStrategy = self::HONEY_POT_STRATEGY_SPAM,
         string $honeyPotField = null
     ) {
-
         $this->entityManager = $entityManager;
         $this->mailHelper = $mailHelper;
         $this->twig = $twig;

Mail/MailerHelper.php

@@ -28,22 +28,22 @@ class MailerHelper implements HelperInterface
     /**
      * @var null|string
      */
-    protected $toMail;
+    private $toMail;
 
     /**
      * @var null|string
      */
-    protected $fromMail;
+    private $fromMail;
 
     /**
      * @var string|null
      */
-    protected $sender;
+    private $sender;
 
     /**
      * @var LoggerInterface
      */
-    protected $logger;
+    private $logger;
 
     public function __construct(
         MailerInterface $mailer,
@@ -60,7 +60,7 @@ public function __construct(
     }
 
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     public function sendMail(
         $subject,
@@ -73,8 +73,7 @@ public function sendMail(
         $ccMail = [],
         $bccMail = [],
         $plainText = null
-    ): int
-    {
+    ): int {
         $message = new Email();
 
         $this->setHeaders(
@@ -101,6 +100,7 @@ public function sendMail(
         );
 
         $this->mailer->send($message);
+
         return 0;
     }
 
@@ -113,13 +113,13 @@ public function sendMail(
      * @param Email $message email message
      * @param string $subject subject of the email
      * @param Address[] $fromMail list of addresses already accounting for the defaults
-     * @param Address[] $toMail  list of addresses already accounting for the defaults
+     * @param Address[] $toMail list of addresses already accounting for the defaults
      * @param Address[] $replyTo list of addresses already accounting for the defaults may be an empty array
      * @param Address[] $ccMail list of addresses already accounting for the defaults may be an empty array
      * @param Address[] $bccMail list of addresses already accounting for the defaults may be an empty array
      * @param Address|null $sender address already accounting for the defaults
      */
-    protected function setHeaders(
+    private function setHeaders(
         Email $message,
         string $subject,
         array $fromMail,
@@ -128,8 +128,7 @@ protected function setHeaders(
         array $ccMail,
         array $bccMail,
         ?Address $sender
-    ): void
-    {
+    ): void {
         $message->subject($subject);
         $message->from(...$fromMail);
         $message->to(...$toMail);
@@ -149,14 +148,12 @@ protected function setHeaders(
     }
 
     /**
-     * @param Email $message
      * @param \SplFileInfo[] $attachments
      */
-    protected function setAttachments(
+    private function setAttachments(
         Email $message,
         array $attachments
-    ): void
-    {
+    ): void {
         foreach ($attachments as $file) {
             if (!($file instanceof \SplFileInfo)) {
                 continue;
@@ -173,18 +170,14 @@ protected function setAttachments(
     }
 
     /**
-     * @param Email $message
-     * @param bool $html
-     * @param string $body
      * @param string $plainText
      */
-    protected function setBody(
+    private function setBody(
         Email $message,
         bool $html,
         string $body,
         ?string $plainText
-    ): void
-    {
+    ): void {
         if ($html) {
             $message->html($body);
         } else {
@@ -200,9 +193,6 @@ protected function setBody(
      * @param string|array $fromMail
      * @param string|array $toMail
      * @param string|array $replyTo
-     * @param string $subject
-     * @param array $ccMail
-     * @param array $bccMail
      * @param string $plainText
      */
     private function logMessage(
@@ -213,8 +203,7 @@ private function logMessage(
         array $ccMail,
         array $bccMail,
         ?string $plainText
-    ): void
-    {
+    ): void {
         $this->logger->info(sprintf(
             'Try register mail from SuluFormBundle: ' . PHP_EOL .
             '   From: %s' . PHP_EOL .
@@ -236,6 +225,7 @@ private function logMessage(
 
     /**
      * @param string|array $fromMail email address or [email-address => name] for muliple named addresses
+     *
      * @return Address[]
      */
     private function parseToAddresses($fromMail): array

Resources/config/services.xml

@@ -18,15 +18,7 @@
         </service>
         <service id="Sulu\Bundle\FormBundle\Form\HandlerInterface" alias="sulu_form.handler"/>
 
-        <service id="sulu.mail.helper_aware_configurator" class="Sulu\Bundle\FormBundle\Mail\HelperAwareConfigurator">
-            <argument type="service" id="sulu.mail.helper" />
-            <argument type="tagged_iterator" tag="sulu_mail.handler" index-by="key" />
-            <argument>%sulu_mail.mail.helper_name%</argument>
-        </service>
-
         <!-- Mail-->
-        <service id="sulu.mail.helper" alias="sulu.mail.swift_mailer" />
-
         <service id="sulu.mail.swift_mailer" class="Sulu\Bundle\FormBundle\Mail\Helper">
             <argument type="service" id="mailer" />
             <argument>%sulu_form.mail.from%</argument>
@@ -45,7 +37,7 @@
 
         <service id="sulu_mail.null_helper" class="Sulu\Bundle\FormBundle\Mail\NullHelper">
             <argument type="service" id="logger" />
-            <tag name="sulu_mail.handler" key="NullHelper" />
+            <deprecated />
         </service>
 
         <!-- Admin -->

Resources/doc/index.md

@@ -53,7 +53,7 @@ Symfony mailer):
 ```yml
 sulu_form:
     mail:
-        helper: "SwiftMailer"
+        helper: "swift_mailer" # is default
 ```
 
 ## Create Database

SuluFormBundle.php

@@ -13,10 +13,8 @@
 
 use Sulu\Bundle\FormBundle\DependencyInjection\CompilerPass\DynamicListBuilderCompilerPass;
 use Sulu\Bundle\FormBundle\DependencyInjection\CompilerPass\ListProviderCompilerPass;
-use Sulu\Bundle\FormBundle\DependencyInjection\CompilerPass\MailHelperCompilerPass;
 use Sulu\Bundle\FormBundle\DependencyInjection\CompilerPass\RemoveTaggedServiceCollectorCompilerPass;
 use Sulu\Component\Symfony\CompilerPass\TaggedServiceCollectorCompilerPass;
-use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 

Tests/Application/.env

@@ -1,4 +1,4 @@
 APP_ENV=test
-DATABASE_URL=mysql://root:@127.0.0.1:3306/su_form_test
+DATABASE_URL=mysql://root:root@127.0.0.1:3306/su_form_test
 DATABASE_CHARSET=utf8mb4
 DATABASE_COLLATE=utf8mb4_unicode_ci

Tests/Application/Kernel.php

@@ -11,13 +11,9 @@
 
 namespace Sulu\Bundle\FormBundle\Tests\Application;
 
-use Sulu\Bundle\FormBundle\Tests\Application\Controller\DefaultController;
 use Sulu\Bundle\FormBundle\SuluFormBundle;
 use Sulu\Bundle\TestBundle\Kernel\SuluTestKernel;
 use Symfony\Component\Config\Loader\LoaderInterface;
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Definition;
 
 class Kernel extends SuluTestKernel
 {

Tests/Application/MailerKernel.php

@@ -1,9 +1,16 @@
 <?php
 
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
 
 namespace Sulu\Bundle\FormBundle\Tests\Application;
 
-
 use Symfony\Component\Config\Loader\LoaderInterface;
 
 class MailerKernel extends Kernel
@@ -20,7 +27,7 @@ public function getCacheDir()
         return $this->getProjectDir() . \DIRECTORY_SEPARATOR
             . 'var' . \DIRECTORY_SEPARATOR
             . 'cache' . \DIRECTORY_SEPARATOR
-            . $this->getContext()  . \DIRECTORY_SEPARATOR
-            . $this->environment;
+            . $this->getContext() . \DIRECTORY_SEPARATOR
+            . $this->environment . '_mailer';
     }
 }

Tests/Application/config/config.yml

@@ -3,6 +3,7 @@ parameters:
 
 framework:
     esi: ~
+    csrf_protection: false
     profiler: { only_exceptions: false }
     fragments: ~
 

Tests/Application/config/config_test_mailer.yaml

@@ -1,6 +1,3 @@
-#import:
-#    - config.yml
-#
 sulu_form:
     mail:
-        helper: 'Mailer'
+        helper: 'mailer'

Tests/Functional/Mail/Fixtures/LoadFormFixture.php

@@ -1,9 +1,16 @@
 <?php
 
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
 
 namespace Sulu\Bundle\FormBundle\Tests\Functional\Mail\Fixtures;
 
-
 use Doctrine\Common\DataFixtures\FixtureInterface;
 use Doctrine\Persistence\ObjectManager;
 use Sulu\Bundle\FormBundle\Configuration\MailConfiguration;
@@ -110,8 +117,5 @@ public function load(ObjectManager $manager)
         $formField->setForm($form);
 
         $manager->persist($form);
-        $manager->flush();
-        $manager->clear();
     }
-
 }