API Deprecate isValidEmail() method (#262)

silverstripe · Sep 25, 2024 · 40e45cd · 40e45cd
1 parent 3f09b87
commit 40e45cd
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/src/Tasks/ContentReviewEmails.php b/src/Tasks/ContentReviewEmails.php
@@ -8,6 +8,7 @@
 use SilverStripe\Control\Email\Email;
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Dev\BuildTask;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\ORM\ArrayList;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\ORM\FieldType\DBField;
@@ -30,7 +31,8 @@ class ContentReviewEmails extends BuildTask
      */
     public function run($request)
     {
-        if (!$this->isValidEmail($senderEmail = SiteConfig::current_site_config()->ReviewFrom)) {
+        $senderEmail = SiteConfig::current_site_config()->ReviewFrom;
+        if (!Deprecation::withSuppressedNotice(fn() => $this->isValidEmail($senderEmail))) {
             throw new RuntimeException(
                 sprintf(
                     'Provided sender email address is invalid: "%s".',
@@ -116,7 +118,7 @@ protected function notifyOwner($ownerID, SS_List $pages)
         $siteConfig = SiteConfig::current_site_config();
         $owner = Member::get()->byID($ownerID);
 
-        if (!$this->isValidEmail($owner->Email)) {
+        if (!Deprecation::withSuppressedNotice(fn() => $this->isValidEmail($owner->Email))) {
             $this->invalid_emails[] = $owner->Name . ': ' . $owner->Email;
 
             return;
@@ -191,9 +193,11 @@ protected function getTemplateVariables($recipient, $config, $pages)
 
     /**
      * Check validity of email
+     * @deprecated 5.4.0 Use SilverStripe\Control\Email\Email::is_valid_address() instead.
      */
     protected function isValidEmail(?string $email): bool
     {
+        Deprecation::notice('5.4.0', 'Use ' . Email::class . '::is_valid_address() instead.');
         return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
     }
 }
diff --git a/tests/php/ContentReviewNotificationTest.php b/tests/php/ContentReviewNotificationTest.php
@@ -12,6 +12,7 @@
 use SilverStripe\ContentReview\Extensions\SiteTreeContentReview;
 use SilverStripe\ContentReview\Tasks\ContentReviewEmails;
 use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Dev\Deprecation;
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\Security\Group;
@@ -145,12 +146,14 @@ public function testIsValidEmail()
         $member = $this->objFromFixture(Member::class, 'author');
         $task = new ContentReviewEmails();
 
-        $this->assertTrue($method->invokeArgs($task, [$member->Email]));
-        $this->assertTrue($method->invokeArgs($task, ['correct.email@example.com']));
+        Deprecation::withSuppressedNotice(function () use ($method, $task, $member) {
+            $this->assertTrue($method->invokeArgs($task, [$member->Email]));
+            $this->assertTrue($method->invokeArgs($task, ['correct.email@example.com']));
 
-        $this->assertFalse($method->invokeArgs($task, [null]));
-        $this->assertFalse($method->invokeArgs($task, ['broken.email']));
-        $this->assertFalse($method->invokeArgs($task, ['broken@email']));
+            $this->assertFalse($method->invokeArgs($task, [null]));
+            $this->assertFalse($method->invokeArgs($task, ['broken.email']));
+            $this->assertFalse($method->invokeArgs($task, ['broken@email']));
+        });
     }
 
     /**