Skip to content

Commit 3333a79

Browse files
touhidurabirtouhidurabir
committed
#5885 Review remainder update issues fixed
1 parent dd1bfa5 commit 3333a79

File tree

9 files changed

+44
-50
lines changed

9 files changed

+44
-50
lines changed

‎classes/components/forms/context/PKPReviewSetupForm.php‎

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,21 +92,8 @@ public function __construct($action, $locales, $context)
9292
]));
9393

9494
if (Config::getVar('general', 'scheduled_tasks')) {
95-
// $this->addField(new FieldText('numDaysBeforeInviteReminder', [
96-
// 'label' => __('manager.setup.reviewOptions.reminders.response'),
97-
// 'description' => __('manager.setup.reviewOptions.reminders.response.description'),
98-
// 'value' => $context->getData('numDaysBeforeInviteReminder'),
99-
// 'size' => 'small',
100-
// ]))
101-
// ->addField(new FieldText('numDaysBeforeSubmitReminder', [
102-
// 'label' => __('manager.setup.reviewOptions.reminders.submit'),
103-
// 'description' => __('manager.setup.reviewOptions.reminders.submit.description'),
104-
// 'value' => $context->getData('numDaysBeforeSubmitReminder'),
105-
// 'size' => 'small',
106-
// ]));
107-
10895
$this
109-
->addField(new FieldHTML('reviewRequestResponseRemainder', [
96+
->addField(new FieldHTML('reviewRequestResponseReminder', [
11097
'label' => __('manager.setup.reviewOptions.reminders.response'),
11198
'description' => __('manager.setup.reviewOptions.reminders.response.description'),
11299
]))
@@ -120,7 +107,7 @@ public function __construct($action, $locales, $context)
120107
'value' => $context->getData('numDaysAfterReviewResponseReminderDue'),
121108
'size' => 'small',
122109
]))
123-
->addField(new FieldHTML('submissionReviewResponseRemainder', [
110+
->addField(new FieldHTML('submissionReviewResponseReminder', [
124111
'label' => __('manager.setup.reviewOptions.reminders.submit'),
125112
'description' => __('manager.setup.reviewOptions.reminders.submit.description'),
126113
]))

‎classes/form/validation/FormValidatorDateCompare.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
namespace PKP\form\validation;
2020

21-
use PKP\validation\ValidatorDateConparison;
21+
use PKP\validation\ValidatorDateComparison;
2222
use Carbon\Carbon;
2323
use DateTimeInterface;
2424

@@ -34,9 +34,9 @@ class FormValidatorDateCompare extends FormValidator
3434
* @param string $type the type of check, either "required" or "optional"
3535
* @param string $message the error message for validation failures (i18n key)
3636
*/
37-
public function __construct(&$form, $field, $comparingDate, $comparingRule, $type = 'optional', $message = 'email.invalid')
37+
public function __construct(&$form, $field, $comparingDate, $comparingRule, $type = 'optional', $message = 'validator.date.comparison')
3838
{
39-
$validator = new ValidatorDateConparison($comparingDate, $comparingRule);
39+
$validator = new ValidatorDateComparison($comparingDate, $comparingRule);
4040
parent::__construct($form, $field, $type, $message, $validator);
4141
}
4242
}

classes/migration/upgrade/v3_5_0/I5885_RenameReviewRemainderSettingsName.php renamed to classes/migration/upgrade/v3_5_0/I5885_RenameReviewReminderSettingsName.php

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,23 @@
11
<?php
22

33
/**
4-
* @file classes/migration/upgrade/v3_5_0/I5885_RenameReviewRemainderSettingsName.php
4+
* @file classes/migration/upgrade/v3_5_0/I5885_RenameReviewReminderSettingsName.php
55
*
66
* Copyright (c) 2014-2024 Simon Fraser University
77
* Copyright (c) 2000-2024 John Willinsky
88
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
99
*
10-
* @class I5885_RenameReviewRemainderColumns
10+
* @class I5885_RenameReviewReminderSettingsName
1111
*
12-
* @brief Rename the review remainder settings name
12+
* @brief Rename the review reminder settings name
1313
*/
1414

1515
namespace PKP\migration\upgrade\v3_5_0;
1616

17-
use Illuminate\Database\Schema\Blueprint;
1817
use Illuminate\Support\Facades\DB;
19-
use Illuminate\Support\Facades\Schema;
2018
use PKP\migration\Migration;
2119

22-
abstract class I5885_RenameReviewRemainderSettingsName extends Migration
20+
abstract class I5885_RenameReviewReminderSettingsName extends Migration
2321
{
2422
abstract protected function getContextSettingsTable(): string;
2523

‎classes/task/ReviewReminder.php‎

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
use PKP\mail\mailables\ReviewResponseRemindAuto;
2424
use PKP\scheduledTask\ScheduledTask;
2525
use PKP\submission\PKPSubmission;
26-
use PKP\jobs\email\ReviewRemainder as ReviewRemainderJob;
26+
use PKP\jobs\email\ReviewReminder as ReviewReminderJob;
2727

2828
class ReviewReminder extends ScheduledTask
2929
{
@@ -84,19 +84,20 @@ public function executeActions()
8484
$dateDue = Carbon::parse($reviewAssignment->getDateDue())->startOfDay();
8585

8686
if ($reviewAssignment->getDateReminded() !== null) {
87-
// we have a remainder sent previously
87+
// we have a reminder sent previously
8888

8989
$dateReminded = Carbon::parse($reviewAssignment->getDateReminded())->startOfDay();
9090

9191
if ($reviewAssignment->getDateConfirmed() === null) {
9292
// review request has not been responded
93-
// previous remainder was a BEFORE REVIEW REQUEST RESPONSE remainder
93+
// previous reminder was a BEFORE REVIEW REQUEST RESPONSE reminder
9494

95-
if ($dateReminded->lt($dateResponseDue) &&
95+
if ($numDaysAfterReviewResponseReminderDue &&
96+
$dateReminded->lt($dateResponseDue) &&
9697
$currentDate->gte($dateResponseDue) &&
9798
$currentDate->diffInDays($dateResponseDue) >= $numDaysAfterReviewResponseReminderDue) {
9899

99-
// ACTION:-> we need to sent a AFTER REVIEW REQUEST RESPONSE remainder
100+
// ACTION:-> we need to sent a AFTER REVIEW REQUEST RESPONSE reminder
100101
$mailable = ReviewResponseRemindAuto::class;
101102
}
102103
} else {
@@ -106,35 +107,35 @@ public function executeActions()
106107
$currentDate->lt($dateDue) &&
107108
$dateDue->diffInDays($currentDate) <= $numDaysBeforeReviewSubmitReminderDue) {
108109

109-
// no review submit remainder has been sent
110+
// no review submit reminder has been sent
110111

111-
// ACTION:-> we need to sent a BEFORE REVIEW SUBMIT remainder
112+
// ACTION:-> we need to sent a BEFORE REVIEW SUBMIT reminder
112113
$mailable = ReviewRemindAuto::class;
113114

114115
} else if ( $numDaysAfterReviewSubmitReminderDue &&
115116
$dateReminded->lt($dateDue) &&
116117
$currentDate->gt($dateDue) &&
117118
$currentDate->diffInDays($dateDue) >= $numDaysAfterReviewSubmitReminderDue) {
118119

119-
// ACTION:-> we need to sent a AFTER REVIEW SUBMIT remainder
120+
// ACTION:-> we need to sent a AFTER REVIEW SUBMIT reminder
120121
$mailable = ReviewRemindAuto::class;
121122
}
122123
}
123124
} else if ($reviewAssignment->getDateConfirmed() != null) {
124125
// the review request has been responded
125-
// as long review request has respnded, only need to concern with BEFORE/AFTER REVIEW SUBMIT remainder
126+
// as long review request has respnded, only need to concern with BEFORE/AFTER REVIEW SUBMIT reminder
126127
if ($numDaysAfterReviewSubmitReminderDue &&
127128
$currentDate->gt($dateDue) &&
128129
$currentDate->diffInDays($dateDue) >= $numDaysAfterReviewSubmitReminderDue) {
129130

130-
// ACTION:-> we need to send AFTER REVIEW SUBMIT remainder
131+
// ACTION:-> we need to send AFTER REVIEW SUBMIT reminder
131132
$mailable = ReviewRemindAuto::class;
132133

133134
} else if ( $numDaysBeforeReviewSubmitReminderDue &&
134135
$dateDue->gt($currentDate) &&
135136
$dateDue->diffInDays($currentDate) <= $numDaysBeforeReviewSubmitReminderDue) {
136137

137-
// ACTION:-> we need to send BEFORE REVIEW SUBMIT remainder
138+
// ACTION:-> we need to send BEFORE REVIEW SUBMIT reminder
138139
$mailable = ReviewRemindAuto::class;
139140
}
140141
} else {
@@ -143,20 +144,25 @@ public function executeActions()
143144
$currentDate->gt($dateResponseDue) &&
144145
$currentDate->diffInDays($dateResponseDue) >= $numDaysAfterReviewResponseReminderDue) {
145146

146-
// ACTION:-> we need to send AFTER REVIEW REQUEST RESPONSE remainder
147+
// ACTION:-> we need to send AFTER REVIEW REQUEST RESPONSE reminder
147148
$mailable = ReviewResponseRemindAuto::class;
148149

149150
} else if ( $numDaysBeforeReviewResponseReminderDue &&
150151
$dateResponseDue->gt($currentDate) &&
151152
$dateResponseDue->diffInDays($currentDate) <= $numDaysBeforeReviewResponseReminderDue) {
152153

153-
// ACTION:-> we need to send BEFORE REVIEW REQUEST RESPONSE remainder
154+
// ACTION:-> we need to send BEFORE REVIEW REQUEST RESPONSE reminder
154155
$mailable = ReviewResponseRemindAuto::class;
155156
}
156157
}
157158

158159
if ($mailable) {
159-
ReviewRemainderJob::dispatch($reviewAssignment->getId(), $submission->getId(), $context->getId(), $mailable);
160+
ReviewReminderJob::dispatch(
161+
$reviewAssignment->getId(),
162+
$submission->getId(),
163+
$context->getId(),
164+
$mailable
165+
);
160166
}
161167
}
162168

classes/validation/ValidatorDateConparison.php renamed to classes/validation/ValidatorDateComparison.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<?php
22

33
/**
4-
* @file classes/validation/ValidatorDateConparison.php
4+
* @file classes/validation/ValidatorDateComparison.php
55
*
66
* Copyright (c) 2014-2021 Simon Fraser University
77
* Copyright (c) 2000-2021 John Willinsky
88
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
99
*
10-
* @class ValidatorDateConparison
10+
* @class ValidatorDateComparison
1111
*
1212
* @ingroup validation
1313
*
@@ -23,7 +23,7 @@
2323
use Exception;
2424
use PKP\validation\ValidatorFactory;
2525

26-
class ValidatorDateConparison extends Validator
26+
class ValidatorDateComparison extends Validator
2727
{
2828
public const DATE_COMPARE_RULE_EQUAL = 'equal';
2929
public const DATE_COMPARE_RULE_GREATER = 'greater';
@@ -93,5 +93,5 @@ protected function getValidationApplicableRule(string $rule): mixed
9393
}
9494

9595
if (!PKP_STRICT_MODE) {
96-
class_alias('\PKP\validation\ValidatorDateConparison', '\ValidatorDateConparison');
96+
class_alias('\PKP\validation\ValidatorDateComparison', '\ValidatorDateComparison');
9797
}

‎controllers/grid/users/reviewer/form/EditReviewForm.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function __construct(ReviewAssignment $reviewAssignment, Submission $subm
6868
$this,
6969
'reviewDueDate',
7070
\Carbon\Carbon::parse(Application::get()->getRequest()->getUserVar('responseDueDate')),
71-
\PKP\validation\ValidatorDateConparison::DATE_COMPARE_RULE_GREATER_OR_EQUAL,
71+
\PKP\validation\ValidatorDateComparison::DATE_COMPARE_RULE_GREATER_OR_EQUAL,
7272
'optional',
7373
'editor.review.errorAddingReviewer.dateValidationFailed'
7474
)

‎controllers/grid/users/reviewer/form/ReviewerForm.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ public function __construct($submission, $reviewRound)
7777
new \PKP\form\validation\FormValidatorDateCompare(
7878
$this,
7979
'reviewDueDate',
80-
\Carbon\Carbon::parse(Application::get()->getRequest()->getUserVar('responseDueDate')),
81-
\PKP\validation\ValidatorDateConparison::DATE_COMPARE_RULE_GREATER_OR_EQUAL,
80+
\Carbon\Carbon::parse($this->getData('responseDueDate')),
81+
\PKP\validation\ValidatorDateComparison::DATE_COMPARE_RULE_GREATER_OR_EQUAL,
8282
'optional',
8383
'editor.review.errorAddingReviewer.dateValidationFailed'
8484
)

jobs/email/ReviewRemainder.php renamed to jobs/email/ReviewReminder.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?php
22

33
/**
4-
* @file jobs/email/ReviewRemainder.php
4+
* @file jobs/email/ReviewReminder.php
55
*
66
* Copyright (c) 2014-2024 Simon Fraser University
77
* Copyright (c) 2000-2024 John Willinsky
88
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
99
*
10-
* @class ReviewRemainder
10+
* @class ReviewReminder
1111
*
1212
* @ingroup jobs
1313
*
14-
* @brief Class to handle a job to send an review remainder
14+
* @brief Class to handle a job to send an review reminder
1515
*/
1616

1717
namespace PKP\jobs\email;
@@ -28,7 +28,7 @@
2828
use PKP\jobs\BaseJob;
2929

3030

31-
class ReviewRemainder extends BaseJob
31+
class ReviewReminder extends BaseJob
3232
{
3333
protected int $reviewAssignmentId;
3434
protected int $submissionId;
@@ -59,7 +59,7 @@ public function handle(): void
5959

6060
$submission = Repo::submission()->get($this->submissionId);
6161

62-
$contextService = Services::get("context");
62+
$contextService = Services::get('context');
6363
$context = $contextService->get($this->contextId);
6464

6565
/** @var ReviewRemindAuto|ReviewResponseRemindAuto $mailable */

‎locale/en/common.po‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2117,6 +2117,9 @@ msgstr "This is not a valid currency."
21172117
msgid "validator.date"
21182118
msgstr "This is not a valid date."
21192119

2120+
msgid "validator.date.comparison"
2121+
msgstr "Invalid dates provided for comparison."
2122+
21202123
msgid "validator.date_format"
21212124
msgstr "This does not match the format {$format}."
21222125

0 commit comments

Comments
 (0)