Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
NotificationSubscriptionSettingsDAO Class Reference
Inheritance diagram for NotificationSubscriptionSettingsDAO:
DAO

Public Member Functions

 deleteNotificationSubscriptionSettings ($notificationId, $userId, $settingName=null)
 
getNotificationSubscriptionSettings ($settingName, $userId, $contextId)
 
 getRSSTokenByUserId ($userId, $contextId)
 
 getUserIdByRSSToken ($token, $contextId)
 
 insertNewRSSToken ($userId, $contextId)
 
 NotificationSubscriptionSettingsDAO ()
 
 updateNotificationSubscriptionSettings ($settingName, $settings, $userId, $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 ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 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

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying user's notification settings. This class stores user settings that determine how notifications should be delivered to them.

See Also
Notification

Definition at line 20 of file NotificationSubscriptionSettingsDAO.inc.php.

Member Function Documentation

NotificationSubscriptionSettingsDAO::deleteNotificationSubscriptionSettings (   $notificationId,
  $userId,
  $settingName = null 
)

Delete a notification setting by setting name

Parameters
$notificationIdint
$userIdint
$settingNamestring optional

Definition at line 34 of file NotificationSubscriptionSettingsDAO.inc.php.

References DAO\update().

& NotificationSubscriptionSettingsDAO::getNotificationSubscriptionSettings (   $settingName,
  $userId,
  $contextId 
)

Retrieve Notification subscription settings by user id

Parameters
$settingNamestring
$userIdint
$contextIdint
Returns
array

Definition at line 52 of file NotificationSubscriptionSettingsDAO.inc.php.

References DAO\retrieve().

NotificationSubscriptionSettingsDAO::getRSSTokenByUserId (   $userId,
  $contextId 
)

Gets an RSS token for a user id

Parameters
$userIdint
$contextIdint
Returns
int

Definition at line 127 of file NotificationSubscriptionSettingsDAO.inc.php.

References DAO\retrieve().

NotificationSubscriptionSettingsDAO::getUserIdByRSSToken (   $token,
  $contextId 
)

Gets a user id by an RSS token value

Parameters
$tokenint
$contextId
Returns
int

Definition at line 106 of file NotificationSubscriptionSettingsDAO.inc.php.

References DAO\retrieve().

Referenced by insertNewRSSToken().

NotificationSubscriptionSettingsDAO::insertNewRSSToken (   $userId,
  $contextId 
)

Generates and inserts a new token for a user's RSS feed

Parameters
$userIdint
$contextIdint
Returns
int

Definition at line 148 of file NotificationSubscriptionSettingsDAO.inc.php.

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

NotificationSubscriptionSettingsDAO::NotificationSubscriptionSettingsDAO ( )

Constructor.

Definition at line 24 of file NotificationSubscriptionSettingsDAO.inc.php.

NotificationSubscriptionSettingsDAO::updateNotificationSubscriptionSettings (   $settingName,
  $settings,
  $userId,
  $contextId 
)

Update a user's notification subscription settings

Parameters
$settingNamestring
$settingsarray
$userIdint
$contextIdint

Definition at line 78 of file NotificationSubscriptionSettingsDAO.inc.php.

References DAO\update().


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