Subscription service. More...

Public Member Functions
	__construct (protected Database $db, protected RelationshipsTable $relationshipsTable, protected EventsService $events)
	Constructor. More...

	getNotificationEventSubscriptions (NotificationEvent $event, array $methods, array $exclude_guids_for_records=[])
	Get the subscriptions for this notification event. More...

	getSubscriptionsForContainer (int $container_guid, array $methods, ?string $type=null, ?string $subtype=null, ?string $action=null, int $actor_guid=0)
	Get the subscriptions for the content created inside this container. More...

	addSubscription (int $user_guid, string $method, int $target_guid, ?string $type=null, ?string $subtype=null, ?string $action=null)
	Subscribe a user to notifications about a target entity. More...

	hasSubscription (int $user_guid, string $method, int $target_guid, ?string $type=null, ?string $subtype=null, ?string $action=null)
	Check if a subscription exists. More...

	hasSubscriptions (int $user_guid, int $target_guid, array $methods=[])
	Check if any subscription exists. More...

	removeSubscription (int $user_guid, string $method, int $target_guid, ?string $type=null, ?string $subtype=null, ?string $action=null)
	Unsubscribe a user to notifications about a target entity. More...

	removeSubscriptions (int $user_guid, int $target_guid, array $methods=[])
	Unsubscribe a user from all notifications about the target entity. More...

	getSubscribers (int $target_guid, array $methods=[])
	Get all subscribers of the target guid. More...

	getEntitySubscriptions (int $target_guid=0, int $user_guid=0, array $methods=[], ?string $type=null, ?string $subtype=null, ?string $action=null)
	Get the current subscriptions for the given entity. More...

	muteNotifications (int $user_guid, int $target_guid)
	Mute notifications about events affecting the target. More...

	unmuteNotifications (int $user_guid, int $target_guid)
	No longer nute notifications about events affecting the target. More...

	hasMutedNotifications (int $user_guid, int $target_guid)
	Check if the user has notifications muted about events affecting the target. More...

	filterSubscriptions (array $subscriptions, NotificationEvent $event, bool $filter_muted=true)
	Apply filtering to subscriptions, like muted notifications etc. More...

Public Attributes
const	RELATIONSHIP_PREFIX = 'notify'

const	MUTE_NOTIFICATIONS_RELATIONSHIP = 'mute_notifications'

Protected Member Functions
	filterMutedNotifications (array $subscriptions, NotificationEvent $event)
	Filter subscriptions based on muted notification settings related to the notification event. More...

	filterDelayedEmailSubscribers (array $subscriptions)
	When a user has both 'email' and 'delayed_email' subscription remove the delayed email as it would be a duplicate. More...

	filterTimedMutedSubscribers (array $subscriptions)
	Filter users who have set a period in which not to receive notifications. More...

	getSubscriptionRecords (array $container_guid, array $methods, ?string $type=null, ?string $subtype=null, ?string $action=null, int $actor_guid=0)
	Get subscription records from the database. More...

	getMethodRelationships (array $methods, ?string $type=null, ?string $subtype=null, ?string $action=null)
	Get the relationship names for notifications. More...

	assertValidTypeSubtypeActionForSubscription ($type, $subtype, $action)
	Validate subscription input for type, subtype and action. More...

Detailed Description

Subscription service.

Definition at line 20 of file SubscriptionsService.php.

Constructor & Destructor Documentation

◆ __construct()

Elgg\Notifications\SubscriptionsService::__construct	(	protected Database	$db,
		protected RelationshipsTable	$relationshipsTable,
		protected EventsService	$events
	)

Constructor.

Parameters

Database	$db	Database service
RelationshipsTable	$relationshipsTable	Relationship database table
EventsService	$events	Events service

Definition at line 39 of file SubscriptionsService.php.

Member Function Documentation

◆ addSubscription()

Elgg\Notifications\SubscriptionsService::addSubscription	(	int	$user_guid,
		string	$method,
		int	$target_guid,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`
	)

Subscribe a user to notifications about a target entity.

This method will return false if the subscription already exists.

Parameters

int	$user_guid	The GUID of the user to subscribe to notifications
string	$method	The delivery method of the notifications
int	$target_guid	The entity to receive notifications about
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')

Returns: bool

Exceptions

InvalidArgumentException

Definition at line 176 of file SubscriptionsService.php.

◆ assertValidTypeSubtypeActionForSubscription()

Elgg\Notifications\SubscriptionsService::assertValidTypeSubtypeActionForSubscription	(	$type,
		$subtype,
		$action
	)

protected

Validate subscription input for type, subtype and action.

Parameters

string	$type	entity type
string	$subtype	entity subtype
string	$action	notification action (eg. 'create')

Returns: void

Exceptions

InvalidArgumentException

Definition at line 701 of file SubscriptionsService.php.

◆ filterDelayedEmailSubscribers()

Elgg\Notifications\SubscriptionsService::filterDelayedEmailSubscribers ( array $subscriptions )

protected

When a user has both 'email' and 'delayed_email' subscription remove the delayed email as it would be a duplicate.

Parameters

array $subscriptions List of subscribers to filter

Returns: array

Definition at line 580 of file SubscriptionsService.php.

◆ filterMutedNotifications()

Elgg\Notifications\SubscriptionsService::filterMutedNotifications	(	array	$subscriptions,
		NotificationEvent	$event
	)

protected

Filter subscriptions based on muted notification settings related to the notification event.

This filters out muted notifications based on:

Event actor
Event entity
Event entity owner
Event entity container

Parameters

array	$subscriptions	List of subscribers to filter
NotificationEvent	$event	Notification event from which to get information

Returns: array

Definition at line 532 of file SubscriptionsService.php.

◆ filterSubscriptions()

Elgg\Notifications\SubscriptionsService::filterSubscriptions	(	array	$subscriptions,
		NotificationEvent	$event,
		bool	$filter_muted = `true`
	)

Apply filtering to subscriptions, like muted notifications etc.

Parameters

array	$subscriptions	List of subscribers to filter
NotificationEvent	$event	Notification event from which to get information
bool	$filter_muted	Should the muting rules be applied to the subscriptions (default: true)

Returns: array

Definition at line 501 of file SubscriptionsService.php.

◆ filterTimedMutedSubscribers()

Elgg\Notifications\SubscriptionsService::filterTimedMutedSubscribers ( array $subscriptions )

protected

Filter users who have set a period in which not to receive notifications.

Parameters

array $subscriptions List of subscribers to filter

Returns: array

Definition at line 600 of file SubscriptionsService.php.

◆ getEntitySubscriptions()

Elgg\Notifications\SubscriptionsService::getEntitySubscriptions	(	int	$target_guid = `0`,
		int	$user_guid = `0`,
		array	$methods = `[]`,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`
	)

Get the current subscriptions for the given entity.

Parameters

int	$target_guid	The GUID of the entity to get subscriptions for
int	$user_guid	The GUID of the user to check subscriptions for
array	$methods	The delivery method of the notifications
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')

Returns: \ElggRelationship[]

Exceptions

InvalidArgumentException

Definition at line 392 of file SubscriptionsService.php.

◆ getMethodRelationships()

Elgg\Notifications\SubscriptionsService::getMethodRelationships	(	array	$methods,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`
	)

protected

Get the relationship names for notifications.

Parameters

array	$methods	Notification methods
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')

Returns: array

Definition at line 676 of file SubscriptionsService.php.

◆ getNotificationEventSubscriptions()

Elgg\Notifications\SubscriptionsService::getNotificationEventSubscriptions	(	NotificationEvent	$event,
		array	$methods,
		array	$exclude_guids_for_records = `[]`
	)

Get the subscriptions for this notification event.

The return array is of the form:

array( <user guid> => array('email', 'sms', 'ajax'), );

Parameters

NotificationEvent	$event	Notification event
array	$methods	Notification methods
array	$exclude_guids_for_records	GUIDs to exclude from fetching subscription records

Returns: array

Definition at line 61 of file SubscriptionsService.php.

◆ getSubscribers()

Elgg\Notifications\SubscriptionsService::getSubscribers	(	int	$target_guid,
		array	$methods = `[]`
	)

Get all subscribers of the target guid.

Parameters

int	$target_guid	the entity of the subscriptions
array	$methods	(optional) The delivery method of the notifications

Returns: \ElggEntity[]

Definition at line 351 of file SubscriptionsService.php.

◆ getSubscriptionRecords()

Elgg\Notifications\SubscriptionsService::getSubscriptionRecords	(	array	$container_guid,
		array	$methods,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`,
		int	$actor_guid = `0`
	)

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.

Parameters

int[]	$container_guid	The GUID of the subscription target
array	$methods	Notification methods
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')
int	$actor_guid	(optional) Notification event actor to exclude from the database subscriptions

Returns: array

Definition at line 640 of file SubscriptionsService.php.

◆ getSubscriptionsForContainer()

Elgg\Notifications\SubscriptionsService::getSubscriptionsForContainer	(	int	$container_guid,
		array	$methods,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`,
		int	$actor_guid = `0`
	)

Get the subscriptions for the content created inside this container.

The return array is of the form:

array( <user guid> => array('email', 'sms', 'ajax'), );

Parameters

int	$container_guid	GUID of the entity acting as a container
array	$methods	Notification methods
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')
int	$actor_guid	(optional) Notification event actor to exclude from the database subscriptions

Returns: array User GUIDs (keys) and their subscription types (values).

Definition at line 131 of file SubscriptionsService.php.

◆ hasMutedNotifications()

Elgg\Notifications\SubscriptionsService::hasMutedNotifications	(	int	$user_guid,
		int	$target_guid
	)

Check if the user has notifications muted about events affecting the target.

Parameters

int	$user_guid	The GUID of the user to check muted notifcations for
int	$target_guid	The GUID of the entity to for which to check muted notifications

Returns: bool

Definition at line 488 of file SubscriptionsService.php.

◆ hasSubscription()

Elgg\Notifications\SubscriptionsService::hasSubscription	(	int	$user_guid,
		string	$method,
		int	$target_guid,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`
	)

Check if a subscription exists.

Parameters

int	$user_guid	The GUID of the user to check subscriptions for
string	$method	The delivery method of the notifications
int	$target_guid	The entity to receive notifications about
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')

Returns: bool

Exceptions

InvalidArgumentException

Since: 4.0

Definition at line 220 of file SubscriptionsService.php.

◆ hasSubscriptions()

Elgg\Notifications\SubscriptionsService::hasSubscriptions	(	int	$user_guid,
		int	$target_guid,
		array	$methods = `[]`
	)

Check if any subscription exists.

Parameters

int	$user_guid	The GUID of the user to check subscriptions for
int	$target_guid	The entity to receive notifications about
array	$methods	The delivery method of the notifications

Returns: bool

Since: 4.0

Definition at line 248 of file SubscriptionsService.php.

◆ muteNotifications()

Elgg\Notifications\SubscriptionsService::muteNotifications	(	int	$user_guid,
		int	$target_guid
	)

Mute notifications about events affecting the target.

Parameters

int	$user_guid	The GUID of the user to mute notifications for
int	$target_guid	The GUID of the entity to for which to mute notifications

Returns: bool

Definition at line 456 of file SubscriptionsService.php.

◆ removeSubscription()

Elgg\Notifications\SubscriptionsService::removeSubscription	(	int	$user_guid,
		string	$method,
		int	$target_guid,
		?string	$type = `null`,
		?string	$subtype = `null`,
		?string	$action = `null`
	)

Unsubscribe a user to notifications about a target entity.

Parameters

int	$user_guid	The GUID of the user to unsubscribe to notifications
string	$method	The delivery method of the notifications to stop
int	$target_guid	The entity to stop receiving notifications about
null \| string	$type	(optional) entity type
null \| string	$subtype	(optional) entity subtype
null \| string	$action	(optional) notification action (eg. 'create')

Returns: bool

Exceptions

InvalidArgumentException

Definition at line 290 of file SubscriptionsService.php.

◆ removeSubscriptions()

Elgg\Notifications\SubscriptionsService::removeSubscriptions	(	int	$user_guid,
		int	$target_guid,
		array	$methods = `[]`
	)

Unsubscribe a user from all notifications about the target entity.

Parameters

int	$user_guid	The GUID of the user to unsubscribe to notifications
int	$target_guid	The entity to stop receiving notifications about
array	$methods	(optional) The delivery method of the notifications to stop

Returns: bool

Since: 4.0

Definition at line 323 of file SubscriptionsService.php.

◆ unmuteNotifications()

Elgg\Notifications\SubscriptionsService::unmuteNotifications	(	int	$user_guid,
		int	$target_guid
	)

No longer nute notifications about events affecting the target.

Parameters

int	$user_guid	The GUID of the user to unmute notifcations for
int	$target_guid	The GUID of the entity to for which to unmute notifications

Returns: bool

Definition at line 476 of file SubscriptionsService.php.

Member Data Documentation

◆ MUTE_NOTIFICATIONS_RELATIONSHIP

const Elgg\Notifications\SubscriptionsService::MUTE_NOTIFICATIONS_RELATIONSHIP = 'mute_notifications'

Definition at line 30 of file SubscriptionsService.php.

◆ RELATIONSHIP_PREFIX

const Elgg\Notifications\SubscriptionsService::RELATIONSHIP_PREFIX = 'notify'

Definition at line 25 of file SubscriptionsService.php.

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

engine/classes/Elgg/Notifications/SubscriptionsService.php

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSubscription()

◆ assertValidTypeSubtypeActionForSubscription()

◆ filterDelayedEmailSubscribers()

◆ filterMutedNotifications()

◆ filterSubscriptions()

◆ filterTimedMutedSubscribers()

◆ getEntitySubscriptions()

◆ getMethodRelationships()

◆ getNotificationEventSubscriptions()

◆ getSubscribers()

◆ getSubscriptionRecords()

◆ getSubscriptionsForContainer()

◆ hasMutedNotifications()

◆ hasSubscription()

◆ hasSubscriptions()

◆ muteNotifications()

◆ removeSubscription()

◆ removeSubscriptions()

◆ unmuteNotifications()

Member Data Documentation

◆ MUTE_NOTIFICATIONS_RELATIONSHIP

◆ RELATIONSHIP_PREFIX