tonyair/silverstripe-contentreview
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-contentreview synced 2024-10-22 17:05:47 +02:00
Code Issues Projects Releases Wiki Activity

API Deprecate isValidEmail() method (#262)

Browse Source
This commit is contained in:
Guy Sartorelli 2024-09-25 16:11:45 +12:00 committed by GitHub
parent 3f09b871c3
commit 40e45cda53
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/Tasks/ContentReviewEmails.php
View File

@ -8,6 +8,7 @@ use SilverStripe\ContentReview\Compatibility\ContentReviewCompatability;
use SilverStripe\Control\Email\Email; use SilverStripe\Control\Email\Email;
use SilverStripe\Control\HTTPRequest; use SilverStripe\Control\HTTPRequest;
use SilverStripe\Dev\BuildTask; use SilverStripe\Dev\BuildTask;
use SilverStripe\Dev\Deprecation;
use SilverStripe\ORM\ArrayList; use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\FieldType\DBDatetime; use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\ORM\FieldType\DBField; use SilverStripe\ORM\FieldType\DBField;
@ -30,7 +31,8 @@ class ContentReviewEmails extends BuildTask
*/ */
public function run($request) 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( throw new RuntimeException(
sprintf( sprintf(
'Provided sender email address is invalid: "%s".', 'Provided sender email address is invalid: "%s".',
@ -116,7 +118,7 @@ class ContentReviewEmails extends BuildTask
$siteConfig = SiteConfig::current_site_config(); $siteConfig = SiteConfig::current_site_config();
$owner = Member::get()->byID($ownerID); $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; $this->invalid_emails[] = $owner->Name . ': ' . $owner->Email;
return; return;
@ -191,9 +193,11 @@ class ContentReviewEmails extends BuildTask
/** /**
* Check validity of email * Check validity of email
* @deprecated 5.4.0 Use SilverStripe\Control\Email\Email::is_valid_address() instead.
*/ */
protected function isValidEmail(?string $email): bool 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); return (bool) filter_var($email, FILTER_VALIDATE_EMAIL);
} }
} }

3
tests/php/ContentReviewNotificationTest.php
View File

@ -12,6 +12,7 @@ use SilverStripe\ContentReview\Extensions\ContentReviewOwner;
use SilverStripe\ContentReview\Extensions\SiteTreeContentReview; use SilverStripe\ContentReview\Extensions\SiteTreeContentReview;
use SilverStripe\ContentReview\Tasks\ContentReviewEmails; use SilverStripe\ContentReview\Tasks\ContentReviewEmails;
use SilverStripe\Control\HTTPRequest; use SilverStripe\Control\HTTPRequest;
use SilverStripe\Dev\Deprecation;
use SilverStripe\Dev\SapphireTest; use SilverStripe\Dev\SapphireTest;
use SilverStripe\ORM\FieldType\DBDatetime; use SilverStripe\ORM\FieldType\DBDatetime;
use SilverStripe\Security\Group; use SilverStripe\Security\Group;
@ -145,12 +146,14 @@ class ContentReviewNotificationTest extends SapphireTest
$member = $this->objFromFixture(Member::class, 'author'); $member = $this->objFromFixture(Member::class, 'author');
$task = new ContentReviewEmails(); $task = new ContentReviewEmails();
Deprecation::withSuppressedNotice(function () use ($method, $task, $member) {
$this->assertTrue($method->invokeArgs($task, [$member->Email])); $this->assertTrue($method->invokeArgs($task, [$member->Email]));
$this->assertTrue($method->invokeArgs($task, ['correct.email@example.com'])); $this->assertTrue($method->invokeArgs($task, ['correct.email@example.com']));
$this->assertFalse($method->invokeArgs($task, [null])); $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, ['broken@email'])); $this->assertFalse($method->invokeArgs($task, ['broken@email']));
});
} }
/** /**