Open Journal Systems  3.3.0
SubscriptionExpiryReminder Class Reference
Inheritance diagram for SubscriptionExpiryReminder:
ScheduledTask

Public Member Functions

 getName ()
 
- Public Member Functions inherited from ScheduledTask
 __construct ($args=array())
 
 addExecutionLogEntry ($message, $type=null)
 
 execute ()
 
 getHelper ()
 
 getProcessId ()
 

Protected Member Functions

 executeActions ()
 
 sendJournalReminders ($journal, $curDate)
 
 sendReminder ($subscription, $journal, $emailKey)
 

Detailed Description

Class to perform automated reminders for reviewers.

Definition at line 18 of file SubscriptionExpiryReminder.inc.php.

Member Function Documentation

◆ executeActions()

SubscriptionExpiryReminder::executeActions ( )
protected

Implement this method to execute the task actions.

Returns
boolean true iff success

Reimplemented from ScheduledTask.

Definition at line 218 of file SubscriptionExpiryReminder.inc.php.

References DAORegistry\getDAO(), and sendJournalReminders().

◆ getName()

SubscriptionExpiryReminder::getName ( )

Get the scheduled task name. Override to define a custom task name.

Returns
string

Reimplemented from ScheduledTask.

Definition at line 23 of file SubscriptionExpiryReminder.inc.php.

◆ sendJournalReminders()

SubscriptionExpiryReminder::sendJournalReminders (   $journal,
  $curDate 
)
protected

Send a journal's subscription expiry reminders.

Parameters
$journalJournal
$curDatearray The current date

Definition at line 86 of file SubscriptionExpiryReminder.inc.php.

References DAORegistry\getDAO(), and sendReminder().

Referenced by executeActions().

◆ sendReminder()

SubscriptionExpiryReminder::sendReminder (   $subscription,
  $journal,
  $emailKey 
)
protected

Send a particular subscription expiry reminder.

Parameters
$subscriptionSubscription
$journalJournal
$emailKeystring Email template key

Definition at line 33 of file SubscriptionExpiryReminder.inc.php.

References DAORegistry\getDAO(), and AppLocale\requireComponents().

Referenced by sendJournalReminders().


The documentation for this class was generated from the following file: