Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
EmailHandler Class Reference
Inheritance diagram for EmailHandler:
UserHandler ManagerHandler Handler Handler PKPHandler PKPHandler

Public Member Functions

 createEmail ($args, &$request)
 
 deleteCustomEmail ($args)
 
 disableEmail ($args)
 
 editEmail ($args, &$request)
 
 email ($args, &$request)
 
 EmailHandler ()
 
 EmailHandler ()
 
 emails ()
 
 enableEmail ($args)
 
 resetAllEmails ()
 
 resetEmail ($args)
 
 updateEmail ()
 
- Public Member Functions inherited from UserHandler
 _checkIncompleteSetup ($journal)
 
 _getRoleDataForJournal ($userId, $journalId, &$submissionsCount, &$isValid)
 
 authorizationDenied ($args, &$request)
 
 become ($args, &$request)
 
 completePurchaseSubscription ($args, &$request)
 
 gifts ($args, $request)
 
 index ($args, &$request)
 
 payMembership ($args, &$request)
 
 payPurchaseSubscription ($args, &$request)
 
 payRenewSubscription ($args, &$request)
 
 purchaseSubscription ($args, &$request)
 
 redeemGift ($args, $request)
 
 setLocale ($args, $request)
 
 setupTemplate (&$request, $subclass=false)
 
 subscriptions ($args, &$request)
 
 UserHandler ()
 
 validate ($loginCheck=true)
 
 viewPublicProfile ($args, &$request)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 
- Public Member Functions inherited from ManagerHandler
 email ($args)
 
 index ()
 
 ManagerHandler ()
 
retrieveRoleAssignmentPreferences ($journalId)
 
 setupTemplate ($subclass=false)
 

Detailed Description

Handle requests for email management functions.

Handle requests for user emails.

Definition at line 18 of file manager/EmailHandler.inc.php.

Member Function Documentation

EmailHandler::createEmail (   $args,
$request 
)

Create an empty email template.

Parameters
$argsarray
$requestPKPRequest

Definition at line 54 of file manager/EmailHandler.inc.php.

References editEmail().

EmailHandler::deleteCustomEmail (   $args)

Delete a custom email.

Parameters
$argsarray first parameter is the key of the email to delete

Definition at line 108 of file manager/EmailHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and UserHandler\validate().

EmailHandler::disableEmail (   $args)

disables an email template.

Parameters
$argsarray first parameter is the key of the email to disable

Definition at line 155 of file manager/EmailHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and UserHandler\validate().

EmailHandler::editEmail (   $args,
$request 
)

Display form to create/edit an email.

Parameters
$argsarray if set the first parameter is the key of the email template to edit
$requestPKPRequest

Definition at line 63 of file manager/EmailHandler.inc.php.

References UserHandler\setupTemplate(), and UserHandler\validate().

Referenced by createEmail().

EmailHandler::email (   $args,
$request 
)
EmailHandler::EmailHandler ( )

Constructor

Definition at line 22 of file user/EmailHandler.inc.php.

EmailHandler::EmailHandler ( )

Constructor

Definition at line 22 of file manager/EmailHandler.inc.php.

EmailHandler::emails ( )
EmailHandler::enableEmail (   $args)

enables an email template.

Parameters
$argsarray first parameter is the key of the email to enable

Definition at line 189 of file manager/EmailHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and UserHandler\validate().

EmailHandler::resetAllEmails ( )

resets all email templates associated with the journal.

Definition at line 141 of file manager/EmailHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and UserHandler\validate().

EmailHandler::resetEmail (   $args)

Reset an email to default.

Parameters
$argsarray first parameter is the key of the email to reset

Definition at line 125 of file manager/EmailHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and UserHandler\validate().

EmailHandler::updateEmail ( )

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