Public Member Functions | |
| deleteNotificationSubscriptionSettings ($notificationId, $userId, $settingName=null) | |
| & | getNotificationSubscriptionSettings ($settingName, $userId, $contextId) |
| getRSSTokenByUserId ($userId, $contextId) | |
| getUserIdByRSSToken ($token, $contextId) | |
| insertNewRSSToken ($userId, $contextId) | |
| updateNotificationSubscriptionSettings ($settingName, $settings, $userId, $contextId) | |
 Public Member Functions inherited from DAO | |
| __construct ($dataSource=null, $callHooks=true) | |
| concat () | |
| convertFromDB ($value, $type) | |
| convertToDB ($value, &$type) | |
| dateFromDB ($d) | |
| datetimeFromDB ($dt) | |
| datetimeToDB ($dt) | |
| dateToDB ($d) | |
| flushCache () | |
| formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true) | |
| getAdditionalFieldNames () | |
| getAffectedRows () | |
| getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
| getDataSource () | |
| getDirectionMapping ($direction) | |
| getDriver () | |
| getLocaleFieldNames () | |
| getType ($value) | |
| handleError ($dataSource, $sql) | |
| nullOrInt ($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, $content='') |
| Data Fields inherited from DAO | |
| $_dataSource | |
| Protected Member Functions inherited from DAO | |
| _getInsertId ($table='', $id='') | |
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
◆ deleteNotificationSubscriptionSettings()
| NotificationSubscriptionSettingsDAO::deleteNotificationSubscriptionSettings | ( | $notificationId, | |
| $userId, | |||
$settingName = null |
|||
| ) |
Delete a notification setting by setting name
- Parameters
-
$notificationId int $userId int $settingName string optional
Definition at line 28 of file NotificationSubscriptionSettingsDAO.inc.php.
References DAO\update().
◆ getNotificationSubscriptionSettings()
| & NotificationSubscriptionSettingsDAO::getNotificationSubscriptionSettings | ( | $settingName, | |
| $userId, | |||
| $contextId | |||
| ) |
Retrieve Notification subscription settings by user id
- Parameters
-
$settingName string $userId int $contextId int
- Returns
- array
Definition at line 46 of file NotificationSubscriptionSettingsDAO.inc.php.
References DAO\retrieve().
◆ getRSSTokenByUserId()
| NotificationSubscriptionSettingsDAO::getRSSTokenByUserId | ( | $userId, | |
| $contextId | |||
| ) |
Gets an RSS token for a user id
- Parameters
-
$userId int $contextId int
- Returns
- int
Definition at line 117 of file NotificationSubscriptionSettingsDAO.inc.php.
References DAO\retrieve().
◆ getUserIdByRSSToken()
| NotificationSubscriptionSettingsDAO::getUserIdByRSSToken | ( | $token, | |
| $contextId | |||
| ) |
Gets a user id by an RSS token value
- Parameters
-
$token int $contextId
- Returns
- int
Definition at line 98 of file NotificationSubscriptionSettingsDAO.inc.php.
References DAO\retrieve().
Referenced by insertNewRSSToken().
◆ insertNewRSSToken()
| NotificationSubscriptionSettingsDAO::insertNewRSSToken | ( | $userId, | |
| $contextId | |||
| ) |
Generates and inserts a new token for a user's RSS feed
- Parameters
-
$userId int $contextId int
- Returns
- int
Definition at line 136 of file NotificationSubscriptionSettingsDAO.inc.php.
References getUserIdByRSSToken(), and DAO\update().
◆ updateNotificationSubscriptionSettings()
| NotificationSubscriptionSettingsDAO::updateNotificationSubscriptionSettings | ( | $settingName, | |
| $settings, | |||
| $userId, | |||
| $contextId | |||
| ) |
Update a user's notification subscription settings
- Parameters
-
$settingName string $settings array $userId int $contextId int
Definition at line 70 of file NotificationSubscriptionSettingsDAO.inc.php.
References DAO\update().
The documentation for this class was generated from the following file:
