symfony · fabpot · Jan 12, 2025 · Jan 11, 2025 · mtarld · Jan 12, 2025
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetTransportFactory.php b/src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetTransportFactory.php
@@ -24,7 +24,7 @@ public function create(Dsn $dsn): TransportInterface
        $user = $this->getUser($dsn);
        $password = $this->getPassword($dsn);
        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
-        $sandbox = filter_var($dsn->getOption('sandbox', false), \FILTER_VALIDATE_BOOL);
+        $sandbox = $dsn->getBooleanOption('sandbox');

        if ('mailjet+api' === $scheme) {
            return (new MailjetApiTransport($user, $password, $this->client, $this->dispatcher, $this->logger, $sandbox))->setHost($host);

diff --git a/src/Symfony/Component/Mailer/Bridge/Mailjet/composer.json b/src/Symfony/Component/Mailer/Bridge/Mailjet/composer.json
@@ -17,7 +17,7 @@
    ],
    "require": {
        "php": ">=8.2",
-        "symfony/mailer": "^7.2"
+        "symfony/mailer": "^7.3"
    },
    "require-dev": {
        "symfony/http-client": "^6.4|^7.0",

diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---

 * Add DSN param `retry_period` to override default email transport retry period
+ * Add `Dsn::getBooleanOption()`

 7.2
 ---

diff --git a/src/Symfony/Component/Mailer/Tests/Transport/DsnTest.php b/src/Symfony/Component/Mailer/Tests/Transport/DsnTest.php
@@ -105,4 +105,29 @@ public static function invalidDsnProvider(): iterable
            'The mailer DSN must contain a host (use "default" by default).',
        ];
    }
+
+    /**
+     * @dataProvider getBooleanOptionProvider
+     */
+    public function testGetBooleanOption(bool $expected, string $dsnString, string $option, bool $default)
+    {
+        $dsn = Dsn::fromString($dsnString);
+
+        $this->assertSame($expected, $dsn->getBooleanOption($option, $default));
+    }
+
+    public static function getBooleanOptionProvider(): iterable
+    {
+        yield [true, 'scheme://localhost?enabled=1', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=true', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=on', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=yes', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=0', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=false', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=off', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=no', 'enabled', false];
+
+        yield [false, 'scheme://localhost', 'not_existant', false];
+        yield [true, 'scheme://localhost', 'not_existant', true];
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Transport/Dsn.php b/src/Symfony/Component/Mailer/Transport/Dsn.php
@@ -79,4 +79,9 @@ public function getOption(string $key, mixed $default = null): mixed
    {
        return $this->options[$key] ?? $default;
    }
+
+    public function getBooleanOption(string $key, bool $default = false): bool
+    {
+        return filter_var($this->getOption($key, $default), \FILTER_VALIDATE_BOOLEAN);
+    }
 }
@@ -25,8 +25,8 @@ public function create(Dsn $dsn): IsendproTransport

        $keyid = $this->getUser($dsn);
        $from = $dsn->getOption('from', null);
-        $noStop = filter_var($dsn->getOption('no_stop', false), \FILTER_VALIDATE_BOOLEAN);
-        $sandbox = filter_var($dsn->getOption('sandbox', false), \FILTER_VALIDATE_BOOLEAN);
+        $noStop = $dsn->getBooleanOption('no_stop');
+        $sandbox = $dsn->getBooleanOption('sandbox');
        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
        $port = $dsn->getPort();


@@ -22,7 +22,7 @@
    "require": {
        "php": ">=8.2",
        "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
    },
    "require-dev": {
        "symfony/event-dispatcher": "^6.4|^7.0"

@@ -33,7 +33,7 @@ public function create(Dsn $dsn): OvhCloudTransport
        $consumerKey = $dsn->getRequiredOption('consumer_key');
        $serviceName = $dsn->getRequiredOption('service_name');
        $sender = $dsn->getOption('sender');
-        $noStopClause = filter_var($dsn->getOption('no_stop_clause', false), \FILTER_VALIDATE_BOOL);
+        $noStopClause = $dsn->getBooleanOption('no_stop_clause');
        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
        $port = $dsn->getPort();


@@ -18,7 +18,7 @@
    "require": {
        "php": ">=8.2",
        "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
    },
    "autoload": {
        "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\OvhCloud\\": "" },

@@ -31,7 +31,7 @@ public function create(Dsn $dsn): SmsBiurasTransport
        $uid = $this->getUser($dsn);
        $apiKey = $this->getPassword($dsn);
        $from = $dsn->getRequiredOption('from');
-        $testMode = filter_var($dsn->getOption('test_mode', false), \FILTER_VALIDATE_BOOL);
+        $testMode = $dsn->getBooleanOption('test_mode');
        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
        $port = $dsn->getPort();


@@ -18,7 +18,7 @@
    "require": {
        "php": ">=8.2",
        "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
    },
    "autoload": {
        "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\SmsBiuras\\": "" },

@@ -31,8 +31,8 @@ public function create(Dsn $dsn): SmsapiTransport
        $authToken = $this->getUser($dsn);
        $from = $dsn->getOption('from', '');
        $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
-        $fast = filter_var($dsn->getOption('fast', false), \FILTER_VALIDATE_BOOL);
-        $test = filter_var($dsn->getOption('test', false), \FILTER_VALIDATE_BOOL);
+        $fast = $dsn->getBooleanOption('fast');
+        $test = $dsn->getBooleanOption('test');
        $port = $dsn->getPort();

        return (new SmsapiTransport($authToken, $from, $this->client, $this->dispatcher))->setFast($fast)->setHost($host)->setPort($port)->setTest($test);

@@ -18,7 +18,7 @@
    "require": {
        "php": ">=8.2",
        "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
    },
    "autoload": {
        "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\Smsapi\\": "" },

@@ -1,6 +1,11 @@
 CHANGELOG
 =========

+7.3
+---
+
+ * Add `Dsn::getBooleanOption()`
- * Add `Dsn::getBooleanOption()`
+ * Add `Dsn::getBooleanOption()` method
- * Add `Dsn::getBooleanOption()`
+ * Add `Dsn::getBooleanOption()` method
+
 7.2
 ---


@@ -259,4 +259,29 @@ public static function getRequiredOptionThrowsMissingRequiredOptionExceptionProv
            'with_empty_string',
        ];
    }
+
+    /**
+     * @dataProvider getBooleanOptionProvider
+     */
+    public function testGetBooleanOption(bool $expected, string $dsnString, string $option, bool $default)
+    {
+        $dsn = new Dsn($dsnString);
+
+        $this->assertSame($expected, $dsn->getBooleanOption($option, $default));
+    }
+
+    public static function getBooleanOptionProvider(): iterable
+    {
+        yield [true, 'scheme://localhost?enabled=1', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=true', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=on', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=yes', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=0', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=false', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=off', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=no', 'enabled', false];
+
+        yield [false, 'scheme://localhost', 'not_existant', false];
+        yield [true, 'scheme://localhost', 'not_existant', true];
+    }
 }
@@ -93,6 +93,11 @@ public function getRequiredOption(string $key): mixed
        return $this->options[$key];
    }

+    public function getBooleanOption(string $key, bool $default = false): bool
+    {
+        return filter_var($this->getOption($key, $default), \FILTER_VALIDATE_BOOLEAN);
+    }
+
    public function getOptions(): array
    {
        return $this->options;
-Original file line number
+Diff line change
@@ -5,6 +5,7 @@ CHANGELOG
     ---
      * Add DSN param `retry_period` to override default email transport retry period
+     * Add `Dsn::getBooleanOption()`
                   fabpot marked this conversation as resolved.
              

          
            Show resolved
            Hide resolved
 .2
     ---
-          Expand Down