Elgg
Version 1.9
|
Public Member Functions | |
__construct (Elgg_Database $db, array $methods=array()) | |
Constructor. More... | |
getSubscriptions (Elgg_Notifications_Event $event) | |
Get the subscriptions for this notification event. More... | |
getSubscriptionsForContainer ($container_guid) | |
Get the subscriptions for the content created inside this container. More... | |
addSubscription ($userGuid, $method, $targetGuid) | |
Subscribe a user to notifications about a target entity. More... | |
removeSubscription ($userGuid, $method, $targetGuid) | |
Unsubscribe a user to notifications about a target entity. More... | |
Public Attributes | |
const | RELATIONSHIP_PREFIX = 'notify' |
Elgg has historically stored subscriptions as relationships with the prefix 'notify'. More... | |
$methods | |
Protected Member Functions | |
getSubscriptionRecords ($container_guid) | |
Get subscription records from the database. More... | |
getMethodRelationships () | |
Get the relationship names for notifications. More... | |
Protected Attributes | |
$db | |
Definition at line 12 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::__construct | ( | Elgg_Database | $db, |
array | $methods = array() |
||
) |
Constructor.
Elgg_Database | $db | Database object |
array | $methods | Notification delivery method names |
Definition at line 34 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::addSubscription | ( | $userGuid, | |
$method, | |||
$targetGuid | |||
) |
Subscribe a user to notifications about a target entity.
This method will return false if the subscription already exists.
int | $userGuid | The GUID of the user to subscribe to notifications |
string | $method | The delivery method of the notifications |
int | $targetGuid | The entity to receive notifications about |
Definition at line 115 of file SubscriptionsService.php.
|
protected |
Get the relationship names for notifications.
Definition at line 170 of file SubscriptionsService.php.
|
protected |
Get subscription records from the database.
Records are an object with two vars: guid and methods with the latter being a comma-separated list of subscription relationship names.
int | $container_guid | The GUID of the subscription target |
Definition at line 145 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::getSubscriptions | ( | Elgg_Notifications_Event | $event | ) |
Get the subscriptions for this notification event.
The return array is of the form:
array( <user guid>=""> => array('email', 'sms', 'ajax'), );
Elgg_Notifications_Event | $event | Notification event |
Definition at line 51 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::getSubscriptionsForContainer | ( | $container_guid | ) |
Get the subscriptions for the content created inside this container.
The return array is of the form:
array( <user guid>=""> => array('email', 'sms', 'ajax'), );
int | $container_guid | GUID of the entity acting as a container |
Definition at line 87 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::removeSubscription | ( | $userGuid, | |
$method, | |||
$targetGuid | |||
) |
Unsubscribe a user to notifications about a target entity.
int | $userGuid | The GUID of the user to unsubscribe to notifications |
string | $method | The delivery method of the notifications to stop |
int | $targetGuid | The entity to stop receiving notifications about |
Definition at line 131 of file SubscriptionsService.php.
|
protected |
Definition at line 26 of file SubscriptionsService.php.
Elgg_Notifications_SubscriptionsService::$methods |
Definition at line 23 of file SubscriptionsService.php.
const Elgg_Notifications_SubscriptionsService::RELATIONSHIP_PREFIX = 'notify' |
Elgg has historically stored subscriptions as relationships with the prefix 'notify'.
Definition at line 17 of file SubscriptionsService.php.