Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NotificationMailListDAO Class Reference
Inheritance diagram for NotificationMailListDAO:
DAO

Public Member Functions

 confirmMailListSubscription ($notificationMailListId)
 
 getInsertId ()
 
 getMailList ($contextId)
 
 getMailListIdByToken ($token, $contextId)
 
 NotificationMailListDAO ()
 
 subscribeGuest ($email, $contextId)
 
 unsubscribeGuest ($token, $contextId)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null)
 
- Public Attributes inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table= '', $id= '')
 

Detailed Description

Operations for getting and setting subscriptions to the non-user notification mailing list.

See Also
Notification

Definition at line 17 of file NotificationMailListDAO.inc.php.

Member Function Documentation

NotificationMailListDAO::confirmMailListSubscription (   $notificationMailListId)

Confirm the mailing list subscription

Parameters
$notificationMailListIdint
Returns
boolean

Definition at line 103 of file NotificationMailListDAO.inc.php.

References DAO\update().

NotificationMailListDAO::getInsertId ( )

Get the ID of the last inserted notification

Returns
int

Definition at line 136 of file NotificationMailListDAO.inc.php.

References DAO\_getInsertId().

NotificationMailListDAO::getMailList (   $contextId)

Gets a list of email addresses of users subscribed to the mailing list

Parameters
$contextIdint Context (journal/conference/press) ID
Returns
array

Definition at line 115 of file NotificationMailListDAO.inc.php.

References DAO\retrieve().

NotificationMailListDAO::getMailListIdByToken (   $token,
  $contextId 
)

Gets a mailing list subscription id by a token value

Parameters
$tokenint
$contextIdint Context (journal/conference/press) ID
Returns
int

Definition at line 68 of file NotificationMailListDAO.inc.php.

References DAO\retrieve().

Referenced by subscribeGuest(), and unsubscribeGuest().

NotificationMailListDAO::NotificationMailListDAO ( )

Constructor.

Definition at line 21 of file NotificationMailListDAO.inc.php.

NotificationMailListDAO::subscribeGuest (   $email,
  $contextId 
)

Generates an access key for the guest user and adds them to the notification_mail_list table

Parameters
$emailstring
$contextIdint Context (journal/conference/press) ID
Returns
string

Definition at line 31 of file NotificationMailListDAO.inc.php.

References getMailListIdByToken(), DAO\retrieve(), and DAO\update().

NotificationMailListDAO::unsubscribeGuest (   $token,
  $contextId 
)

Removes an email address from email notifications

Parameters
$tokenstring
$contextIdint Context (journal/conference/press) ID
Returns
boolean

Definition at line 87 of file NotificationMailListDAO.inc.php.

References getMailListIdByToken(), and DAO\update().


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